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