Don't provide human-readable log message.
[thirdparty/cups.git] / doc / help / man-lp.html
CommitLineData
94436c5a
MS
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
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
14</b>[ -E ] [ -U
15<i>username
16</i>] [ -c ] [ -d
17<i>destination[/instance]
18</i>] [ -h
19<i>hostname[:port]
20</i>] [ -m ] [ -n
21<i>num-copies
22</i>] [ -o
23<i>option[=value]
24</i>] [ -q
25<i>priority
26</i>] [ -s ] [ -t
27<i>title
28</i>] [ -H
29<i>handling
30</i>] [ -P
31<i>page-list
32</i>] [ -- ] [
33<i>file(s)
34</i>]
35<br>
36<b>lp
37</b>[ -E ] [ -U
38<i>username
39</i>] [ -c ] [ -h
40<i>hostname[:port]
41</i>] [ -i
42<i>job-id
43</i>] [ -n
44<i>num-copies
45</i>] [ -o
46<i>option[=value]
47</i>] [ -q
48<i>priority
49</i>] [ -t
50<i>title
51</i>] [ -H
52<i>handling
53</i>] [ -P
54<i>page-list
55</i>]
56<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
57<i>lp</i> submits files for printing or alters a pending job. Use
58a filename of "-" to force printing from the standard input.
59<h2 class="title"><a name="THE_DEFAULT_DESTINATION">The Default Destination</a></h2>
60CUPS provides many ways to set the default destination. The "LPDEST" and
61"PRINTER" environment variables are consulted first. If neither are set,
62the current default set using the <a href='man-lpoptions.html?TOPIC=Man+Pages'>lpoptions(1)</a> command is used,
63followed by the default set using the <a href='man-lpadmin.html?TOPIC=Man+Pages'>lpadmin(8)</a> command.
64<h2 class="title"><a name="OPTIONS">Options</a></h2>
65The following options are recognized by <i>lp</i>:
66<dl>
67<dt>--
68</dt>
69<dd></dd>
70<dd>Marks the end of options; use this to print a file whose name
71begins with a dash (-).
72</dd>
73<dt>-E
74</dt>
75<dd></dd>
76<dd>Forces encryption when connecting to the server.
77</dd>
78<dt>-U username
79</dt>
80<dd></dd>
81<dd>Specifies the username to use when connecting to the server.
82</dd>
83<dt>-c
84</dt>
85<dd></dd>
86<dd>This option is provided for backwards-compatibility only. On
87systems that support it, this option forces the print file to be
88copied to the spool directory before printing. In CUPS, print
89files are always sent to the scheduler via IPP which has the
90same effect.
91</dd>
92<dt>-d destination
93</dt>
94<dd></dd>
95<dd>Prints files to the named printer.
96</dd>
97<dt>-h hostname[:port]
98</dt>
99<dd></dd>
100<dd>Chooses an alternate server.
101</dd>
102<dt>-i job-id
103</dt>
104<dd></dd>
105<dd>Specifies an existing job to modify.
106</dd>
107<dt>-m
108</dt>
109<dd></dd>
110<dd>Sends an email when the job is completed.
111</dd>
112<dt>-n copies
113</dt>
114<dd></dd>
115<dd>Sets the number of copies to print from 1 to 100.
116</dd>
117<dt>-o "name=value [name=value ...]"
118</dt>
119<dd></dd>
120<dd>Sets one or more job options.
121</dd>
122<dt>-q priority
123</dt>
124<dd></dd>
125<dd>Sets the job priority from 1 (lowest) to 100 (highest). The
126default priority is 50.
127</dd>
128<dt>-s
129</dt>
130<dd></dd>
131<dd>Do not report the resulting job IDs (silent mode.)
132</dd>
133<dt>-t "name"
134</dt>
135<dd></dd>
136<dd>Sets the job name.
137</dd>
138<dt>-H hh:mm
139</dt>
140<dd></dd>
141<dt>-H hold
142</dt>
143<dd></dd>
144<dt>-H immediate
145</dt>
146<dd></dd>
147<dt>-H restart
148</dt>
149<dd></dd>
150<dt>-H resume
151</dt>
152<dd></dd>
153<dd>Specifies when the job should be printed. A value of <i>immediate</i> will print
154the file immediately, a value of <i>hold</i> will hold the job indefinitely, and
155a UTC time value (HH:MM) will hold the job until the specified UTC (not local)
156time. Use a value of <i>resume</i> with the <i>-i</i> option to resume a held job.
157Use a value of <i>restart</i> with the <i>-i</i> option to restart
158a completed job.
159</dd>
160<dt>-P page-list
161</dt>
162<dd></dd>
163<dd>Specifies which pages to print in the document. The list can
164contain a list of numbers and ranges (#-#) separated by commas
165(e.g. 1,3-5,16). The page numbers refer to the output pages and
166not the document's original pages - options like "number-up" can
167affect the numbering of the pages.
168</dd>
169</dl>
170<h2 class="title"><a name="COMMON_JOB_OPTIONS">Common Job Options</a></h2>
171Aside from the printer-specific options reported by the
172<a href='man-lpoptions.html?TOPIC=Man+Pages'>lpoptions(1)</a> command, the following generic options are
173available:
174<dl>
175<dt>-o media=size
176</dt>
177<dd></dd>
178<dd>Sets the page size to <i>size</i>. Most printers support at least
179the size names "a4", "letter", and "legal".
180</dd>
181<dt>-o landscape
182</dt>
183<dd></dd>
184<dt>-o orientation-requested=4
185</dt>
186<dd></dd>
187<dd>Prints the job in landscape (rotated 90 degrees).
188</dd>
189<dt>-o sides=one-sided
190</dt>
191<dd></dd>
192<dt>-o sides=two-sided-long-edge
193</dt>
194<dd></dd>
195<dt>-o sides=two-sided-short-edge
196</dt>
197<dd></dd>
198<dd>Prints on one or two sides of the paper. The value
199"two-sided-long-edge" is normally used when printing portrait
200(unrotated) pages, while "two-sided-short-edge" is used for
201landscape pages.
202</dd>
203<dt>-o fit-to-page
204</dt>
205<dd></dd>
206<dd>Scales the print file to fit on the page.
207</dd>
208<dt>-o number-up=2
209</dt>
210<dd></dd>
211<dt>-o number-up=4
212</dt>
213<dd></dd>
214<dt>-o number-up=6
215</dt>
216<dd></dd>
217<dt>-o number-up=9
218</dt>
219<dd></dd>
220<dt>-o number-up=16
221</dt>
222<dd></dd>
223<dd>Prints multiple document pages on each output page.
224</dd>
225<dt>-o cpi=N
226</dt>
227<dd></dd>
228<dd>Sets the number of characters per inch to use when printing a
229text file. The default is 10.
230</dd>
231<dt>-o lpi=N
232</dt>
233<dd></dd>
234<dd>Sets the number of lines per inch to use when printing a text
235file. The default is 6.
236</dd>
237<dt>-o page-bottom=N
238</dt>
239<dd></dd>
240<dt>-o page-left=N
241</dt>
242<dd></dd>
243<dt>-o page-right=N
244</dt>
245<dd></dd>
246<dt>-o page-top=N
247</dt>
248<dd></dd>
249<dd>Sets the page margins when printing text files. The values are in
250points - there are 72 points to the inch.
251</dd>
252</dl>
253<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
254Print a double-sided legal document to a printer called "foo":
255<pre>
256 lp -d foo -o media=legal -o sides=two-sided-long-edge filename
257</pre>
258<p>Print an image across 4 pages:
259<pre>
260 lp -d bar -o scaling=200 filename
261</pre>
262<p>Print a text file with 12 characters per inch, 8 lines per inch, and
263a 1 inch left margin:
264<pre>
265 lp -d bar -o cpi=12 -o lpi=8 -o page-left=72 filename
266</pre>
267<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
268Unlike the System V printing system, CUPS allows printer names to
269contain any printable character except SPACE, TAB, "/", or "#".
270Also, printer and class names are <i>not</i> case-sensitive.
271<p>The "q" option accepts a different range of values than the
272Solaris lp command, matching the IPP job priority values (1-100,
273100 is highest priority) instead of the Solaris values (0-39, 0
274is highest priority).
275<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
276<a href='man-cancel.html?TOPIC=Man+Pages'>cancel(1)</a>, <a href='man-lpadmin.html?TOPIC=Man+Pages'>lpadmin(8)</a>, <a href='man-lpmove.html?TOPIC=Man+Pages'>lpmove(8)</a>, <a href='man-lpoptions.html?TOPIC=Man+Pages'>lpoptions(1)</a>,
277<a href='man-lpstat.html?TOPIC=Man+Pages'>lpstat(1)</a>,
278<br>
279<a href='http://localhost:631/help'>http://localhost:631/help</a>
280<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
281Copyright 2007-2013 by Apple Inc.
282
283</body>
284</html>