]>
Commit | Line | Data |
---|---|---|
1 | <!DOCTYPE HTML> | |
2 | <html> | |
3 | <!-- SECTION: Man Pages --> | |
4 | <head> | |
5 | <link rel="stylesheet" type="text/css" href="../cups-printable.css"> | |
6 | <title>lpadmin(8)</title> | |
7 | </head> | |
8 | <body> | |
9 | <h1 class="title">lpadmin(8)</h1> | |
10 | <h2 class="title"><a name="NAME">Name</a></h2> | |
11 | lpadmin - configure cups printers and classes | |
12 | <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2> | |
13 | <b>lpadmin</b> | |
14 | [ | |
15 | <b>-E</b> | |
16 | ] [ | |
17 | <b>-U</b> | |
18 | <i>username</i> | |
19 | ] [ | |
20 | <b>-h </b><i>server</i>[<b>:</b><i>port</i>] | |
21 | ] | |
22 | <b>-d</b> | |
23 | <i>destination</i> | |
24 | <br> | |
25 | <b>lpadmin</b> | |
26 | [ | |
27 | <b>-E</b> | |
28 | ] [ | |
29 | <b>-U</b> | |
30 | <i>username</i> | |
31 | ] [ | |
32 | <b>-h </b><i>server</i>[<b>:</b><i>port</i>] | |
33 | ] | |
34 | <b>-p</b> | |
35 | <i>destination</i> | |
36 | [ | |
37 | <b>-R</b> | |
38 | <i>name-default</i> | |
39 | ] | |
40 | <i>option(s)</i> | |
41 | <br> | |
42 | <b>lpadmin</b> | |
43 | [ | |
44 | <b>-E</b> | |
45 | ] [ | |
46 | <b>-U</b> | |
47 | <i>username</i> | |
48 | ] [ | |
49 | <b>-h </b><i>server</i>[<b>:</b><i>port</i>] | |
50 | ] | |
51 | <b>-x</b> | |
52 | <i>destination</i> | |
53 | <h2 class="title"><a name="DESCRIPTION">Description</a></h2> | |
54 | <b>lpadmin</b> configures printer and class queues provided by CUPS. | |
55 | It can also be used to set the server default printer or class. | |
56 | <p>When specified before the <i>-d</i>, <i>-p</i>, or <i>-x</i> options, the <i>-E</i> option forces encryption when connecting to the server. | |
57 | <p>The first form of the command (<i>-d</i>) sets the default printer or class to <i>destination</i>. | |
58 | Subsequent print jobs submitted via the | |
59 | <a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1)</a> | |
60 | or | |
61 | <a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1)</a> | |
62 | commands will use this destination unless the user specifies otherwise with the | |
63 | <a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a> | |
64 | command. | |
65 | <p>The second form of the command (<i>-p</i>) configures the named printer or class. The additional options are described below. | |
66 | <p>The third form of the command (<i>-x</i>) deletes the printer or class <i>destination</i>. | |
67 | Any jobs that are pending for the destination will be removed and any job that is currently printed will be aborted. | |
68 | <h2 class="title"><a name="OPTIONS">Options</a></h2> | |
69 | The following options are recognized when configuring a printer queue: | |
70 | <dl class="man"> | |
71 | <dt><b>-c </b><i>class</i> | |
72 | <dd style="margin-left: 5.0em">Adds the named <i>printer</i> to <i>class</i>. | |
73 | If <i>class</i> does not exist it is created automatically. | |
74 | <dt><b>-i </b><i>ppd-file</i> | |
75 | <dd style="margin-left: 5.0em"><dt><b>-P </b><i>ppd-file</i> | |
76 | <dd style="margin-left: 5.0em">Specifies a PostScript Printer Description (PPD) file to use with the printer. | |
77 | <dt><b>-m </b><i>model</i> | |
78 | <dd style="margin-left: 5.0em">Sets a standard PPD file for the printer from the <i>model</i> directory or using one of the driver interfaces. | |
79 | Use the <i>-m</i> option with the | |
80 | <a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8)</a> | |
81 | command to get a list of supported models. | |
82 | The model "raw" clears any existing PPD file and the model "everywhere" queries the printer referred to by the specified IPP <i>device-uri</i>. | |
83 | <dt><b>-o cupsIPPSupplies=true</b> | |
84 | <dd style="margin-left: 5.0em"><dt><b>-o cupsIPPSupplies=false</b> | |
85 | <dd style="margin-left: 5.0em">Specifies whether IPP supply level values should be reported. | |
86 | <dt><b>-o cupsSNMPSupplies=true</b> | |
87 | <dd style="margin-left: 5.0em"><dt><b>-o cupsSNMPSupplies=false</b> | |
88 | <dd style="margin-left: 5.0em">Specifies whether SNMP supply level (RFC 3805) values should be reported. | |
89 | <dt><b>-o job-k-limit=</b><i>value</i> | |
90 | <dd style="margin-left: 5.0em">Sets the kilobyte limit for per-user quotas. | |
91 | The value is an integer number of kilobytes; one kilobyte is 1024 bytes. | |
92 | <dt><b>-o job-page-limit=</b><i>value</i> | |
93 | <dd style="margin-left: 5.0em">Sets the page limit for per-user quotas. | |
94 | The value is the integer number of pages that can be printed; double-sided pages are counted as two pages. | |
95 | <dt><b>-o job-quota-period=</b><i>value</i> | |
96 | <dd style="margin-left: 5.0em">Sets the accounting period for per-user quotas. | |
97 | The value is an integer number of seconds; 86,400 seconds are in one day. | |
98 | <dt><b>-o job-sheets-default=</b><i>banner</i> | |
99 | <dd style="margin-left: 5.0em"><dt><b>-o job-sheets-default=</b><i>banner</i><b>,</b><i>banner</i> | |
100 | <dd style="margin-left: 5.0em">Sets the default banner page(s) to use for print jobs. | |
101 | <dt><b>-o </b><i>name</i><b>=</b><i>value</i> | |
102 | <dd style="margin-left: 5.0em">Sets a PPD option for the printer. | |
103 | PPD options can be listed using the <i>-l</i> option with the | |
104 | <a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a> | |
105 | command. | |
106 | <dt><b>-o </b><i>name</i><b>-default=</b><i>value</i> | |
107 | <dd style="margin-left: 5.0em">Sets a default server-side option for the destination. | |
108 | Any print-time option can be defaulted, e.g., "-o number-up-default=2" to set the default "number-up" option value to 2. | |
109 | <dt><b>-o port-monitor=</b><i>name</i> | |
110 | <dd style="margin-left: 5.0em">Sets the binary communications program to use when printing, "none", "bcp", or "tbcp". | |
111 | The default program is "none". | |
112 | The specified port monitor must be listed in the printer's PPD file. | |
113 | <dt><b>-o printer-error-policy=</b><i>name</i> | |
114 | <dd style="margin-left: 5.0em">Sets the error policy to be used when the printer backend is unable to send the job to the printer. | |
115 | The name must be one of "abort-job", "retry-job", "retry-current-job", or "stop-printer". | |
116 | The default error policy is "stop-printer" for printers and "retry-current-job" for | |
117 | classes. | |
118 | <dt><b>-o printer-is-shared=true</b> | |
119 | <dd style="margin-left: 5.0em"><dt><b>-o printer-is-shared=false</b> | |
120 | <dd style="margin-left: 5.0em">Sets the destination to shared/published or unshared/unpublished. | |
121 | Shared/published destinations are publicly announced by the server on the LAN based on the browsing configuration in <i>cupsd.conf</i>, while unshared/unpublished destinations are not announced. | |
122 | The default value is "true". | |
123 | <dt><b>-o printer-op-policy=</b><i>name</i> | |
124 | <dd style="margin-left: 5.0em">Sets the IPP operation policy associated with the destination. | |
125 | The name must be defined in the <i>cupsd.conf</i> in a Policy section. | |
126 | The default operation policy is "default". | |
127 | <dt><b>-R </b><i>name</i><b>-default</b> | |
128 | <dd style="margin-left: 5.0em">Deletes the named option from <i>printer</i>. | |
129 | <dt><b>-r </b><i>class</i> | |
130 | <dd style="margin-left: 5.0em">Removes the named <i>printer</i> from <i>class</i>. | |
131 | If the resulting class becomes empty it is removed. | |
132 | <dt><b>-u allow:</b>{<i>user</i>|<b>@</b><i>group</i>}{<b>,</b><i>user</i>|<b>,@</b><i>group</i>}* | |
133 | <dd style="margin-left: 5.0em"><dt><b>-u deny:</b>{<i>user</i>|<b>@</b><i>group</i>}{<b>,</b><i>user</i>|<b>,@</b><i>group</i>}* | |
134 | <dd style="margin-left: 5.0em"><dt><b>-u allow:all</b> | |
135 | <dd style="margin-left: 5.0em"><dt><b>-u deny:none</b> | |
136 | <dd style="margin-left: 5.0em">Sets user-level access control on a destination. | |
137 | Names starting with "@" are interpreted as UNIX groups. | |
138 | The latter two forms turn user-level access control off. | |
139 | Note: The user 'root' is not granted special access - using "-u allow:foo,bar" will allow users 'foo' and 'bar' to access the printer but NOT 'root'. | |
140 | <dt><b>-v "</b><i>device-uri</i><b>"</b> | |
141 | <dd style="margin-left: 5.0em">Sets the <i>device-uri</i> attribute of the printer queue. | |
142 | Use the <i>-v</i> option with the | |
143 | <a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8)</a> | |
144 | command to get a list of supported device URIs and schemes. | |
145 | <dt><b>-D "</b><i>info</i><b>"</b> | |
146 | <dd style="margin-left: 5.0em">Provides a textual description of the destination. | |
147 | <dt><b>-E</b> | |
148 | <dd style="margin-left: 5.0em">Enables the destination and accepts jobs; this is the same as running the | |
149 | <a href="man-cupsaccept.html?TOPIC=Man+Pages"><b>cupsaccept</b>(8)</a> | |
150 | and | |
151 | <a href="man-cupsenable.html?TOPIC=Man+Pages"><b>cupsenable</b>(8)</a> | |
152 | programs on the destination. | |
153 | <dt><b>-L "</b><i>location</i><b>"</b> | |
154 | <dd style="margin-left: 5.0em">Provides a textual location of the destination. | |
155 | </dl> | |
156 | <h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2> | |
157 | Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", or "#". | |
158 | Also, printer and class names are <i>not</i> case-sensitive. | |
159 | Finally, the CUPS version of <b>lpadmin</b> may ask the user for an access password depending on the printing system configuration. | |
160 | This differs from the System V version which requires the root user to execute this command. | |
161 | <h2 class="title"><a name="NOTES">Notes</a></h2> | |
162 | The CUPS version of <b>lpadmin</b> does not support all of the System V or Solaris printing system configuration options. | |
163 | <h2 class="title"><a name="EXAMPLE">Example</a></h2> | |
164 | Create an IPP Everywhere print queue: | |
165 | <pre class="man"> | |
166 | ||
167 | lpadmin -p myprinter -E -v ipp://myprinter.local/ipp/print -m everywhere | |
168 | ||
169 | </pre> | |
170 | <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> | |
171 | <a href="man-cupsaccept.html?TOPIC=Man+Pages"><b>cupsaccept</b>(8),</a> | |
172 | <a href="man-cupsenable.html?TOPIC=Man+Pages"><b>cupsenable</b>(8),</a> | |
173 | <a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8),</a> | |
174 | <a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1),</a> | |
175 | CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) | |
176 | <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> | |
177 | Copyright © 2007-2017 by Apple Inc. | |
178 | ||
179 | </body> | |
180 | </html> |