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