]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - doc/help/man-lp.html
Add common options to lp/lpr man pages (Issue #4794)
[thirdparty/cups.git] / doc / help / man-lp.html
index aceb569e34551ae09fe0fc3e1e2dd391e951ced8..73d7c2d93767b4c75731c7f0af8c45e876c3c1a0 100644 (file)
@@ -1,4 +1,4 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE HTML>
 <html>
 <!-- SECTION: Man Pages -->
 <head>
 <h2 class="title"><a name="NAME">Name</a></h2>
 lp - print files
 <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
-<b>lp
-</b>[ -E ] [ -U
-<i>username
-</i>] [ -c ] [ -d
-<i>destination[/instance]
-</i>] [ -h
-<i>hostname[:port]
-</i>] [ -m ] [ -n
-<i>num-copies
-</i>] [ -o
-<i>option[=value]
-</i>] [ -q
-<i>priority
-</i>] [ -s ] [ -t
-<i>title
-</i>] [ -H
-<i>handling
-</i>] [ -P
-<i>page-list
-</i>] [ -- ] [
-<i>file(s)
-</i>]
+<b>lp</b>
+[
+<b>-E</b>
+] [
+<b>-U</b>
+<i>username</i>
+] [
+<b>-c</b>
+] [
+<b>-d </b><i>destination</i>[<b>/</b><i>instance</i>]
+] [
+<b>-h </b><i>hostname</i>[<b>:</b><i>port</i>]
+] [
+<b>-m</b>
+] [
+<b>-n</b>
+<i>num-copies</i>
+] [
+<b>-o </b><i>option</i>[<b>=</b><i>value</i>]
+] [
+<b>-q</b>
+<i>priority</i>
+] [
+<b>-s</b>
+] [
+<b>-t</b>
+<i>title</i>
+] [
+<b>-H</b>
+<i>handling</i>
+] [
+<b>-P</b>
+<i>page-list</i>
+] [
+<b>--</b>
+] [
+<i>file(s)</i>
+]
 <br>
-<b>lp
-</b>[ -E ] [ -U
-<i>username
-</i>] [ -c ] [ -h
-<i>hostname[:port]
-</i>] [ -i
-<i>job-id
-</i>] [ -n
-<i>num-copies
-</i>] [ -o
-<i>option[=value]
-</i>] [ -q
-<i>priority
-</i>] [ -t
-<i>title
-</i>] [ -H
-<i>handling
-</i>] [ -P
-<i>page-list
-</i>]
+<b>lp</b>
+[
+<b>-E</b>
+] [
+<b>-U</b>
+<i>username</i>
+] [
+<b>-c</b>
+] [
+<b>-h </b><i>hostname</i>[<b>:</b><i>port</i>]
+] [
+<b>-i</b>
+<i>job-id</i>
+] [
+<b>-n</b>
+<i>num-copies</i>
+] [
+<b>-o </b><i>option</i>[<b>=</b><i>value</i>]
+] [
+<b>-q</b>
+<i>priority</i>
+] [
+<b>-t</b>
+<i>title</i>
+] [
+<b>-H</b>
+<i>handling</i>
+] [
+<b>-P</b>
+<i>page-list</i>
+]
 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
-<i>lp</i> submits files for printing or alters a pending job. Use
-a filename of "-" to force printing from the standard input.
-<h2 class="title"><a name="THE_DEFAULT_DESTINATION">The Default Destination</a></h2>
-CUPS provides many ways to set the default destination. The "LPDEST" and
-"PRINTER" environment variables are consulted first. If neither are set,
-the current default set using the <a href='man-lpoptions.html?TOPIC=Man+Pages'>lpoptions(1)</a> command is used,
-followed by the default set using the <a href='man-lpadmin.html?TOPIC=Man+Pages'>lpadmin(8)</a> command.
+<b>lp</b> submits files for printing or alters a pending job.
+Use a filename of "-" to force printing from the standard input.
+<h3><a name="THE_DEFAULT_DESTINATION">The Default Destination</a></h3>
+CUPS provides many ways to set the default destination. The <b>LPDEST</b> and <b>PRINTER</b> environment variables are consulted first.
+If neither are set, the current default set using the
+<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a>
+command is used, followed by the default set using the
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8)</a>
+command.
 <h2 class="title"><a name="OPTIONS">Options</a></h2>
 The following options are recognized by <i>lp</i>:
-<dl>
-<dt>--
-</dt>
-<dd></dd>
-<dd>Marks the end of options; use this to print a file whose name
-begins with a dash (-).
-</dd>
-<dt>-E
-</dt>
-<dd></dd>
-<dd>Forces encryption when connecting to the server.
-</dd>
-<dt>-U username
-</dt>
-<dd></dd>
-<dd>Specifies the username to use when connecting to the server.
-</dd>
-<dt>-c
-</dt>
-<dd></dd>
-<dd>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. In CUPS, print
-files are always sent to the scheduler via IPP which has the
-same effect.
-</dd>
-<dt>-d destination
-</dt>
-<dd></dd>
-<dd>Prints files to the named printer.
-</dd>
-<dt>-h hostname[:port]
-</dt>
-<dd></dd>
-<dd>Chooses an alternate server.
-</dd>
-<dt>-i job-id
-</dt>
-<dd></dd>
-<dd>Specifies an existing job to modify.
-</dd>
-<dt>-m
-</dt>
-<dd></dd>
-<dd>Sends an email when the job is completed.
-</dd>
-<dt>-n copies
-</dt>
-<dd></dd>
-<dd>Sets the number of copies to print from 1 to 100.
-</dd>
-<dt>-o "name=value [name=value ...]"
-</dt>
-<dd></dd>
-<dd>Sets one or more job options.
-</dd>
-<dt>-q priority
-</dt>
-<dd></dd>
-<dd>Sets the job priority from 1 (lowest) to 100 (highest). The
-default priority is 50.
-</dd>
-<dt>-s
-</dt>
-<dd></dd>
-<dd>Do not report the resulting job IDs (silent mode.)
-</dd>
-<dt>-t "name"
-</dt>
-<dd></dd>
-<dd>Sets the job name.
-</dd>
-<dt>-H hh:mm
-</dt>
-<dd></dd>
-<dt>-H hold
-</dt>
-<dd></dd>
-<dt>-H immediate
-</dt>
-<dd></dd>
-<dt>-H restart
-</dt>
-<dd></dd>
-<dt>-H resume
-</dt>
-<dd></dd>
-<dd>Specifies when the job should be printed. A 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. Use a value of <i>resume</i> with the <i>-i</i> option to resume a held job.
-Use a value of <i>restart</i> with the <i>-i</i> option to restart
-a completed job.
-</dd>
-<dt>-P page-list
-</dt>
-<dd></dd>
-<dd>Specifies which pages to print in the document. The list can
-contain a list of numbers and ranges (#-#) separated by commas
-(e.g. 1,3-5,16). The 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.
-</dd>
+<dl class="man">
+<dt><b>--</b>
+<dd style="margin-left: 5.0em">Marks the end of options; use this to print a file whose name begins with a dash (-).
+<dt><b>-E</b>
+<dd style="margin-left: 5.0em">Forces encryption when connecting to the server.
+<dt><b>-U </b><i>username</i>
+<dd style="margin-left: 5.0em">Specifies the username to use when connecting to the server.
+<dt><b>-c</b>
+<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.
+In CUPS, print files are always sent to the scheduler via IPP which has the same effect.
+<dt><b>-d </b><i>destination</i>
+<dd style="margin-left: 5.0em">Prints files to the named printer.
+<dt><b>-h </b><i>hostname</i>[<b>:</b><i>port</i>]
+<dd style="margin-left: 5.0em">Chooses an alternate server.
+<dt><b>-i </b><i>job-id</i>
+<dd style="margin-left: 5.0em">Specifies an existing job to modify.
+<dt><b>-m</b>
+<dd style="margin-left: 5.0em">Sends an email when the job is completed.
+<dt><b>-n </b><i>copies</i>
+<dd style="margin-left: 5.0em">Sets the number of copies to print.
+<dt><b>-o "</b><i>name</i><b>=</b><i>value </i>[ ... <i>name</i><b>=</b><i>value </i>]<b>"</b>
+<dd style="margin-left: 5.0em">Sets one or more job options.
+<dt><b>-q </b><i>priority</i>
+<dd style="margin-left: 5.0em">Sets the job priority from 1 (lowest) to 100 (highest).
+The default priority is 50.
+<dt><b>-s</b>
+<dd style="margin-left: 5.0em">Do not report the resulting job IDs (silent mode.)
+<dt><b>-t "</b><i>name</i><b>"</b>
+<dd style="margin-left: 5.0em">Sets the job name.
+<dt><b>-H </b><i>hh:mm</i>
+<dd style="margin-left: 5.0em"><dt><b>-H hold</b>
+<dd style="margin-left: 5.0em"><dt><b>-H immediate</b>
+<dd style="margin-left: 5.0em"><dt><b>-H restart</b>
+<dd style="margin-left: 5.0em"><dt><b>-H resume</b>
+<dd style="margin-left: 5.0em">Specifies when the job should be printed.
+A 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.
+Use a value of <i>resume</i> with the <i>-i</i> option to resume a held job.
+Use a value of <i>restart</i> with the <i>-i</i> option to restart a completed job.
+<dt><b>-P </b><i>page-list</i>
+<dd style="margin-left: 5.0em">Specifies which pages to print in the document.
+The list can contain a list of numbers and ranges (#-#) separated by commas, e.g., "1,3-5,16".
+The 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.
 </dl>
-<h2 class="title"><a name="COMMON_JOB_OPTIONS">Common Job Options</a></h2>
+<h3><a name="COMMON_JOB_OPTIONS">Common Job Options</a></h3>
 Aside from the printer-specific options reported by the
-<a href='man-lpoptions.html?TOPIC=Man+Pages'>lpoptions(1)</a> command, the following generic options are
-available:
-<dl>
-<dt>-o media=size
-</dt>
-<dd></dd>
-<dd>Sets the page size to <i>size</i>. Most printers support at least
-the size names "a4", "letter", and "legal".
-</dd>
-<dt>-o landscape
-</dt>
-<dd></dd>
-<dt>-o orientation-requested=4
-</dt>
-<dd></dd>
-<dd>Prints the job in landscape (rotated 90 degrees).
-</dd>
-<dt>-o sides=one-sided
-</dt>
-<dd></dd>
-<dt>-o sides=two-sided-long-edge
-</dt>
-<dd></dd>
-<dt>-o sides=two-sided-short-edge
-</dt>
-<dd></dd>
-<dd>Prints on one or two sides of the paper. The value
-"two-sided-long-edge" is normally used when printing portrait
-(unrotated) pages, while "two-sided-short-edge" is used for
-landscape pages.
-</dd>
-<dt>-o fit-to-page
-</dt>
-<dd></dd>
-<dd>Scales the print file to fit on the page.
-</dd>
-<dt>-o number-up=2
-</dt>
-<dd></dd>
-<dt>-o number-up=4
-</dt>
-<dd></dd>
-<dt>-o number-up=6
-</dt>
-<dd></dd>
-<dt>-o number-up=9
-</dt>
-<dd></dd>
-<dt>-o number-up=16
-</dt>
-<dd></dd>
-<dd>Prints multiple document pages on each output page.
-</dd>
-<dt>-o cpi=N
-</dt>
-<dd></dd>
-<dd>Sets the number of characters per inch to use when printing a
-text file. The default is 10.
-</dd>
-<dt>-o lpi=N
-</dt>
-<dd></dd>
-<dd>Sets the number of lines per inch to use when printing a text
-file. The default is 6.
-</dd>
-<dt>-o page-bottom=N
-</dt>
-<dd></dd>
-<dt>-o page-left=N
-</dt>
-<dd></dd>
-<dt>-o page-right=N
-</dt>
-<dd></dd>
-<dt>-o page-top=N
-</dt>
-<dd></dd>
-<dd>Sets the page margins when printing text files. The values are in
-points - there are 72 points to the inch.
-</dd>
+<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a>
+command, the following generic options are available:
+<dl class="man">
+<dt><b>-o media=</b><i>size</i>
+<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".
+<dt><b>-o orientation-requested=4</b>
+<dd style="margin-left: 5.0em">Prints the job in landscape (rotated 90 degrees).
+<dt><b>-o sides=one-sided</b>
+<dd style="margin-left: 5.0em">Prints on one side of the paper.
+<dt><b>-o sides=two-sided-long-edge</b>
+<dd style="margin-left: 5.0em">Prints on both sides of the paper for portrait output.
+<dt><b>-o sides=two-sided-short-edge</b>
+<dd style="margin-left: 5.0em">Prints on both sides of the paper for landscape output.
+<dt><b>-o fit-to-page</b>
+<dd style="margin-left: 5.0em">Scales the print file to fit on the page.
+<dt><b>-o number-up=</b>{<i>2|4|6|9|16</i>}
+<dd style="margin-left: 5.0em">Prints 2, 4, 6, 9, or 16 document (input) pages on each output page.
 </dl>
+<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
+Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", or "#".
+Also, printer and class names are <i>not</i> case-sensitive.
+<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).
 <h2 class="title"><a name="EXAMPLES">Examples</a></h2>
+Print two copies of a document to the default printer:
+<pre class="man">
+
+    lp -n 2 filename
+
+</pre>
 Print a double-sided legal document to a printer called "foo":
-<pre>
+<pre class="man">
+
     lp -d foo -o media=legal -o sides=two-sided-long-edge filename
+
 </pre>
-<p>Print an image across 4 pages:
-<pre>
-    lp -d bar -o scaling=200 filename
-</pre>
-<p>Print a text file with 12 characters per inch, 8 lines per inch, and
-a 1 inch left margin:
-<pre>
-    lp -d bar -o cpi=12 -o lpi=8 -o page-left=72 filename
+Print a presentation document 2-up to a printer called "foo":
+<pre class="man">
+
+    lp -d foo -o number-up=2 filename
 </pre>
-<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
-Unlike the System V printing system, CUPS allows printer names to
-contain any printable character except SPACE, TAB, "/", or "#".
-Also, printer and class names are <i>not</i> case-sensitive.
-<p>The "q" 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).
 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<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>,
-<a href='man-lpstat.html?TOPIC=Man+Pages'>lpstat(1)</a>,
-<br>
-<a href='http://localhost:631/help'>http://localhost:631/help</a>
+<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a>
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a>
+<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1),</a>
+<a href="man-lpq.html?TOPIC=Man+Pages"><b>lpq</b>(1),</a>
+<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a>
+<a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a>
+<a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a>
+CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
-Copyright 2007-2013 by Apple Inc.
+Copyright &copy; 2007-2015 by Apple Inc.
 
 </body>
 </html>