Skip to content

Commit

Permalink
More man page updates.
Browse files Browse the repository at this point in the history 
git-svn-id: svn+ssh://src.apple.com/svn/cups/cups.org/trunk@11922 a1ca3aef-8c08-0410-bb20-df032aa958be
  • Loading branch information
msweet committed Jun 11, 2014
1 parent 0d1da74 commit cfa19b5
Show file tree
Hide file tree
Showing 6 changed files with 769 additions and 793 deletions.
301 changes: 142 additions & 159 deletions doc/help/man-lp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,200 +11,183 @@ <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
[
<b>-E</b>
] [
<b>-U</b>
<i>username</i>
] [ -c ] [ -d
<i>destination[/instance]</i>
] [ -h
<i>hostname[:port]</i>
] [ -m ] [ -n
] [
<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>
] [ -o
<i>option[=value]</i>
] [ -q
] [
<b>-o </b><i>option</i>[<b>=</b><i>value</i>]
] [
<b>-q</b>
<i>priority</i>
] [ -s ] [ -t
] [
<b>-s</b>
] [
<b>-t</b>
<i>title</i>
] [ -H
] [
<b>-H</b>
<i>handling</i>
] [ -P
] [
<b>-P</b>
<i>page-list</i>
] [ -- ] [
] [
<b>--</b>
] [
<i>file(s)</i>
]
<br>
<b>lp</b>
[ -E ] [ -U
[
<b>-E</b>
] [
<b>-U</b>
<i>username</i>
] [ -c ] [ -h
<i>hostname[:port]</i>
] [ -i
] [
<b>-c</b>
] [
<b>-h </b><i>hostname</i>[<b>:</b><i>port</i>]
] [
<b>-i</b>
<i>job-id</i>
] [ -n
] [
<b>-n</b>
<i>num-copies</i>
] [ -o
<i>option[=value]</i>
] [ -q
] [
<b>-o </b><i>option</i>[<b>=</b><i>value</i>]
] [
<b>-q</b>
<i>priority</i>
] [ -t
] [
<b>-t</b>
<i>title</i>
] [ -H
] [
<b>-H</b>
<i>handling</i>
] [ -P
] [
<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 <i>lpoptions(1)</i> command is used,
followed by the default set using the <i>lpadmin(8)</i> 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 class="man">
<dt>--
<dd style="margin-left: 5.0em"><br>
Marks the end of options; use this to print a file whose name
begins with a dash (-).
<dt>-E
<dd style="margin-left: 5.0em"><br>
Forces encryption when connecting to the server.
<dt>-U username
<dd style="margin-left: 5.0em"><br>
Specifies the username to use when connecting to the server.
<dt>-c
<dd style="margin-left: 5.0em"><br>
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>-d destination
<dd style="margin-left: 5.0em"><br>
Prints files to the named printer.
<dt>-h hostname[:port]
<dd style="margin-left: 5.0em"><br>
Chooses an alternate server.
<dt>-i job-id
<dd style="margin-left: 5.0em"><br>
Specifies an existing job to modify.
<dt>-m
<dd style="margin-left: 5.0em"><br>
Sends an email when the job is completed.
<dt>-n copies
<dd style="margin-left: 5.0em"><br>
Sets the number of copies to print from 1 to 100.
<dt>-o "name=value [name=value ...]"
<dd style="margin-left: 5.0em"><br>
Sets one or more job options.
<dt>-q priority
<dd style="margin-left: 5.0em"><br>
Sets the job priority from 1 (lowest) to 100 (highest). The
default priority is 50.
<dt>-s
<dd style="margin-left: 5.0em"><br>
Do not report the resulting job IDs (silent mode.)
<dt>-t "name"
<dd style="margin-left: 5.0em"><br>
Sets the job name.
<dt>-H hh:mm
<dd style="margin-left: 5.0em"><dt>-H hold
<dd style="margin-left: 5.0em"><dt>-H immediate
<dd style="margin-left: 5.0em"><dt>-H restart
<dd style="margin-left: 5.0em"><dt>-H resume
<dd style="margin-left: 5.0em"><br>
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>-P page-list
<dd style="margin-left: 5.0em"><br>
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.
<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
<i>lpoptions(1)</i> command, the following generic options are
available:
<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a>
command, the following generic options are available:
<dl class="man">
<dt>-o media=size
<dd style="margin-left: 5.0em"><br>
Sets the page size to <i>size</i>. Most printers support at least
the size names "a4", "letter", and "legal".
<dt>-o landscape
<dd style="margin-left: 5.0em"><dt>-o orientation-requested=4
<dd style="margin-left: 5.0em"><br>
Prints the job in landscape (rotated 90 degrees).
<dt>-o sides=one-sided
<dd style="margin-left: 5.0em"><dt>-o sides=two-sided-long-edge
<dd style="margin-left: 5.0em"><dt>-o sides=two-sided-short-edge
<dd style="margin-left: 5.0em"><br>
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.
<dt>-o fit-to-page
<dd style="margin-left: 5.0em"><br>
Scales the print file to fit on the page.
<dt>-o number-up=2
<dd style="margin-left: 5.0em"><dt>-o number-up=4
<dd style="margin-left: 5.0em"><dt>-o number-up=6
<dd style="margin-left: 5.0em"><dt>-o number-up=9
<dd style="margin-left: 5.0em"><dt>-o number-up=16
<dd style="margin-left: 5.0em"><br>
Prints multiple document pages on each output page.
<dt>-o cpi=N
<dd style="margin-left: 5.0em"><br>
Sets the number of characters per inch to use when printing a
text file. The default is 10.
<dt>-o lpi=N
<dd style="margin-left: 5.0em"><br>
Sets the number of lines per inch to use when printing a text
file. The default is 6.
<dt>-o page-bottom=N
<dd style="margin-left: 5.0em"><dt>-o page-left=N
<dd style="margin-left: 5.0em"><dt>-o page-right=N
<dd style="margin-left: 5.0em"><dt>-o page-top=N
<dd style="margin-left: 5.0em"><br>
Sets the page margins when printing text files. The values are in
points - there are 72 points to the inch.
<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 a double-sided legal document to a printer called "foo":
Print two copies of a document to the default printer:
<pre class="man">
lp -d foo -o media=legal -o sides=two-sided-long-edge filename

lp -n 2 filename

</pre>
<p>Print an image across 4 pages:
Print a double-sided legal document to a printer called "foo":
<pre class="man">
lp -d bar -o scaling=200 filename

lp -d foo -o media=legal -o sides=two-sided-long-edge filename

</pre>
<p>Print a text file with 12 characters per inch, 8 lines per inch, and
a 1 inch left margin:
Print a presentation document 2-up to a printer called "foo":
<pre class="man">
lp -d bar -o cpi=12 -o lpi=8 -o page-left=72 filename

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>
<i>cancel(1)</i>, <i>lpadmin(8)</i>, <i>lpmove(8)</i>, <i>lpoptions(1)</i>,
<i>lpstat(1)</i>,
<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-2014 by Apple Inc.

</body>
</html>
Loading

0 comments on commit cfa19b5

Please sign in to comment.