1lpadmin(8) Apple Inc. lpadmin(8)
2
6 lpadmin - configure cups printers and classes
7
9 lpadmin [ -E ] [ -U username ] [ -h server[:port] ] -d destination
10 lpadmin [ -E ] [ -U username ] [ -h server[:port] ] -p destination [ -R
11 name-default ] option(s)
12 lpadmin [ -E ] [ -U username ] [ -h server[:port] ] -x destination
13
15 lpadmin configures printer and class queues provided by CUPS. It can
16 also be used to set the server default printer or class.
17 When specified before the -d, -p, or -x options, the -E option forces
19 encryption when connecting to the server.
20 The first form of the command (-d) sets the default printer or class to
22 destination. Subsequent print jobs submitted via the lp(1) or lpr(1)
23 commands will use this destination unless the user specifies otherwise
24 with the lpoptions(1) command.
25 The second form of the command (-p) configures the named printer or
27 class. The additional options are described below.
28 The third form of the command (-x) deletes the printer or class desti‐
30 nation. Any jobs that are pending for the destination will be removed
31 and any job that is currently printed will be aborted.
32
34 The following options are recognized when configuring a printer queue:
35 -c class
37 Adds the named printer to class. If class does not exist it is
38 created automatically.
39 -i ppd-file
41 -P ppd-file
43 Specifies a PostScript Printer Description (PPD) file to use with
44 the printer.
45 -m model
47 Sets a standard PPD file for the printer from the model directory
48 or using one of the driver interfaces. Use the -m option with the
49 lpinfo(8) command to get a list of supported models. The model
50 "raw" clears any existing PPD file and the model "everywhere"
51 queries the printer referred to by the specified IPP device-uri.
52 Note: The "raw" model is deprecated and will not be supported in a
53 future version of CUPS.
54 -o cupsIPPSupplies=true
56 -o cupsIPPSupplies=false
58 Specifies whether IPP supply level values should be reported.
59 -o cupsSNMPSupplies=true
61 -o cupsSNMPSupplies=false
63 Specifies whether SNMP supply level (RFC 3805) values should be
64 reported.
65 -o job-k-limit=value
67 Sets the kilobyte limit for per-user quotas. The value is an
68 integer number of kilobytes; one kilobyte is 1024 bytes.
69 -o job-page-limit=value
71 Sets the page limit for per-user quotas. The value is the integer
72 number of pages that can be printed; double-sided pages are
73 counted as two pages.
74 -o job-quota-period=value
76 Sets the accounting period for per-user quotas. The value is an
77 integer number of seconds; 86,400 seconds are in one day.
78 -o job-sheets-default=banner
80 -o job-sheets-default=banner,banner
82 Sets the default banner page(s) to use for print jobs.
83 -o name=value
85 Sets a PPD option for the printer. PPD options can be listed
86 using the -l option with the lpoptions(1) command.
87 -o name-default=value
89 Sets a default server-side option for the destination. Any print-
90 time option can be defaulted, e.g., "-o number-up-default=2" to
91 set the default "number-up" option value to 2.
92 -o port-monitor=name
94 Sets the binary communications program to use when printing,
95 "none", "bcp", or "tbcp". The default program is "none". The
96 specified port monitor must be listed in the printer's PPD file.
97 -o printer-error-policy=name
99 Sets the error policy to be used when the printer backend is
100 unable to send the job to the printer. The name must be one of
101 "abort-job", "retry-job", "retry-current-job", or "stop-printer".
102 The default error policy is "stop-printer" for printers and
103 "retry-current-job" for classes.
104 -o printer-is-shared=true
106 -o printer-is-shared=false
108 Sets the destination to shared/published or unshared/unpublished.
109 Shared/published destinations are publicly announced by the server
110 on the LAN based on the browsing configuration in cupsd.conf,
111 while unshared/unpublished destinations are not announced. The
112 default value is "true".
113 -o printer-op-policy=name
115 Sets the IPP operation policy associated with the destination.
116 The name must be defined in the cupsd.conf in a Policy section.
117 The default operation policy is "default".
118 -R name-default
120 Deletes the named option from printer.
121 -r class
123 Removes the named printer from class. If the resulting class
124 becomes empty it is removed.
125 -u allow:{user|@group}{,user|,@group}*
127 -u deny:{user|@group}{,user|,@group}*
129 -u allow:all
131 -u deny:none
133 Sets user-level access control on a destination. Names starting
134 with "@" are interpreted as UNIX groups. The latter two forms
135 turn user-level access control off. Note: The user 'root' is not
136 granted special access - using "-u allow:foo,bar" will allow users
137 'foo' and 'bar' to access the printer but NOT 'root'.
138 -v "device-uri"
140 Sets the device-uri attribute of the printer queue. Use the -v
141 option with the lpinfo(8) command to get a list of supported
142 device URIs and schemes.
143 -D "info"
145 Provides a textual description of the destination.
146 -E When specified before the -d, -p, or -x options, forces the use of
148 TLS encryption on the connection to the scheduler. Otherwise,
149 enables the destination and accepts jobs; this is the same as run‐
150 ning the cupsaccept(8) and cupsenable(8) programs on the destina‐
151 tion.
152 -L "location"
154 Provides a textual location of the destination.
155
157 Unlike the System V printing system, CUPS allows printer names to con‐
158 tain any printable character except SPACE, TAB, "/", or "#". Also,
159 printer and class names are not case-sensitive. Finally, the CUPS ver‐
160 sion of lpadmin may ask the user for an access password depending on
161 the printing system configuration. This differs from the System V ver‐
162 sion which requires the root user to execute this command.
163
165 The CUPS version of lpadmin does not support all of the System V or
166 Solaris printing system configuration options.
167 The double meaning of the -E option is an unfortunate historical odd‐
169 ity.
170
172 Create an IPP Everywhere print queue:
173 lpadmin -p myprinter -E -v ipp://myprinter.local/ipp/print -m everywhere
175
178 cupsaccept(8), cupsenable(8), lpinfo(8), lpoptions(1), CUPS Online Help
179 (http://localhost:631/help)
180
182 Copyright © 2007-2018 by Apple Inc.
18319 August 2018 CUPS lpadmin(8)