2 .\" "$Id: lpadmin.man 7600 2008-05-20 21:06:23Z mike $"
4 .\" lpadmin man page for the Common UNIX Printing System (CUPS).
6 .\" Copyright 2007-2008 by Apple Inc.
7 .\" Copyright 1997-2006 by Easy Software Products.
9 .\" These coded instructions, statements, and computer programs are the
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/".
15 .TH lpadmin 8 "Common UNIX Printing System" "2 January 2008" "Apple Inc."
17 lpadmin \- configure cups printers and classes
43 \fIlpadmin\fR configures printer and class queues provided by
44 CUPS. It can also be used to set the server default printer or
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
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.
57 The second form of the command (\fI-p\fR) configures the named
58 printer. The additional options are described below.
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
64 .SH CONFIGURATION OPTIONS
65 The following options are recognized when configuring a printer
70 Adds the named \fIprinter\fR to \fIclass\fR. If \fIclass\fR does
71 not exist it is created automatically.
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.
81 Sets a standard System V interface script or PPD file from the
82 \fImodel\fR directory.
86 Sets the kilobyte limit for per-user quotas. The value is an
87 integer number of kilobytes; one kilobyte is 1024 bytes.
89 -o job-page-limit=value
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
95 -o job-quota-period=value
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.
100 -o job-sheets-default=banner
102 -o job-sheets-default=banner,banner
104 Sets the default banner page(s) to use for print jobs.
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
112 -o name-default=value
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.
120 Sets the binary communications program to use when printing,
121 "none", "bcp", or "tbcp". The default program is "none". The
122 specified port monitor must be listed in the printer's PPD file.
124 -o printer-error-policy=name
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
128 "abort-job", "retry-job" or "stop-printer". The default error
129 policy is "stop-printer".
131 -o printer-is-shared=true/false
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".
139 -o printer-op-policy=name
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".
147 Removes the named \fIprinter\fR from \fIclass\fR. If the
148 resulting class becomes empty it is removed.
150 -u allow:user,user,@group
152 -u deny:user,user,@group
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.
164 Sets the \fIdevice-uri\fR attribute of the printer queue. If
165 \fIdevice-uri\fR is a filename it is automatically converted to
166 the form \fIfile:///file/name\fR. Use the \fIlpinfo(8)\fR command
167 to get a list of supported device URIs and schemes.
171 Provides a textual description of the printer.
175 Enables the printer and accepts jobs; this is the same as running the
176 \fIaccept(8)\fR and \fIcupsenable(8)\fR programs on the printer.
180 Provides a textual location of the printer.
184 Specifies a PostScript Printer Description file to use with the
185 printer. If specified, this option overrides the \fI-i\fR option
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.
196 The CUPS version of \fIlpadmin\fR does not support all of the
197 System V or Solaris printing system configuration options.
199 \fIaccept(8)\fR, \fIcupsenable(8)\fR, \fIlpinfo(8)\fR,
202 http://localhost:631/help
204 Copyright 2007-2008 by Apple Inc.
206 .\" End of "$Id: lpadmin.man 7600 2008-05-20 21:06:23Z mike $".