]> git.ipfire.org Git - thirdparty/cups.git/blame_incremental - doc/help/man-lp.html
Add common options to lp/lpr man pages (Issue #4794)
[thirdparty/cups.git] / doc / help / man-lp.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>lp(1)</title>
7</head>
8<body>
9<h1 class="title">lp(1)</h1>
10<h2 class="title"><a name="NAME">Name</a></h2>
11lp - print files
12<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
13<b>lp</b>
14[
15<b>-E</b>
16] [
17<b>-U</b>
18<i>username</i>
19] [
20<b>-c</b>
21] [
22<b>-d </b><i>destination</i>[<b>/</b><i>instance</i>]
23] [
24<b>-h </b><i>hostname</i>[<b>:</b><i>port</i>]
25] [
26<b>-m</b>
27] [
28<b>-n</b>
29<i>num-copies</i>
30] [
31<b>-o </b><i>option</i>[<b>=</b><i>value</i>]
32] [
33<b>-q</b>
34<i>priority</i>
35] [
36<b>-s</b>
37] [
38<b>-t</b>
39<i>title</i>
40] [
41<b>-H</b>
42<i>handling</i>
43] [
44<b>-P</b>
45<i>page-list</i>
46] [
47<b>--</b>
48] [
49<i>file(s)</i>
50]
51<br>
52<b>lp</b>
53[
54<b>-E</b>
55] [
56<b>-U</b>
57<i>username</i>
58] [
59<b>-c</b>
60] [
61<b>-h </b><i>hostname</i>[<b>:</b><i>port</i>]
62] [
63<b>-i</b>
64<i>job-id</i>
65] [
66<b>-n</b>
67<i>num-copies</i>
68] [
69<b>-o </b><i>option</i>[<b>=</b><i>value</i>]
70] [
71<b>-q</b>
72<i>priority</i>
73] [
74<b>-t</b>
75<i>title</i>
76] [
77<b>-H</b>
78<i>handling</i>
79] [
80<b>-P</b>
81<i>page-list</i>
82]
83<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
84<b>lp</b> submits files for printing or alters a pending job.
85Use a filename of "-" to force printing from the standard input.
86<h3><a name="THE_DEFAULT_DESTINATION">The Default Destination</a></h3>
87CUPS provides many ways to set the default destination. The <b>LPDEST</b> and <b>PRINTER</b> environment variables are consulted first.
88If neither are set, the current default set using the
89<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a>
90command is used, followed by the default set using the
91<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8)</a>
92command.
93<h2 class="title"><a name="OPTIONS">Options</a></h2>
94The following options are recognized by <i>lp</i>:
95<dl class="man">
96<dt><b>--</b>
97<dd style="margin-left: 5.0em">Marks the end of options; use this to print a file whose name begins with a dash (-).
98<dt><b>-E</b>
99<dd style="margin-left: 5.0em">Forces encryption when connecting to the server.
100<dt><b>-U </b><i>username</i>
101<dd style="margin-left: 5.0em">Specifies the username to use when connecting to the server.
102<dt><b>-c</b>
103<dd style="margin-left: 5.0em">This option is provided for backwards-compatibility only. On systems that support it, this option forces the print file to be copied to the spool directory before printing.
104In CUPS, print files are always sent to the scheduler via IPP which has the same effect.
105<dt><b>-d </b><i>destination</i>
106<dd style="margin-left: 5.0em">Prints files to the named printer.
107<dt><b>-h </b><i>hostname</i>[<b>:</b><i>port</i>]
108<dd style="margin-left: 5.0em">Chooses an alternate server.
109<dt><b>-i </b><i>job-id</i>
110<dd style="margin-left: 5.0em">Specifies an existing job to modify.
111<dt><b>-m</b>
112<dd style="margin-left: 5.0em">Sends an email when the job is completed.
113<dt><b>-n </b><i>copies</i>
114<dd style="margin-left: 5.0em">Sets the number of copies to print.
115<dt><b>-o "</b><i>name</i><b>=</b><i>value </i>[ ... <i>name</i><b>=</b><i>value </i>]<b>"</b>
116<dd style="margin-left: 5.0em">Sets one or more job options.
117<dt><b>-q </b><i>priority</i>
118<dd style="margin-left: 5.0em">Sets the job priority from 1 (lowest) to 100 (highest).
119The default priority is 50.
120<dt><b>-s</b>
121<dd style="margin-left: 5.0em">Do not report the resulting job IDs (silent mode.)
122<dt><b>-t "</b><i>name</i><b>"</b>
123<dd style="margin-left: 5.0em">Sets the job name.
124<dt><b>-H </b><i>hh:mm</i>
125<dd style="margin-left: 5.0em"><dt><b>-H hold</b>
126<dd style="margin-left: 5.0em"><dt><b>-H immediate</b>
127<dd style="margin-left: 5.0em"><dt><b>-H restart</b>
128<dd style="margin-left: 5.0em"><dt><b>-H resume</b>
129<dd style="margin-left: 5.0em">Specifies when the job should be printed.
130A value of <i>immediate</i> will print the file immediately, a value of <i>hold</i> will hold the job indefinitely, and a UTC time value (HH:MM) will hold the job until the specified UTC (not local) time.
131Use a value of <i>resume</i> with the <i>-i</i> option to resume a held job.
132Use a value of <i>restart</i> with the <i>-i</i> option to restart a completed job.
133<dt><b>-P </b><i>page-list</i>
134<dd style="margin-left: 5.0em">Specifies which pages to print in the document.
135The list can contain a list of numbers and ranges (#-#) separated by commas, e.g., "1,3-5,16".
136The page numbers refer to the output pages and not the document's original pages - options like "number-up" can affect the numbering of the pages.
137</dl>
138<h3><a name="COMMON_JOB_OPTIONS">Common Job Options</a></h3>
139Aside from the printer-specific options reported by the
140<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a>
141command, the following generic options are available:
142<dl class="man">
143<dt><b>-o media=</b><i>size</i>
144<dd style="margin-left: 5.0em">Sets the page size to <i>size</i>. Most printers support at least the size names "a4", "letter", and "legal".
145<dt><b>-o orientation-requested=4</b>
146<dd style="margin-left: 5.0em">Prints the job in landscape (rotated 90 degrees).
147<dt><b>-o sides=one-sided</b>
148<dd style="margin-left: 5.0em">Prints on one side of the paper.
149<dt><b>-o sides=two-sided-long-edge</b>
150<dd style="margin-left: 5.0em">Prints on both sides of the paper for portrait output.
151<dt><b>-o sides=two-sided-short-edge</b>
152<dd style="margin-left: 5.0em">Prints on both sides of the paper for landscape output.
153<dt><b>-o fit-to-page</b>
154<dd style="margin-left: 5.0em">Scales the print file to fit on the page.
155<dt><b>-o number-up=</b>{<i>2|4|6|9|16</i>}
156<dd style="margin-left: 5.0em">Prints 2, 4, 6, 9, or 16 document (input) pages on each output page.
157</dl>
158<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
159Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", or "#".
160Also, printer and class names are <i>not</i> case-sensitive.
161<p>The <i>-q</i> option accepts a different range of values than the Solaris lp command, matching the IPP job priority values (1-100, 100 is highest priority) instead of the Solaris values (0-39, 0 is highest priority).
162<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
163Print two copies of a document to the default printer:
164<pre class="man">
165
166 lp -n 2 filename
167
168</pre>
169Print a double-sided legal document to a printer called "foo":
170<pre class="man">
171
172 lp -d foo -o media=legal -o sides=two-sided-long-edge filename
173
174</pre>
175Print a presentation document 2-up to a printer called "foo":
176<pre class="man">
177
178 lp -d foo -o number-up=2 filename
179</pre>
180<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
181<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a>
182<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a>
183<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1),</a>
184<a href="man-lpq.html?TOPIC=Man+Pages"><b>lpq</b>(1),</a>
185<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a>
186<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a>
187<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a>
188CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
189<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
190Copyright &copy; 2007-2015 by Apple Inc.
191
192</body>
193</html>