]>
Commit | Line | Data |
---|---|---|
ef416fc2 | 1 | .\" |
75bd9771 | 2 | .\" "$Id: lpadmin.man 7600 2008-05-20 21:06:23Z mike $" |
ef416fc2 | 3 | .\" |
4 | .\" lpadmin man page for the Common UNIX Printing System (CUPS). | |
5 | .\" | |
c168a833 | 6 | .\" Copyright 2007-2009 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 | .\" |
9aff70cc | 15 | .TH lpadmin 8 "CUPS" "3 November 2008" "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 | |
33 | .I printer 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 |
58 | printer. 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 |
bd7854cb | 81 | Sets a standard System V interface script or PPD file from the |
82 | \fImodel\fR directory. | |
ef416fc2 | 83 | .TP 5 |
bd7854cb | 84 | -o job-k-limit=value |
ef416fc2 | 85 | .br |
bd7854cb | 86 | Sets the kilobyte limit for per-user quotas. The value is an |
87 | integer number of kilobytes; one kilobyte is 1024 bytes. | |
ef416fc2 | 88 | .TP 5 |
bd7854cb | 89 | -o job-page-limit=value |
ef416fc2 | 90 | .br |
bd7854cb | 91 | Sets the page limit for per-user quotas. The value is the integer |
92 | number of pages that can be printed; double-sided pages are | |
93 | counted as two pages. | |
ef416fc2 | 94 | .TP 5 |
bd7854cb | 95 | -o job-quota-period=value |
ef416fc2 | 96 | .br |
bd7854cb | 97 | Sets the accounting period for per-user quotas. The value is an |
98 | integer number of seconds; 86,400 seconds are in one day. | |
ef416fc2 | 99 | .TP 5 |
bd7854cb | 100 | -o job-sheets-default=banner |
101 | .TP 5 | |
102 | -o job-sheets-default=banner,banner | |
103 | .br | |
104 | Sets the default banner page(s) to use for print jobs. | |
105 | .TP 5 | |
3d052e43 MS |
106 | -o name=value |
107 | .br | |
108 | Sets a PPD option for the printer. PPD options can be | |
109 | listed using the \fI-l\fR option with the \fIlpoptions(1)\fR | |
110 | command. | |
111 | .TP 5 | |
112 | -o name-default=value | |
113 | .br | |
114 | Sets a default server-side option for the printer. Any print-time | |
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 | |
07725fee | 128 | "abort-job", "retry-job" or "stop-printer". The default error |
8ca02f3c | 129 | policy is "stop-printer". |
130 | .TP 5 | |
131 | -o printer-is-shared=true/false | |
132 | .br | |
133 | Sets the printer to shared/published or unshared/unpublished. | |
134 | Shared/published printers are publically announced by the server | |
135 | on the LAN based on the browsing configuration in | |
136 | \fBcupsd.conf\fR, while unshared/unpublished printers are not | |
137 | announced. The default value is "true". | |
138 | .TP 5 | |
139 | -o printer-op-policy=name | |
140 | .br | |
141 | Sets the IPP operation policy associated with the printer. The | |
142 | name must be defined in the \fBcupsd.conf\fR in a Policy section. | |
143 | The default operation policy is "default". | |
144 | .TP 5 | |
bd7854cb | 145 | -r class |
ef416fc2 | 146 | .br |
bd7854cb | 147 | Removes the named \fIprinter\fR from \fIclass\fR. If the |
148 | resulting class becomes empty it is removed. | |
ef416fc2 | 149 | .TP 5 |
bd7854cb | 150 | -u allow:user,user,@group |
80ca4592 | 151 | .TP 5 |
bd7854cb | 152 | -u deny:user,user,@group |
80ca4592 | 153 | .TP 5 |
bd7854cb | 154 | -u allow:all |
80ca4592 | 155 | .TP 5 |
bd7854cb | 156 | -u deny:none |
ef416fc2 | 157 | .br |
158 | Sets user-level access control on a printer. Names starting with | |
159 | "@" are interpreted as UNIX groups. The latter two forms turn | |
160 | user-level access control off. | |
161 | .TP 5 | |
bd7854cb | 162 | -v "device-uri" |
ef416fc2 | 163 | .br |
bd7854cb | 164 | Sets the \fIdevice-uri\fR attribute of the printer queue. If |
165 | \fIdevice-uri\fR is a filename it is automatically converted to | |
8ca02f3c | 166 | the form \fIfile:///file/name\fR. Use the \fIlpinfo(8)\fR command |
167 | to get a list of supported device URIs and schemes. | |
ef416fc2 | 168 | .TP 5 |
bd7854cb | 169 | -D "info" |
ef416fc2 | 170 | .br |
171 | Provides a textual description of the printer. | |
172 | .TP 5 | |
bd7854cb | 173 | -E |
ef416fc2 | 174 | .br |
175 | Enables the printer and accepts jobs; this is the same as running the | |
e6013cfa | 176 | \fIcupsaccept(8)\fR and \fIcupsenable(8)\fR programs on the printer. |
ef416fc2 | 177 | .TP 5 |
bd7854cb | 178 | -L "location" |
ef416fc2 | 179 | .br |
180 | Provides a textual location of the printer. | |
181 | .TP 5 | |
bd7854cb | 182 | -P ppd-file |
ef416fc2 | 183 | .br |
bd7854cb | 184 | Specifies a PostScript Printer Description file to use with the |
185 | printer. If specified, this option overrides the \fI-i\fR option | |
186 | (interface script). | |
ef416fc2 | 187 | .SH COMPATIBILITY |
bd7854cb | 188 | Unlike the System V printing system, CUPS allows printer names to |
189 | contain any printable character except SPACE, TAB, "/", or "#". | |
190 | Also, printer and class names are \fInot\fR case-sensitive. | |
191 | Finally, the CUPS version of \fIlpadmin\fR may ask the user for | |
192 | an access password depending on the printing system | |
193 | configuration. This differs from the System V version which | |
194 | requires the root user to execute this command. | |
ef416fc2 | 195 | .SH LIMITATIONS |
bd7854cb | 196 | The CUPS version of \fIlpadmin\fR does not support all of the |
197 | System V or Solaris printing system configuration options. | |
ef416fc2 | 198 | .SH SEE ALSO |
e6013cfa | 199 | \fIcupsaccept(8)\fR, \fIcupsenable(8)\fR, \fIlpinfo(8)\fR, |
8ca02f3c | 200 | \fIlpoptions(1)\fR, |
bd7854cb | 201 | .br |
202 | http://localhost:631/help | |
ef416fc2 | 203 | .SH COPYRIGHT |
c168a833 | 204 | Copyright 2007-2009 by Apple Inc. |
ef416fc2 | 205 | .\" |
75bd9771 | 206 | .\" End of "$Id: lpadmin.man 7600 2008-05-20 21:06:23Z mike $". |
ef416fc2 | 207 | .\" |