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