]>
Commit | Line | Data |
---|---|---|
ef416fc2 | 1 | .\" |
e4e5666b | 2 | .\" "$Id$" |
ef416fc2 | 3 | .\" |
cfa19b58 | 4 | .\" lpadmin man page for CUPS. |
ef416fc2 | 5 | .\" |
fffed089 | 6 | .\" Copyright 2007-2015 by Apple Inc. |
cfa19b58 | 7 | .\" Copyright 1997-2006 by Easy Software Products. |
ef416fc2 | 8 | .\" |
cfa19b58 MS |
9 | .\" These coded instructions, statements, and computer programs are the |
10 | .\" property of Apple Inc. and are protected by Federal copyright | |
11 | .\" law. Distribution and use rights are outlined in the file "LICENSE.txt" | |
12 | .\" which should have been included with this file. If this file is | |
13 | .\" file is missing or damaged, see the license at "http://www.cups.org/". | |
ef416fc2 | 14 | .\" |
fffed089 | 15 | .TH lpadmin 8 "CUPS" "11 February 2015" "Apple Inc." |
ef416fc2 | 16 | .SH NAME |
17 | lpadmin \- configure cups printers and classes | |
18 | .SH SYNOPSIS | |
19 | .B lpadmin | |
cfa19b58 MS |
20 | [ |
21 | .B \-E | |
22 | ] [ | |
23 | .B \-U | |
bd7854cb | 24 | .I username |
cfa19b58 MS |
25 | ] [ |
26 | \fB\-h \fIserver\fR[\fB:\fIport\fR] | |
27 | ] | |
28 | .B \-d | |
ef416fc2 | 29 | .I destination |
30 | .br | |
31 | .B lpadmin | |
cfa19b58 MS |
32 | [ |
33 | .B \-E | |
34 | ] [ | |
35 | .B \-U | |
bd7854cb | 36 | .I username |
cfa19b58 MS |
37 | ] [ |
38 | \fB\-h \fIserver\fR[\fB:\fIport\fR] | |
39 | ] | |
40 | .B \-p | |
eac3a0a0 | 41 | .I destination |
cfa19b58 MS |
42 | [ |
43 | .B \-R | |
eac3a0a0 MS |
44 | .I name-default |
45 | ] | |
46 | .I option(s) | |
ef416fc2 | 47 | .br |
48 | .B lpadmin | |
cfa19b58 MS |
49 | [ |
50 | .B \-E | |
51 | ] [ | |
52 | .B \-U | |
bd7854cb | 53 | .I username |
cfa19b58 MS |
54 | ] [ |
55 | \fB\-h \fIserver\fR[\fB:\fIport\fR] | |
56 | ] | |
57 | .B \-x | |
ef416fc2 | 58 | .I destination |
59 | .SH DESCRIPTION | |
cfa19b58 MS |
60 | \fBlpadmin\fR configures printer and class queues provided by CUPS. |
61 | It can also be used to set the server default printer or class. | |
ef416fc2 | 62 | .LP |
cfa19b58 | 63 | When specified before the \fI-d\fR, \fI-p\fR, or \fI-x\fR options, the \fI-E\fR option forces encryption when connecting to the server. |
ef416fc2 | 64 | .LP |
cfa19b58 MS |
65 | The first form of the command (\fI-d\fR) sets the default printer or class to \fIdestination\fR. |
66 | Subsequent print jobs submitted via the | |
67 | .BR lp (1) | |
68 | or | |
69 | .BR lpr (1) | |
70 | commands will use this destination unless the user specifies otherwise with the | |
71 | .BR lpoptions (1) | |
72 | command. | |
ef416fc2 | 73 | .LP |
cfa19b58 | 74 | The second form of the command (\fI-p\fR) configures the named printer or class. The additional options are described below. |
ef416fc2 | 75 | .LP |
cfa19b58 MS |
76 | The third form of the command (\fI-x\fR) deletes the printer or class \fIdestination\fR. |
77 | Any jobs that are pending for the destination will be removed and any job that is currently printed will be aborted. | |
78 | .SH OPTIONS | |
79 | The following options are recognized when configuring a printer queue: | |
ef416fc2 | 80 | .TP 5 |
cfa19b58 MS |
81 | \fB\-c \fIclass\fR |
82 | Adds the named \fIprinter\fR to \fIclass\fR. | |
83 | If \fIclass\fR does not exist it is created automatically. | |
ef416fc2 | 84 | .TP 5 |
cfa19b58 MS |
85 | \fB\-i \fIinterface\fR |
86 | Sets a System V style interface script for the printer. | |
87 | This option cannot be specified with the \fI-P\fR option (PPD file) and is intended for providing support for legacy printer drivers. | |
ef416fc2 | 88 | .TP 5 |
cfa19b58 MS |
89 | \fB\-m \fImodel\fR |
90 | Sets a standard System V interface script or PPD file for the printer from the \fImodel\fR directory or using one of the driver interfaces. | |
91 | Use the \fI-m\fR option with the | |
92 | .BR lpinfo (8) | |
93 | command to get a list of supported models. | |
fffed089 | 94 | The model "raw" clears any existing interface script or PPD file and the model "everywhere" queries the printer referred to by the specified IPP \fIdevice-uri\fR. |
eac3a0a0 | 95 | .TP 5 |
cfa19b58 MS |
96 | \fB\-o cupsIPPSupplies=true\fR |
97 | .TP 5 | |
98 | \fB\-o cupsIPPSupplies=false\fR | |
eac3a0a0 MS |
99 | Specifies whether IPP supply level values should be reported. |
100 | .TP 5 | |
cfa19b58 | 101 | \fB\-o cupsSNMPSupplies=true\fR |
eac3a0a0 | 102 | .TP 5 |
cfa19b58 | 103 | \fB\-o cupsSNMPSupplies=false\fR |
eac3a0a0 MS |
104 | Specifies whether SNMP supply level (RFC 3805) values should be reported. |
105 | .TP 5 | |
cfa19b58 MS |
106 | \fB\-o job\-k\-limit=\fIvalue\fR |
107 | Sets the kilobyte limit for per-user quotas. | |
108 | The value is an integer number of kilobytes; one kilobyte is 1024 bytes. | |
ef416fc2 | 109 | .TP 5 |
cfa19b58 MS |
110 | \fB\-o job\-page\-limit=\fIvalue\fR |
111 | Sets the page limit for per-user quotas. | |
112 | The value is the integer number of pages that can be printed; double-sided pages are counted as two pages. | |
ef416fc2 | 113 | .TP 5 |
cfa19b58 MS |
114 | \fB-o job\-quota\-period=\fIvalue\fR |
115 | Sets the accounting period for per-user quotas. | |
116 | The value is an integer number of seconds; 86,400 seconds are in one day. | |
ef416fc2 | 117 | .TP 5 |
cfa19b58 | 118 | \fB\-o job\-sheets\-default=\fIbanner\fR |
bd7854cb | 119 | .TP 5 |
cfa19b58 | 120 | \fB\-o job\-sheets\-default=\fIbanner\fB,\fIbanner\fR |
bd7854cb | 121 | Sets the default banner page(s) to use for print jobs. |
122 | .TP 5 | |
cfa19b58 MS |
123 | \fB\-o \fIname\fB=\fIvalue\fR |
124 | Sets a PPD option for the printer. | |
125 | PPD options can be listed using the \fI-l\fR option with the | |
126 | .BR lpoptions (1) | |
127 | command. | |
128 | .TP 5 | |
129 | \fB\-o \fIname\fB-default=\fIvalue\fR | |
130 | Sets a default server-side option for the destination. | |
131 | Any print-time option can be defaulted, e.g., "-o number-up-default=2" to set the default "number-up" option value to 2. | |
132 | .TP 5 | |
133 | \fB\-o port\-monitor=\fIname\fR | |
134 | Sets the binary communications program to use when printing, "none", "bcp", or "tbcp". | |
135 | The default program is "none". | |
136 | The specified port monitor must be listed in the printer's PPD file. | |
137 | .TP 5 | |
138 | \fB\-o printer-error-policy=\fIname\fR | |
139 | Sets the error policy to be used when the printer backend is unable to send the job to the printer. | |
140 | The name must be one of "abort-job", "retry-job", "retry-current-job", or "stop-printer". | |
141 | The default error policy is "stop-printer" for printers and "retry-current-job" for | |
7cf5915e | 142 | classes. |
8ca02f3c | 143 | .TP 5 |
cfa19b58 MS |
144 | \fB\-o printer\-is\-shared=true\fR |
145 | .TP 5 | |
146 | \fB\-o printer\-is\-shared=false\fR | |
7cf5915e | 147 | Sets the destination to shared/published or unshared/unpublished. |
cfa19b58 MS |
148 | Shared/published destinations are publicly announced by the server on the LAN based on the browsing configuration in \fIcupsd.conf\fR, while unshared/unpublished destinations are not announced. |
149 | The default value is "true". | |
8ca02f3c | 150 | .TP 5 |
cfa19b58 MS |
151 | \fB\-o printer-op-policy=\fIname\fR |
152 | Sets the IPP operation policy associated with the destination. | |
153 | The name must be defined in the \fIcupsd.conf\fR in a Policy section. | |
8ca02f3c | 154 | The default operation policy is "default". |
155 | .TP 5 | |
cfa19b58 | 156 | \fB\-R \fIname\fB\-default\fR |
eac3a0a0 MS |
157 | Deletes the named option from \fIprinter\fR. |
158 | .TP 5 | |
cfa19b58 MS |
159 | \fB\-r \fIclass\fR |
160 | Removes the named \fIprinter\fR from \fIclass\fR. | |
161 | If the resulting class becomes empty it is removed. | |
ef416fc2 | 162 | .TP 5 |
cfa19b58 | 163 | \fB-u allow:\fR{\fIuser\fR|\fB@\fIgroup\fR}{\fB,\fIuser\fR|\fB,@\fIgroup\fR}* |
80ca4592 | 164 | .TP 5 |
cfa19b58 | 165 | \fB-u deny:\fR{\fIuser\fR|\fB@\fIgroup\fR}{\fB,\fIuser\fR|\fB,@\fIgroup\fR}* |
80ca4592 | 166 | .TP 5 |
cfa19b58 | 167 | \fB\-u allow:all\fR |
80ca4592 | 168 | .TP 5 |
cfa19b58 MS |
169 | \fB\-u deny:none\fR |
170 | Sets user-level access control on a destination. | |
171 | Names starting with "@" are interpreted as UNIX groups. | |
172 | The latter two forms turn user-level access control off. | |
ef416fc2 | 173 | .TP 5 |
cfa19b58 MS |
174 | \fB\-v "\fIdevice-uri\fB"\fR |
175 | Sets the \fIdevice-uri\fR attribute of the printer queue. | |
176 | Use the \fI-v\fR option with the | |
177 | .BR lpinfo (8) | |
178 | command to get a list of supported device URIs and schemes. | |
ef416fc2 | 179 | .TP 5 |
cfa19b58 | 180 | \fB\-D "\fIinfo\fB"\fR |
7cf5915e | 181 | Provides a textual description of the destination. |
ef416fc2 | 182 | .TP 5 |
cfa19b58 | 183 | .B \-E |
7cf5915e | 184 | Enables the destination and accepts jobs; this is the same as running the |
cfa19b58 MS |
185 | .BR cupsaccept (8) |
186 | and | |
187 | .BR cupsenable (8) | |
188 | programs on the destination. | |
ef416fc2 | 189 | .TP 5 |
cfa19b58 | 190 | \fB\-L "\fIlocation\fB"\fR |
7cf5915e | 191 | Provides a textual location of the destination. |
ef416fc2 | 192 | .TP 5 |
cfa19b58 MS |
193 | \fB\-P \fIppd-file\fR |
194 | Specifies a PostScript Printer Description file to use with the printer. | |
195 | If specified, this option overrides the \fI-i\fR option (interface script). | |
196 | .SH CONFORMING TO | |
197 | Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", or "#". | |
bd7854cb | 198 | Also, printer and class names are \fInot\fR case-sensitive. |
cfa19b58 MS |
199 | Finally, the CUPS version of \fBlpadmin\fR may ask the user for an access password depending on the printing system configuration. |
200 | This differs from the System V version which requires the root user to execute this command. | |
201 | .SH NOTES | |
202 | The CUPS version of \fBlpadmin\fR does not support all of the System V or Solaris printing system configuration options. | |
fffed089 MS |
203 | .SH EXAMPLE |
204 | Create an IPP Everywhere print queue: | |
205 | .nf | |
206 | ||
207 | lpadmin -p myprinter -E -v ipp://myprinter.local/ipp/print -m everywhere | |
208 | ||
209 | .fi | |
ef416fc2 | 210 | .SH SEE ALSO |
cfa19b58 MS |
211 | .BR cupsaccept (8), |
212 | .BR cupsenable (8), | |
213 | .BR lpinfo (8), | |
214 | .BR lpoptions (1), | |
215 | CUPS Online Help (http://localhost:631/help) | |
ef416fc2 | 216 | .SH COPYRIGHT |
fffed089 | 217 | Copyright \[co] 2007-2015 by Apple Inc. |
ef416fc2 | 218 | .\" |
e4e5666b | 219 | .\" End of "$Id$". |
ef416fc2 | 220 | .\" |