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