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 printer option(s)
11 lpadmin [ -E ] [-U username ] [ -h server[:port] ] -x destination
12
14 lpadmin configures printer and class queues provided by CUPS. It can
15 also be used to set the server default printer or class.
16 When specified before the -d, -p, or -x options, the -E option forces
18 encryption when connecting to the server.
19 The first form of the command (-d) sets the default printer or class to
21 destination. Subsequent print jobs submitted via the lp(1) or lpr(1)
22 commands will use this destination unless the user specifies otherwise
23 with the lpoptions(1) command.
24 The second form of the command (-p) configures the named printer. The
26 additional options are described below.
27 The third form of the command (-x) deletes the printer or class desti‐
29 nation. Any jobs that are pending for the destination will be removed
30 and any job that is currently printed will be aborted.
31
33 The following options are recognized when configuring a printer queue:
34 -c class
36 Adds the named printer to class. If class does not exist it is
37 created automatically.
38 -i interface
40 Sets a System V style interface script for the printer. This
41 option cannot be specified with the -P option (PPD file) and is
42 intended for providing support for legacy printer drivers.
43 -m model
45 Sets a standard System V interface script or PPD file from the
46 model directory.
47 -o job-k-limit=value
49 Sets the kilobyte limit for per-user quotas. The value is an inte‐
50 ger number of kilobytes; one kilobyte is 1024 bytes.
51 -o job-page-limit=value
53 Sets the page limit for per-user quotas. The value is the integer
54 number of pages that can be printed; double-sided pages are
55 counted as two pages.
56 -o job-quota-period=value
58 Sets the accounting period for per-user quotas. The value is an
59 integer number of seconds; 86,400 seconds are in one day.
60 -o job-sheets-default=banner
62 -o job-sheets-default=banner,banner
64 Sets the default banner page(s) to use for print jobs.
65 -o name=value
67 Sets a PPD option for the printer. PPD options can be listed using
68 the -l option with the lpoptions(1) command.
69 -o name-default=value
71 Sets a default server-side option for the printer. Any print-time
72 option can be defaulted, e.g. "-o cpi-default=17" to set the
73 default "cpi" option value to 17.
74 -o port-monitor=name
76 Sets the binary communications program to use when printing,
77 "none", "bcp", or "tbcp". The default program is "none". The spec‐
78 ified port monitor must be listed in the printer's PPD file.
79 -o printer-error-policy=name
81 Sets the error policy to be used when the printer backend is
82 unable to send the job to the printer. The name must be one of
83 "abort-job", "retry-job" or "stop-printer". The default error pol‐
84 icy is "stop-printer".
85 -o printer-is-shared=true/false
87 Sets the printer to shared/published or unshared/unpublished.
88 Shared/published printers are publically announced by the server
89 on the LAN based on the browsing configuration in cupsd.conf,
90 while unshared/unpublished printers are not announced. The default
91 value is "true".
92 -o printer-op-policy=name
94 Sets the IPP operation policy associated with the printer. The
95 name must be defined in the cupsd.conf in a Policy section. The
96 default operation policy is "default".
97 -r class
99 Removes the named printer from class. If the resulting class
100 becomes empty it is removed.
101 -u allow:user,user,@group
103 -u deny:user,user,@group
105 -u allow:all
107 -u deny:none
109 Sets user-level access control on a printer. Names starting with
110 "@" are interpreted as UNIX groups. The latter two forms turn
111 user-level access control off.
112 -v "device-uri"
114 Sets the device-uri attribute of the printer queue. If device-uri
115 is a filename it is automatically converted to the form
116 file:///file/name. Use the lpinfo(8) command to get a list of sup‐
117 ported device URIs and schemes.
118 -D "info"
120 Provides a textual description of the printer.
121 -E
123 Enables the printer and accepts jobs; this is the same as running
124 the cupsaccept(8) and cupsenable(8) programs on the printer.
125 -L "location"
127 Provides a textual location of the printer.
128 -P ppd-file
130 Specifies a PostScript Printer Description file to use with the
131 printer. If specified, this option overrides the -i option (inter‐
132 face script).
133
135 Unlike the System V printing system, CUPS allows printer names to con‐
136 tain any printable character except SPACE, TAB, "/", or "#". Also,
137 printer and class names are not case-sensitive. Finally, the CUPS ver‐
138 sion of lpadmin may ask the user for an access password depending on
139 the printing system configuration. This differs from the System V ver‐
140 sion which requires the root user to execute this command.
141
143 The CUPS version of lpadmin does not support all of the System V or
144 Solaris printing system configuration options.
145
147 cupsaccept(8), cupsenable(8), lpinfo(8), lpoptions(1),
148 http://localhost:631/help
149
151 Copyright 2007-2009 by Apple Inc.
1523 November 2008 CUPS lpadmin(8)