]> 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
Greatly simplify the man page handling.
[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<b>lp</b>(1)
60or
61<b>lpr</b>(1)
62commands will use this destination unless the user specifies otherwise with the
63<b>lpoptions</b>(1)
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>-m </b><i>model</i>
75<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.
76Use the <i>-m</i> option with the
77<b>lpinfo</b>(8)
78command to get a list of supported models.
79The model "raw" clears any existing PPD file and the model "everywhere" queries the printer referred to by the specified IPP <i>device-uri</i>.
80Note: Models other than "everywhere" are deprecated and will not be supported in a future version of CUPS.
81<dt><b>-o cupsIPPSupplies=true</b>
82<dd style="margin-left: 5.0em"><dt><b>-o cupsIPPSupplies=false</b>
83<dd style="margin-left: 5.0em">Specifies whether IPP supply level values should be reported.
84<dt><b>-o cupsSNMPSupplies=true</b>
85<dd style="margin-left: 5.0em"><dt><b>-o cupsSNMPSupplies=false</b>
86<dd style="margin-left: 5.0em">Specifies whether SNMP supply level (RFC 3805) values should be reported.
87<dt><b>-o job-k-limit=</b><i>value</i>
88<dd style="margin-left: 5.0em">Sets the kilobyte limit for per-user quotas.
89The value is an integer number of kilobytes; one kilobyte is 1024 bytes.
90<dt><b>-o job-page-limit=</b><i>value</i>
91<dd style="margin-left: 5.0em">Sets the page limit for per-user quotas.
92The value is the integer number of pages that can be printed; double-sided pages are counted as two pages.
93<dt><b>-o job-quota-period=</b><i>value</i>
94<dd style="margin-left: 5.0em">Sets the accounting period for per-user quotas.
95The value is an integer number of seconds; 86,400 seconds are in one day.
96<dt><b>-o job-sheets-default=</b><i>banner</i>
97<dd style="margin-left: 5.0em"><dt><b>-o job-sheets-default=</b><i>banner</i><b>,</b><i>banner</i>
98<dd style="margin-left: 5.0em">Sets the default banner page(s) to use for print jobs.
99<dt><b>-o </b><i>name</i><b>=</b><i>value</i>
100<dd style="margin-left: 5.0em">Sets a PPD option for the printer.
101PPD options can be listed using the <i>-l</i> option with the
102<b>lpoptions</b>(1)
103command.
104<dt><b>-o </b><i>name</i><b>-default=</b><i>value</i>
105<dd style="margin-left: 5.0em">Sets a default server-side option for the destination.
106Any print-time option can be defaulted, e.g., "-o number-up-default=2" to set the default "number-up" option value to 2.
107<dt><b>-o port-monitor=</b><i>name</i>
108<dd style="margin-left: 5.0em">Sets the binary communications program to use when printing, "none", "bcp", or "tbcp".
109The default program is "none".
110The specified port monitor must be listed in the printer's PPD file.
111<dt><b>-o printer-error-policy=</b><i>name</i>
112<dd style="margin-left: 5.0em">Sets the policy for errors such as printers that cannot be found or accessed, don't support the format being printed, fail during submission of the print data, or cause one or more filters to crash.
113The name must be one of "abort-job" (abort the job on error), "retry-job" (retry the job at a future time), "retry-current-job" (retry the current job immediately), or "stop-printer" (stop the printer on error).
114The default error policy is "stop-printer" for printers and "retry-current-job" for
115classes.
116<dt><b>-o printer-is-shared=true</b>
117<dd style="margin-left: 5.0em"><dt><b>-o printer-is-shared=false</b>
118<dd style="margin-left: 5.0em">Sets the destination to shared/published or unshared/unpublished.
119Shared/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.
120The default value is "true".
121<dt><b>-o printer-op-policy=</b><i>name</i>
122<dd style="margin-left: 5.0em">Sets the IPP operation policy associated with the destination.
123The name must be defined in the <i>cupsd.conf</i> in a Policy section.
124The default operation policy is "default".
125<dt><b>-R </b><i>name</i><b>-default</b>
126<dd style="margin-left: 5.0em">Deletes the named option from <i>printer</i>.
127<dt><b>-r </b><i>class</i>
128<dd style="margin-left: 5.0em">Removes the named <i>printer</i> from <i>class</i>.
129If the resulting class becomes empty it is removed.
130<dt><b>-u allow:</b>{<i>user</i>|<b>@</b><i>group</i>}{<b>,</b><i>user</i>|<b>,@</b><i>group</i>}*
131<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>}*
132<dd style="margin-left: 5.0em"><dt><b>-u allow:all</b>
133<dd style="margin-left: 5.0em"><dt><b>-u deny:none</b>
134<dd style="margin-left: 5.0em">Sets user-level access control on a destination.
135Names starting with "@" are interpreted as UNIX groups.
136The latter two forms turn user-level access control off.
137Note: 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'.
138<dt><b>-v "</b><i>device-uri</i><b>"</b>
139<dd style="margin-left: 5.0em">Sets the <i>device-uri</i> attribute of the printer queue.
140Use the <i>-v</i> option with the
141<b>lpinfo</b>(8)
142command to get a list of supported device URIs and schemes.
143<dt><b>-D "</b><i>info</i><b>"</b>
144<dd style="margin-left: 5.0em">Provides a textual description of the destination.
145<dt><b>-E</b>
146<dd style="margin-left: 5.0em">When specified before the <b>-d</b>, <b>-p</b>, or <b>-x</b> options, forces the use of TLS encryption on the connection to the scheduler.
147Otherwise, enables the destination and accepts jobs; this is the same as running the
148<b>cupsaccept</b>(8)
149and
150<b>cupsenable</b>(8)
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.
160Note: Interface scripts are not supported by CUPS.
161PPD files and printer drivers are deprecated and will not be supported in a future version of CUPS.
162<dt><b>-P </b><i>ppd-file</i>
163<dd style="margin-left: 5.0em">Specifies a PostScript Printer Description (PPD) file to use with the printer.
164Note: PPD files and printer drivers are deprecated and will not be supported in a future version of CUPS.
165</dl>
166<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
167Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", or "#".
168Also, printer and class names are <i>not</i> case-sensitive.
169<p>Finally, the CUPS version of <b>lpadmin</b> may ask the user for an access password depending on the printing system configuration.
170This differs from the System V version which requires the root user to execute this command.
171<h2 class="title"><a name="NOTES">Notes</a></h2>
172CUPS printer drivers and backends are deprecated and will no longer be supported in a future feature release of CUPS.
173Printers that do not support IPP can be supported using applications such as
174<b>ippeveprinter</b>(1).
175<p>The CUPS version of <b>lpadmin</b> does not support all of the System V or Solaris printing system configuration options.
176<p>Interface scripts are not supported for security reasons.
177<p>The double meaning of the <b>-E</b> option is an unfortunate historical oddity.
178<p>The <b>lpadmin</b> command communicates with the scheduler (<b>cupsd</b>) to make changes to the printing system configuration.
179This configuration information is stored in several files including <i>printers.conf</i> and <i>classes.conf</i>.
180These files should not be edited directly and are an implementation detail of CUPS that is subject to change at any time.
181<h2 class="title"><a name="EXAMPLE">Example</a></h2>
182Create an IPP Everywhere print queue:
183<pre class="man">
184
185 lpadmin -p myprinter -E -v ipp://myprinter.local/ipp/print -m everywhere
186
187</pre>
188<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
189<b>cupsaccept</b>(8),
190<b>cupsenable</b>(8),
191<b>lpinfo</b>(8),
192<b>lpoptions</b>(1),
193CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
194<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
195Copyright &copy; 2007-2019 by Apple Inc.
196
197</body>
198</html>
Unnamed repository; edit this file 'description' to name the repository.