2 .\" "$Id: lpadmin.man 7600 2008-05-20 21:06:23Z mike $"
4 .\" lpadmin man page for CUPS.
6 .\" Copyright 2007-2011 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 "CUPS" "7 January 2011" "Apple Inc."
17 lpadmin \- configure cups printers and classes
33 .I destination option(s)
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 or class. 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 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.
87 Sets the kilobyte limit for per-user quotas. The value is an
88 integer number of kilobytes; one kilobyte is 1024 bytes.
90 -o job-page-limit=value
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
96 -o job-quota-period=value
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.
101 -o job-sheets-default=banner
103 -o job-sheets-default=banner,banner
105 Sets the default banner page(s) to use for print jobs.
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.
112 -o name-default=value
114 Sets a default server-side option for the destination. 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", "retry-current-job", or "stop-printer". The default
129 error policy is "stop-printer" for printers and "retry-current-job" for
132 -o printer-is-shared=true/false
134 Sets the destination to shared/published or unshared/unpublished.
135 Shared/published destinations are publicly announced by the server
136 on the LAN based on the browsing configuration in
137 \fBcupsd.conf\fR, while unshared/unpublished destinations are not
138 announced. The default value is "true".
140 -o printer-op-policy=name
142 Sets the IPP operation policy associated with the destination. The
143 name must be defined in the \fBcupsd.conf\fR in a Policy section.
144 The default operation policy is "default".
148 Removes the named \fIprinter\fR from \fIclass\fR. If the
149 resulting class becomes empty it is removed.
151 -u allow:user,user,@group
153 -u deny:user,user,@group
159 Sets user-level access control on a destination. Names starting with
160 "@" are interpreted as UNIX groups. The latter two forms turn
161 user-level access control off.
165 Sets the \fIdevice-uri\fR attribute of the printer queue. If
166 \fIdevice-uri\fR is a filename it is automatically converted to
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.
172 Provides a textual description of the destination.
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.
181 Provides a textual location of the destination.
185 Specifies a PostScript Printer Description file to use with the
186 printer. If specified, this option overrides the \fI-i\fR option
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.
197 The CUPS version of \fIlpadmin\fR does not support all of the
198 System V or Solaris printing system configuration options.
200 \fIcupsaccept(8)\fR, \fIcupsenable(8)\fR, \fIlpinfo(8)\fR,
203 http://localhost:631/help
205 Copyright 2007-2011 by Apple Inc.
207 .\" End of "$Id: lpadmin.man 7600 2008-05-20 21:06:23Z mike $".