]> git.ipfire.org Git - thirdparty/cups.git/blame_incremental - doc/help/man-lpadmin.html
projects / thirdparty / cups.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Fix man page typos.
[thirdparty/cups.git] / doc / help / man-lpadmin.html
... / ...
CommitLineData
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>
11lpadmin - 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.
55It 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>.
58Subsequent print jobs submitted via the
59<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1)</a>
60or
61<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1)</a>
62commands 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>
64command.
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>.
67Any 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>
69The 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>.
73If <i>class</i> does not exist it is created automatically.
74<dt><b>-P </b><i>ppd-file</i>
75<dd style="margin-left: 5.0em">Specifies a PostScript Printer Description (PPD) file to use with the printer.
76<dt><b>-m </b><i>model</i>
77<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.
78Use the <i>-m</i> option with the
79<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8)</a>
80command to get a list of supported models.
81The model "raw" clears any existing PPD file and the model "everywhere" queries the printer referred to by the specified IPP <i>device-uri</i>.
82<dt><b>-o cupsIPPSupplies=true</b>
83<dd style="margin-left: 5.0em"><dt><b>-o cupsIPPSupplies=false</b>
84<dd style="margin-left: 5.0em">Specifies whether IPP supply level values should be reported.
85<dt><b>-o cupsSNMPSupplies=true</b>
86<dd style="margin-left: 5.0em"><dt><b>-o cupsSNMPSupplies=false</b>
87<dd style="margin-left: 5.0em">Specifies whether SNMP supply level (RFC 3805) values should be reported.
88<dt><b>-o job-k-limit=</b><i>value</i>
89<dd style="margin-left: 5.0em">Sets the kilobyte limit for per-user quotas.
90The value is an integer number of kilobytes; one kilobyte is 1024 bytes.
91<dt><b>-o job-page-limit=</b><i>value</i>
92<dd style="margin-left: 5.0em">Sets the page limit for per-user quotas.
93The value is the integer number of pages that can be printed; double-sided pages are counted as two pages.
94<dt><b>-o job-quota-period=</b><i>value</i>
95<dd style="margin-left: 5.0em">Sets the accounting period for per-user quotas.
96The value is an integer number of seconds; 86,400 seconds are in one day.
97<dt><b>-o job-sheets-default=</b><i>banner</i>
98<dd style="margin-left: 5.0em"><dt><b>-o job-sheets-default=</b><i>banner</i><b>,</b><i>banner</i>
99<dd style="margin-left: 5.0em">Sets the default banner page(s) to use for print jobs.
100<dt><b>-o </b><i>name</i><b>=</b><i>value</i>
101<dd style="margin-left: 5.0em">Sets a PPD option for the printer.
102PPD options can be listed using the <i>-l</i> option with the
103<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a>
104command.
105<dt><b>-o </b><i>name</i><b>-default=</b><i>value</i>
106<dd style="margin-left: 5.0em">Sets a default server-side option for the destination.
107Any print-time option can be defaulted, e.g., "-o number-up-default=2" to set the default "number-up" option value to 2.
108<dt><b>-o port-monitor=</b><i>name</i>
109<dd style="margin-left: 5.0em">Sets the binary communications program to use when printing, "none", "bcp", or "tbcp".
110The default program is "none".
111The specified port monitor must be listed in the printer's PPD file.
112<dt><b>-o printer-error-policy=</b><i>name</i>
113<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.
114The name must be one of "abort-job", "retry-job", "retry-current-job", or "stop-printer".
115The default error policy is "stop-printer" for printers and "retry-current-job" for
116classes.
117<dt><b>-o printer-is-shared=true</b>
118<dd style="margin-left: 5.0em"><dt><b>-o printer-is-shared=false</b>
119<dd style="margin-left: 5.0em">Sets the destination to shared/published or unshared/unpublished.
120Shared/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.
121The default value is "true".
122<dt><b>-o printer-op-policy=</b><i>name</i>
123<dd style="margin-left: 5.0em">Sets the IPP operation policy associated with the destination.
124The name must be defined in the <i>cupsd.conf</i> in a Policy section.
125The default operation policy is "default".
126<dt><b>-R </b><i>name</i><b>-default</b>
127<dd style="margin-left: 5.0em">Deletes the named option from <i>printer</i>.
128<dt><b>-r </b><i>class</i>
129<dd style="margin-left: 5.0em">Removes the named <i>printer</i> from <i>class</i>.
130If the resulting class becomes empty it is removed.
131<dt><b>-u allow:</b>{<i>user</i>|<b>@</b><i>group</i>}{<b>,</b><i>user</i>|<b>,@</b><i>group</i>}*
132<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>}*
133<dd style="margin-left: 5.0em"><dt><b>-u allow:all</b>
134<dd style="margin-left: 5.0em"><dt><b>-u deny:none</b>
135<dd style="margin-left: 5.0em">Sets user-level access control on a destination.
136Names starting with "@" are interpreted as UNIX groups.
137The latter two forms turn user-level access control off.
138Note: 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'.
139<dt><b>-v "</b><i>device-uri</i><b>"</b>
140<dd style="margin-left: 5.0em">Sets the <i>device-uri</i> attribute of the printer queue.
141Use the <i>-v</i> option with the
142<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8)</a>
143command to get a list of supported device URIs and schemes.
144<dt><b>-D "</b><i>info</i><b>"</b>
145<dd style="margin-left: 5.0em">Provides a textual description of the destination.
146<dt><b>-E</b>
147<dd style="margin-left: 5.0em">Enables the destination and accepts jobs; this is the same as running the
148<a href="man-cupsaccept.html?TOPIC=Man+Pages"><b>cupsaccept</b>(8)</a>
149and
150<a href="man-cupsenable.html?TOPIC=Man+Pages"><b>cupsenable</b>(8)</a>
151programs on the destination.
152<dt><b>-L "</b><i>location</i><b>"</b>
153<dd style="margin-left: 5.0em">Provides a textual location of the destination.
154</dl>
155<h2 class="title"><a name="DEPRECATED_OPTIONS">Deprecated Options</a></h2>
156The following <b>lpadmin</b> options are deprecated:
157<dl class="man">
158<dt><b>-i </b><i>filename</i>
159<dd style="margin-left: 5.0em">This option historically has been used to provide either a System V interface script or (as an implementation side-effect) a PPD file.
160Since interface scripts are no longer supported, the <i>-P</i> option is preferred for providing a PPD file for a printer.
161</dl>
162<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
163Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", or "#".
164Also, printer and class names are <i>not</i> case-sensitive.
165Finally, the CUPS version of <b>lpadmin</b> may ask the user for an access password depending on the printing system configuration.
166This differs from the System V version which requires the root user to execute this command.
167<h2 class="title"><a name="NOTES">Notes</a></h2>
168The CUPS version of <b>lpadmin</b> does not support all of the System V or Solaris printing system configuration options.
169Interface scripts are not supported for security reasons.
170<h2 class="title"><a name="EXAMPLE">Example</a></h2>
171Create an IPP Everywhere print queue:
172<pre class="man">
173
174 lpadmin -p myprinter -E -v ipp://myprinter.local/ipp/print -m everywhere
175
176</pre>
177<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
178<a href="man-cupsaccept.html?TOPIC=Man+Pages"><b>cupsaccept</b>(8),</a>
179<a href="man-cupsenable.html?TOPIC=Man+Pages"><b>cupsenable</b>(8),</a>
180<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8),</a>
181<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1),</a>
182CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
183<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
184Copyright &copy; 2007-2017 by Apple Inc.
185
186</body>
187</html>
Unnamed repository; edit this file 'description' to name the repository.