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

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

COMPATIBILITY

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

LIMITATIONS

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

SEE ALSO

165       cupsaccept(8), cupsenable(8), lpinfo(8), lpoptions(1),
166       http://localhost:631/help
167
169       Copyright 2007-2013 by Apple Inc.
170
171
172
17316 July 2012                         CUPS                           lpadmin(8)
Impressum