1lpadmin(8)                  Easy Software Products                  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 printer option(s)
11       lpadmin [ -E ] [-U username ] [ -h server[:port] ] -x destination
12

DESCRIPTION

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

CONFIGURATION OPTIONS

33       The following options are recognized when configuring a printer queue:
34
35       -c class
36            Adds  the  named  printer to class.  If class does not exist it is
37            created automatically.
38
39       -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
44       -m model
45            Sets a standard System V interface script or  PPD  file  from  the
46            model directory.
47
48       -o name=value
49            Sets  a  PPD  or server option for the printer. PPD options can be
50            listed using the -l option with the lpoptions(1) command.
51
52       -o job-k-limit=value
53            Sets the kilobyte limit for per-user quotas. The value is an inte‐
54            ger number of kilobytes; one kilobyte is 1024 bytes.
55
56       -o job-page-limit=value
57            Sets  the page limit for per-user quotas. The value is the integer
58            number of pages  that  can  be  printed;  double-sided  pages  are
59            counted as two pages.
60
61       -o job-quota-period=value
62            Sets  the  accounting  period for per-user quotas. The value is an
63            integer number of seconds; 86,400 seconds are in one day.
64
65       -o job-sheets-default=banner
66
67       -o job-sheets-default=banner,banner
68            Sets the default banner page(s) to use for print jobs.
69
70       -o port-monitor=name
71            Sets the binary  communications  program  to  use  when  printing,
72            "none", "bcp", or "tbcp". The default program is "none".
73
74       -o printer-error-policy=name
75            Sets  the  error  policy  to  be  used when the printer backend is
76            unable to send the job to the printer. The name  must  be  one  of
77            "abort-job", "retry-job" or "stop-printer". The default error pol‐
78            icy is "stop-printer".
79
80       -o printer-is-shared=true/false
81            Sets the  printer  to  shared/published  or  unshared/unpublished.
82            Shared/published  printers  are publically announced by the server
83            on the LAN based on  the  browsing  configuration  in  cupsd.conf,
84            while unshared/unpublished printers are not announced. The default
85            value is "true".
86
87       -o printer-op-policy=name
88            Sets the IPP operation policy associated  with  the  printer.  The
89            name  must  be defined in the cupsd.conf in a Policy section.  The
90            default operation policy is "default".
91
92       -r class
93            Removes the named printer from  class.   If  the  resulting  class
94            becomes empty it is removed.
95
96       -u allow:user,user,@group
97
98       -u deny:user,user,@group
99
100       -u allow:all
101
102       -u deny:none
103            Sets  user-level  access control on a printer. Names starting with
104            "@" are interpreted as UNIX groups.  The  latter  two  forms  turn
105            user-level access control off.
106
107       -v "device-uri"
108            Sets the device-uri attribute of the printer queue.  If device-uri
109            is  a  filename  it  is  automatically  converted  to   the   form
110            file:///file/name. Use the lpinfo(8) command to get a list of sup‐
111            ported device URIs and schemes.
112
113       -D "info"
114            Provides a textual description of the printer.
115
116       -E
117            Enables the printer and accepts jobs; this is the same as  running
118            the accept(8) and cupsenable(8) programs on the printer.
119
120       -L "location"
121            Provides a textual location of the printer.
122
123       -P ppd-file
124            Specifies  a  PostScript  Printer Description file to use with the
125            printer. If specified, this option overrides the -i option (inter‐
126            face script).
127

COMPATIBILITY

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

LIMITATIONS

137       The CUPS version of lpadmin does not support all of  the  System  V  or
138       Solaris printing system configuration options.
139

SEE ALSO

141       accept(8), cupsenable(8), lpinfo(8), lpoptions(1),
142       http://localhost:631/help
143
145       Copyright 1997-2006 by Easy Software Products, All Rights Reserved.
146
147
148
14913 July 2006              Common UNIX Printing System               lpadmin(8)
Impressum