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
11 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 interface
41 Sets a System V style interface script for the printer. This
42 option cannot be specified with the -P option (PPD file) and is
43 intended for providing support for legacy printer drivers.
44 -m model
46 Sets a standard System V interface script or PPD file for the
47 printer from the model directory or using one of the driver inter‐
48 faces. Use the -m option with the lpinfo(8) command to get a list
49 of supported models.
50 -o job-k-limit=value
52 Sets the kilobyte limit for per-user quotas. The value is an inte‐
53 ger number of kilobytes; one kilobyte is 1024 bytes.
54 -o job-page-limit=value
56 Sets the page limit for per-user quotas. The value is the integer
57 number of pages that can be printed; double-sided pages are
58 counted as two pages.
59 -o job-quota-period=value
61 Sets the accounting period for per-user quotas. The value is an
62 integer number of seconds; 86,400 seconds are in one day.
63 -o job-sheets-default=banner
65 -o job-sheets-default=banner,banner
67 Sets the default banner page(s) to use for print jobs.
68 -o name=value
70 Sets a PPD option for the printer. PPD options can be listed using
71 the -l option with the lpoptions(1) command.
72 -o name-default=value
74 Sets a default server-side option for the destination. Any print-
75 time option can be defaulted, e.g. "-o cpi-default=17" to set the
76 default "cpi" option value to 17.
77 -o port-monitor=name
79 Sets the binary communications program to use when printing,
80 "none", "bcp", or "tbcp". The default program is "none". The spec‐
81 ified port monitor must be listed in the printer's PPD file.
82 -o printer-error-policy=name
84 Sets the error policy to be used when the printer backend is
85 unable to send the job to the printer. The name must be one of
86 "abort-job", "retry-job", "retry-current-job", or "stop-printer".
87 The default error policy is "stop-printer" for printers and
88 "retry-current-job" for classes.
89 -o printer-is-shared=true/false
91 Sets the destination to shared/published or unshared/unpublished.
92 Shared/published destinations are publicly announced by the server
93 on the LAN based on the browsing configuration in cupsd.conf,
94 while unshared/unpublished destinations are not announced. The
95 default value is "true".
96 -o printer-op-policy=name
98 Sets the IPP operation policy associated with the destination. The
99 name must be defined in the cupsd.conf in a Policy section. The
100 default operation policy is "default".
101 -r class
103 Removes the named printer from class. If the resulting class
104 becomes empty it is removed.
105 -u allow:user,user,@group
107 -u deny:user,user,@group
109 -u allow:all
111 -u deny:none
113 Sets user-level access control on a destination. Names starting
114 with "@" are interpreted as UNIX groups. The latter two forms turn
115 user-level access control off.
116 -v "device-uri"
118 Sets the device-uri attribute of the printer queue. If device-uri
119 is a filename it is automatically converted to the form
120 file:///file/name. Use the -v option with the lpinfo(8) command to
121 get a list of supported device URIs and schemes.
122 -D "info"
124 Provides a textual description of the destination.
125 -E
127 Enables the destination and accepts jobs; this is the same as run‐
128 ning the cupsaccept(8) and cupsenable(8) programs on the destina‐
129 tion.
130 -L "location"
132 Provides a textual location of the destination.
133 -P ppd-file
135 Specifies a PostScript Printer Description file to use with the
136 printer. If specified, this option overrides the -i option (inter‐
137 face script).
138
140 Unlike the System V printing system, CUPS allows printer names to con‐
141 tain any printable character except SPACE, TAB, "/", or "#". Also,
142 printer and class names are not case-sensitive. Finally, the CUPS ver‐
143 sion of lpadmin may ask the user for an access password depending on
144 the printing system configuration. This differs from the System V ver‐
145 sion which requires the root user to execute this command.
146
148 The CUPS version of lpadmin does not support all of the System V or
149 Solaris printing system configuration options.
150
152 cupsaccept(8), cupsenable(8), lpinfo(8), lpoptions(1),
153 http://localhost:631/help
154
156 Copyright 2007-2011 by Apple Inc.
1577 January 2011 CUPS lpadmin(8)