1lpadmin(8)                        Apple Inc.                        lpadmin(8)
2
3
4

NAME

6       lpadmin - configure cups printers and classes
7

SYNOPSIS

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

DESCRIPTION

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
18       When  specified  before the -d, -p, or -x options, the -E option forces
19       encryption when connecting to the server.
20
21       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
26       The  second  form  of  the command (-p) configures the named printer or
27       class.  The additional options are described below.
28
29       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

OPTIONS

34       The following options are recognized when configuring a printer queue:
35
36       -c class
37            Adds the named printer to class.  If class does not  exist  it  is
38            created automatically.
39
40       -i ppd-file
41
42       -P ppd-file
43            Specifies  a PostScript Printer Description (PPD) file to use with
44            the printer.
45
46       -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
53       -o cupsIPPSupplies=true
54
55       -o cupsIPPSupplies=false
56            Specifies whether IPP supply level values should be reported.
57
58       -o cupsSNMPSupplies=true
59
60       -o cupsSNMPSupplies=false
61            Specifies whether SNMP supply level (RFC 3805)  values  should  be
62            reported.
63
64       -o job-k-limit=value
65            Sets  the  kilobyte  limit  for  per-user quotas.  The value is an
66            integer number of kilobytes; one kilobyte is 1024 bytes.
67
68       -o job-page-limit=value
69            Sets the page limit for per-user quotas.  The value is the integer
70            number  of  pages  that  can  be  printed;  double-sided pages are
71            counted as two pages.
72
73       -o job-quota-period=value
74            Sets the accounting period for per-user quotas.  The value  is  an
75            integer number of seconds; 86,400 seconds are in one day.
76
77       -o job-sheets-default=banner
78
79       -o job-sheets-default=banner,banner
80            Sets the default banner page(s) to use for print jobs.
81
82       -o name=value
83            Sets  a  PPD  option  for  the printer.  PPD options can be listed
84            using the -l option with the lpoptions(1) command.
85
86       -o name-default=value
87            Sets a default server-side option for the destination.  Any print-
88            time  option  can  be defaulted, e.g., "-o number-up-default=2" to
89            set the default "number-up" option value to 2.
90
91       -o port-monitor=name
92            Sets the binary  communications  program  to  use  when  printing,
93            "none",  "bcp",  or  "tbcp".   The default program is "none".  The
94            specified port monitor must be listed in the printer's PPD file.
95
96       -o printer-error-policy=name
97            Sets the error policy to be  used  when  the  printer  backend  is
98            unable  to  send  the job to the printer.  The name must be one of
99            "abort-job", "retry-job", "retry-current-job", or  "stop-printer".
100            The  default  error  policy  is  "stop-printer"  for  printers and
101            "retry-current-job" for classes.
102
103       -o printer-is-shared=true
104
105       -o printer-is-shared=false
106            Sets the destination to shared/published or  unshared/unpublished.
107            Shared/published destinations are publicly announced by the server
108            on the LAN based on  the  browsing  configuration  in  cupsd.conf,
109            while  unshared/unpublished  destinations  are not announced.  The
110            default value is "true".
111
112       -o printer-op-policy=name
113            Sets the IPP operation policy  associated  with  the  destination.
114            The  name  must  be defined in the cupsd.conf in a Policy section.
115            The default operation policy is "default".
116
117       -R name-default
118            Deletes the named option from printer.
119
120       -r class
121            Removes the named printer from  class.   If  the  resulting  class
122            becomes empty it is removed.
123
124       -u allow:{user|@group}{,user|,@group}*
125
126       -u deny:{user|@group}{,user|,@group}*
127
128       -u allow:all
129
130       -u deny:none
131            Sets  user-level  access control on a destination.  Names starting
132            with "@" are interpreted as UNIX groups.   The  latter  two  forms
133            turn  user-level access control off.  Note: The user 'root' is not
134            granted special access - using "-u allow:foo,bar" will allow users
135            'foo' and 'bar' to access the printer but NOT 'root'.
136
137       -v "device-uri"
138            Sets  the  device-uri  attribute of the printer queue.  Use the -v
139            option with the lpinfo(8) command  to  get  a  list  of  supported
140            device URIs and schemes.
141
142       -D "info"
143            Provides a textual description of the destination.
144
145       -E   Enables the destination and accepts jobs; this is the same as run‐
146            ning the cupsaccept(8) and cupsenable(8) programs on the  destina‐
147            tion.
148
149       -L "location"
150            Provides a textual location of the destination.
151

CONFORMING TO

153       Unlike  the System V printing system, CUPS allows printer names to con‐
154       tain any printable character except SPACE, TAB,  "/",  or  "#".   Also,
155       printer and class names are not case-sensitive.  Finally, the CUPS ver‐
156       sion of lpadmin may ask the user for an access  password  depending  on
157       the printing system configuration.  This differs from the System V ver‐
158       sion which requires the root user to execute this command.
159

NOTES

161       The CUPS version of lpadmin does not support all of  the  System  V  or
162       Solaris printing system configuration options.
163

EXAMPLE

165       Create an IPP Everywhere print queue:
166
167           lpadmin -p myprinter -E -v ipp://myprinter.local/ipp/print -m everywhere
168
169

SEE ALSO

171       cupsaccept(8), cupsenable(8), lpinfo(8), lpoptions(1), CUPS Online Help
172       (http://localhost:631/help)
173
175       Copyright © 2007-2017 by Apple Inc.
176
177
178
17929 March 2016                        CUPS                           lpadmin(8)
Impressum