diff options
-rw-r--r-- | doc/help/man-lp.html | 301 | ||||
-rw-r--r-- | doc/help/man-lpadmin.html | 290 | ||||
-rw-r--r-- | doc/help/man-lpr.html | 175 | ||||
-rw-r--r-- | man/lp.man | 316 | ||||
-rw-r--r-- | man/lpadmin.man | 301 | ||||
-rw-r--r-- | man/lpr.man | 179 |
6 files changed, 769 insertions, 793 deletions
diff --git a/doc/help/man-lp.html b/doc/help/man-lp.html index 7484763e9..0af3e0b53 100644 --- a/doc/help/man-lp.html +++ b/doc/help/man-lp.html @@ -11,200 +11,183 @@ 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 © 2007-2014 by Apple Inc. </body> </html> diff --git a/doc/help/man-lpadmin.html b/doc/help/man-lpadmin.html index c07d54f2b..1f8502991 100644 --- a/doc/help/man-lpadmin.html +++ b/doc/help/man-lpadmin.html @@ -11,180 +11,164 @@ lpadmin - configure cups printers and classes <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2> <b>lpadmin</b> -[ -E ] [-U +[ +<b>-E</b> +] [ +<b>-U</b> <i>username</i> -] [ -h -<i>server[:port]</i> -] -d +] [ +<b>-h </b><i>server</i>[<b>:</b><i>port</i>] +] +<b>-d</b> <i>destination</i> <br> <b>lpadmin</b> -[ -E ] [-U +[ +<b>-E</b> +] [ +<b>-U</b> <i>username</i> -] [ -h -<i>server[:port]</i> -] -p +] [ +<b>-h </b><i>server</i>[<b>:</b><i>port</i>] +] +<b>-p</b> <i>destination</i> -[ -R +[ +<b>-R</b> <i>name-default</i> ] <i>option(s)</i> <br> <b>lpadmin</b> -[ -E ] [-U +[ +<b>-E</b> +] [ +<b>-U</b> <i>username</i> -] [ -h -<i>server[:port]</i> -] -x +] [ +<b>-h </b><i>server</i>[<b>:</b><i>port</i>] +] +<b>-x</b> <i>destination</i> <h2 class="title"><a name="DESCRIPTION">Description</a></h2> -<i>lpadmin</i> configures printer and class queues provided by -CUPS. It can also be used to set the server default printer or -class. -<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. -<p>The first form of the command (<i>-d</i>) sets the default printer -or class to <i>destination</i>. Subsequent print jobs submitted -via the <i>lp(1)</i> or <i>lpr(1)</i> commands will use this -destination unless the user specifies otherwise with the -<i>lpoptions(1)</i> command. -<p>The second form of the command (<i>-p</i>) configures the named -printer or class. The additional options are described below. -<p>The third form of the command (<i>-x</i>) deletes the printer or -class <i>destination</i>. Any jobs that are pending for the -destination will be removed and any job that is currently printed -will be aborted. -<h2 class="title"><a name="CONFIGURATION_OPTIONS">Configuration Options</a></h2> -The following options are recognized when configuring a printer -queue: +<b>lpadmin</b> configures printer and class queues provided by CUPS. +It can also be used to set the server default printer or class. +<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. +<p>The first form of the command (<i>-d</i>) sets the default printer or class to <i>destination</i>. +Subsequent print jobs submitted via the +<a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1)</a> +or +<a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1)</a> +commands will use this destination unless the user specifies otherwise with the +<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a> +command. +<p>The second form of the command (<i>-p</i>) configures the named printer or class. The additional options are described below. +<p>The third form of the command (<i>-x</i>) deletes the printer or class <i>destination</i>. +Any jobs that are pending for the destination will be removed and any job that is currently printed will be aborted. +<h2 class="title"><a name="OPTIONS">Options</a></h2> +The following options are recognized when configuring a printer queue: <dl class="man"> -<dt>-c class -<dd style="margin-left: 5.0em"><br> -Adds the named <i>printer</i> to <i>class</i>. If <i>class</i> does -not exist it is created automatically. -<dt>-i interface -<dd style="margin-left: 5.0em"><br> -Sets a System V style interface script for the printer. This -option cannot be specified with the <i>-P</i> option (PPD file) -and is intended for providing support for legacy printer drivers. -<dt>-m model -<dd style="margin-left: 5.0em"><br> -Sets a standard System V interface script or PPD file for the printer from the -<i>model</i> directory or using one of the driver interfaces. Use the <i>-m</i> -option with the <i>lpinfo(8)</i> command to get a list of supported models. -<dt>-o cupsIPPSupplies=true -<dd style="margin-left: 5.0em"><dt>-o cupsIPPSupplies=false -<dd style="margin-left: 5.0em"><br> -Specifies whether IPP supply level values should be reported. -<dt>-o cupsSNMPSupplies=true -<dd style="margin-left: 5.0em"><dt>-o cupsSNMPSupplies=false -<dd style="margin-left: 5.0em"><br> -Specifies whether SNMP supply level (RFC 3805) values should be reported. -<dt>-o job-k-limit=value -<dd style="margin-left: 5.0em"><br> -Sets the kilobyte limit for per-user quotas. The value is an -integer number of kilobytes; one kilobyte is 1024 bytes. -<dt>-o job-page-limit=value -<dd style="margin-left: 5.0em"><br> -Sets the page limit for per-user quotas. The value is the integer -number of pages that can be printed; double-sided pages are -counted as two pages. -<dt>-o job-quota-period=value -<dd style="margin-left: 5.0em"><br> -Sets the accounting period for per-user quotas. The value is an -integer number of seconds; 86,400 seconds are in one day. -<dt>-o job-sheets-default=banner -<dd style="margin-left: 5.0em"><dt>-o job-sheets-default=banner,banner -<dd style="margin-left: 5.0em"><br> -Sets the default banner page(s) to use for print jobs. -<dt>-o name=value -<dd style="margin-left: 5.0em"><br> -Sets a PPD option for the printer. PPD options can be listed using the <i>-l</i> -option with the <i>lpoptions(1)</i> command. -<dt>-o name-default=value -<dd style="margin-left: 5.0em"><br> -Sets a default server-side option for the destination. Any print-time -option can be defaulted, e.g. "-o cpi-default=17" to set the default -"cpi" option value to 17. -<dt>-o port-monitor=name -<dd style="margin-left: 5.0em"><br> -Sets the binary communications program to use when printing, -"none", "bcp", or "tbcp". The default program is "none". The -specified port monitor must be listed in the printer's PPD file. -<dt>-o printer-error-policy=name -<dd style="margin-left: 5.0em"><br> -Sets the error policy to be used when the printer backend is -unable to send the job to the printer. The name must be one of -"abort-job", "retry-job", "retry-current-job", or "stop-printer". The default -error policy is "stop-printer" for printers and "retry-current-job" for +<dt><b>-c </b><i>class</i> +<dd style="margin-left: 5.0em">Adds the named <i>printer</i> to <i>class</i>. +If <i>class</i> does not exist it is created automatically. +<dt><b>-i </b><i>interface</i> +<dd style="margin-left: 5.0em">Sets a System V style interface script for the printer. +This option cannot be specified with the <i>-P</i> option (PPD file) and is intended for providing support for legacy printer drivers. +<dt><b>-m </b><i>model</i> +<dd style="margin-left: 5.0em">Sets a standard System V interface script or PPD file for the printer from the <i>model</i> directory or using one of the driver interfaces. +Use the <i>-m</i> option with the +<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8)</a> +command to get a list of supported models. +<dt><b>-o cupsIPPSupplies=true</b> +<dd style="margin-left: 5.0em"><dt><b>-o cupsIPPSupplies=false</b> +<dd style="margin-left: 5.0em">Specifies whether IPP supply level values should be reported. +<dt><b>-o cupsSNMPSupplies=true</b> +<dd style="margin-left: 5.0em"><dt><b>-o cupsSNMPSupplies=false</b> +<dd style="margin-left: 5.0em">Specifies whether SNMP supply level (RFC 3805) values should be reported. +<dt><b>-o job-k-limit=</b><i>value</i> +<dd style="margin-left: 5.0em">Sets the kilobyte limit for per-user quotas. +The value is an integer number of kilobytes; one kilobyte is 1024 bytes. +<dt><b>-o job-page-limit=</b><i>value</i> +<dd style="margin-left: 5.0em">Sets the page limit for per-user quotas. +The value is the integer number of pages that can be printed; double-sided pages are counted as two pages. +<dt><b>-o job-quota-period=</b><i>value</i> +<dd style="margin-left: 5.0em">Sets the accounting period for per-user quotas. +The value is an integer number of seconds; 86,400 seconds are in one day. +<dt><b>-o job-sheets-default=</b><i>banner</i> +<dd style="margin-left: 5.0em"><dt><b>-o job-sheets-default=</b><i>banner</i><b>,</b><i>banner</i> +<dd style="margin-left: 5.0em">Sets the default banner page(s) to use for print jobs. +<dt><b>-o </b><i>name</i><b>=</b><i>value</i> +<dd style="margin-left: 5.0em">Sets a PPD option for the printer. +PPD options can be listed using the <i>-l</i> option with the +<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1)</a> +command. +<dt><b>-o </b><i>name</i><b>-default=</b><i>value</i> +<dd style="margin-left: 5.0em">Sets a default server-side option for the destination. +Any print-time option can be defaulted, e.g., "-o number-up-default=2" to set the default "number-up" option value to 2. +<dt><b>-o port-monitor=</b><i>name</i> +<dd style="margin-left: 5.0em">Sets the binary communications program to use when printing, "none", "bcp", or "tbcp". +The default program is "none". +The specified port monitor must be listed in the printer's PPD file. +<dt><b>-o printer-error-policy=</b><i>name</i> +<dd style="margin-left: 5.0em">Sets the error policy to be used when the printer backend is unable to send the job to the printer. +The name must be one of "abort-job", "retry-job", "retry-current-job", or "stop-printer". +The default error policy is "stop-printer" for printers and "retry-current-job" for classes. -<dt>-o printer-is-shared=true/false -<dd style="margin-left: 5.0em"><br> -Sets the destination to shared/published or unshared/unpublished. -Shared/published destinations are publicly announced by the server -on the LAN based on the browsing configuration in -<b>cupsd.conf</b>, while unshared/unpublished destinations are not -announced. The default value is "true". -<dt>-o printer-op-policy=name -<dd style="margin-left: 5.0em"><br> -Sets the IPP operation policy associated with the destination. The -name must be defined in the <b>cupsd.conf</b> in a Policy section. +<dt><b>-o printer-is-shared=true</b> +<dd style="margin-left: 5.0em"><dt><b>-o printer-is-shared=false</b> +<dd style="margin-left: 5.0em">Sets the destination to shared/published or unshared/unpublished. +Shared/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. +The default value is "true". +<dt><b>-o printer-op-policy=</b><i>name</i> +<dd style="margin-left: 5.0em">Sets the IPP operation policy associated with the destination. +The name must be defined in the <i>cupsd.conf</i> in a Policy section. The default operation policy is "default". -<dt>-R name-default -<dd style="margin-left: 5.0em"><br> -Deletes the named option from <i>printer</i>. -<dt>-r class -<dd style="margin-left: 5.0em"><br> -Removes the named <i>printer</i> from <i>class</i>. If the -resulting class becomes empty it is removed. -<dt>-u allow:user,user,@group -<dd style="margin-left: 5.0em"><dt>-u deny:user,user,@group -<dd style="margin-left: 5.0em"><dt>-u allow:all -<dd style="margin-left: 5.0em"><dt>-u deny:none -<dd style="margin-left: 5.0em"><br> -Sets user-level access control on a destination. Names starting with -"@" are interpreted as UNIX groups. The latter two forms turn -user-level access control off. -<dt>-v "device-uri" -<dd style="margin-left: 5.0em"><br> -Sets the <i>device-uri</i> attribute of the printer queue. Use the <i>-v</i> -option with the <i>lpinfo(8)</i> command to get a list of supported device URIs -and schemes. -<dt>-D "info" -<dd style="margin-left: 5.0em"><br> -Provides a textual description of the destination. -<dt>-E -<dd style="margin-left: 5.0em"><br> -Enables the destination and accepts jobs; this is the same as running the -<i>cupsaccept(8)</i> and <i>cupsenable(8)</i> programs on the destination. -<dt>-L "location" -<dd style="margin-left: 5.0em"><br> -Provides a textual location of the destination. -<dt>-P ppd-file -<dd style="margin-left: 5.0em"><br> -Specifies a PostScript Printer Description file to use with the -printer. If specified, this option overrides the <i>-i</i> option -(interface script). +<dt><b>-R </b><i>name</i><b>-default</b> +<dd style="margin-left: 5.0em">Deletes the named option from <i>printer</i>. +<dt><b>-r </b><i>class</i> +<dd style="margin-left: 5.0em">Removes the named <i>printer</i> from <i>class</i>. +If the resulting class becomes empty it is removed. +<dt><b>-u allow:</b>{<i>user</i>|<b>@</b><i>group</i>}{<b>,</b><i>user</i>|<b>,@</b><i>group</i>}* +<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>}* +<dd style="margin-left: 5.0em"><dt><b>-u allow:all</b> +<dd style="margin-left: 5.0em"><dt><b>-u deny:none</b> +<dd style="margin-left: 5.0em">Sets user-level access control on a destination. +Names starting with "@" are interpreted as UNIX groups. +The latter two forms turn user-level access control off. +<dt><b>-v "</b><i>device-uri</i><b>"</b> +<dd style="margin-left: 5.0em">Sets the <i>device-uri</i> attribute of the printer queue. +Use the <i>-v</i> option with the +<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8)</a> +command to get a list of supported device URIs and schemes. +<dt><b>-D "</b><i>info</i><b>"</b> +<dd style="margin-left: 5.0em">Provides a textual description of the destination. +<dt><b>-E</b> +<dd style="margin-left: 5.0em">Enables the destination and accepts jobs; this is the same as running the +<a href="man-cupsaccept.html?TOPIC=Man+Pages"><b>cupsaccept</b>(8)</a> +and +<a href="man-cupsenable.html?TOPIC=Man+Pages"><b>cupsenable</b>(8)</a> +programs on the destination. +<dt><b>-L "</b><i>location</i><b>"</b> +<dd style="margin-left: 5.0em">Provides a textual location of the destination. +<dt><b>-P </b><i>ppd-file</i> +<dd style="margin-left: 5.0em">Specifies a PostScript Printer Description file to use with the printer. +If specified, this option overrides the <i>-i</i> option (interface script). </dl> -<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 "#". +<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. -Finally, the CUPS version of <i>lpadmin</i> may ask the user for -an access password depending on the printing system -configuration. This differs from the System V version which -requires the root user to execute this command. -<h2 class="title"><a name="LIMITATIONS">Limitations</a></h2> -The CUPS version of <i>lpadmin</i> does not support all of the -System V or Solaris printing system configuration options. +Finally, the CUPS version of <b>lpadmin</b> may ask the user for an access password depending on the printing system configuration. +This differs from the System V version which requires the root user to execute this command. +<h2 class="title"><a name="NOTES">Notes</a></h2> +The CUPS version of <b>lpadmin</b> does not support all of the System V or Solaris printing system configuration options. <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<i>cupsaccept(8)</i>, <i>cupsenable(8)</i>, <i>lpinfo(8)</i>, -<i>lpoptions(1)</i>, -<br> -<a href="http://localhost:631/help">http://localhost:631/help</a> +<a href="man-cupsaccept.html?TOPIC=Man+Pages"><b>cupsaccept</b>(8),</a> +<a href="man-cupsenable.html?TOPIC=Man+Pages"><b>cupsenable</b>(8),</a> +<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8),</a> +<a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</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 © 2007-2014 by Apple Inc. </body> </html> diff --git a/doc/help/man-lpr.html b/doc/help/man-lpr.html index d64c6bef6..b4aaaf57e 100644 --- a/doc/help/man-lpr.html +++ b/doc/help/man-lpr.html @@ -11,93 +11,120 @@ lpr - print files <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2> <b>lpr</b> -[ -E ] [ -H -<i>server[:port]</i> -] [ -U +[ +<b>-E</b> +] [ +<b>-H </b><i>server</i>[<b>:</b><i>port</i>] +] [ +<b>-U</b> <i>username</i> -] [ -P -<i>destination[/instance]</i> -] [ -# +] [ +<b>-P </b><i>destination</i>[<b>/</b><i>instance</i>] +] [ +<b>-#</b> <i>num-copies</i> -[ -h ] [ -l ] [ -m ] [ -o -<i>option[=value]</i> -] [ -p] [ -q ] [ -r ] [ -C/J/T +[ +<b>-h</b> +] [ +<b>-l</b> +] [ +<b>-m</b> +] [ +<b>-o </b><i>option</i>[<b>=</b><i>value</i>] +] [ +<b>-p</b> +] [ +<b>-q</b> +] [ +<b>-r</b> +] [ +<b>-C</b> +<i>title</i> +] [ +<b>-J</b> +<i>title</i> +] [ +<b>-T</b> <i>title</i> ] [ <i>file(s)</i> ] <h2 class="title"><a name="DESCRIPTION">Description</a></h2> -<i>lpr</i> submits files for printing. Files named on the command -line are sent to the named printer (or the default destination if no -destination is specified). If no files are listed on the command-line, -<i>lpr</i> reads the print file 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>lpr</b> submits files for printing. +Files named on the command line are sent to the named printer or the default destination if no destination is specified. +If no files are listed on the command-line, <b>lpr</b> reads the print file 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>lpr</i>: <dl class="man"> -<dt>-E -<dd style="margin-left: 5.0em"><br> -Forces encryption when connecting to the server. -<dt>-H server[:port] -<dd style="margin-left: 5.0em"><br> -Specifies an alternate server. -<dt>-C "name" -<dd style="margin-left: 5.0em"><dt>-J "name" -<dd style="margin-left: 5.0em"><dt>-T "name" -<dd style="margin-left: 5.0em"><br> -Sets the job name. -<dt>-P destination[/instance] -<dd style="margin-left: 5.0em"><br> -Prints files to the named printer. -<dt>-U username -<dd style="margin-left: 5.0em"><br> -Specifies an alternate username. -<dt>-# <i>copies</i> -<dd style="margin-left: 5.0em"><br> -Sets the number of copies to print from 1 to 100. -<dt>-h -<dd style="margin-left: 5.0em"><br> -Disables banner printing. This option is equivalent to "-o -job-sheets=none". -<dt>-l -<dd style="margin-left: 5.0em"><br> -Specifies that the print file is already formatted for the -destination and should be sent without filtering. This option is -equivalent to "-o raw". -<dt>-m -<dd style="margin-left: 5.0em"><br> -Send an email on job completion. -<dt>-o option[=value] -<dd style="margin-left: 5.0em"><br> -Sets a job option. -<dt>-p -<dd style="margin-left: 5.0em"><br> -Specifies that the print file should be formatted with a shaded -header with the date, time, job name, and page number. This -option is equivalent to "-o prettyprint" and is only useful when -printing text files. -<dt>-q -<dd style="margin-left: 5.0em"><br> -Hold job for printing. -<dt>-r -<dd style="margin-left: 5.0em"><br> -Specifies that the named print files should be deleted after -printing them. +<dt><b>-E</b> +<dd style="margin-left: 5.0em">Forces encryption when connecting to the server. +<dt><b>-H </b><i>server</i>[<b>:</b><i>port</i>] +<dd style="margin-left: 5.0em">Specifies an alternate server. +<dt><b>-C "</b><i>name</i><b>"</b> +<dd style="margin-left: 5.0em"><dt><b>-J "</b><i>name</i><b>"</b> +<dd style="margin-left: 5.0em"><dt><b>-T "</b><i>name</i><b>"</b> +<dd style="margin-left: 5.0em">Sets the job name/title. +<dt><b>-P </b><i>destination</i>[<b>/</b><i>instance</i>] +<dd style="margin-left: 5.0em">Prints files to the named printer. +<dt><b>-U </b><i>username</i> +<dd style="margin-left: 5.0em">Specifies an alternate username. +<dt><b>-# </b><i>copies</i> +<dd style="margin-left: 5.0em">Sets the number of copies to print. +<dt><b>-h</b> +<dd style="margin-left: 5.0em">Disables banner printing. This option is equivalent to <i>-o job-sheets=none</i>. +<dt><b>-l</b> +<dd style="margin-left: 5.0em">Specifies that the print file is already formatted for the destination and should be sent without filtering. +This option is equivalent to <i>-o raw</i>. +<dt><b>-m</b> +<dd style="margin-left: 5.0em">Send an email on job completion. +<dt><b>-o </b><i>option</i>[<b>=</b><i>value</i>] +<dd style="margin-left: 5.0em">Sets a job option. +<dt><b>-p</b> +<dd style="margin-left: 5.0em">Specifies that the print file should be formatted with a shaded header with the date, time, job name, and page number. +This option is equivalent to <i>-o prettyprint</i> and is only useful when printing text files. +<dt><b>-q</b> +<dd style="margin-left: 5.0em">Hold job for printing. +<dt><b>-r</b> +<dd style="margin-left: 5.0em">Specifies that the named print files should be deleted after submitting them. </dl> -<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2> -The "c", "d", "f", "g", "i", "n", "t", "v", and "w" options -are not supported by CUPS and produce a warning message if used. +<h2 class="title"><a name="NOTES">Notes</a></h2> +The <i>-c</i>, <i>-d</i>, <i>-f</i>, <i>-g</i>, <i>-i</i>, <i>-n</i>, <i>-t</i>, <i>-v</i>, and <i>-w</i> options are not supported by CUPS and produce a warning message if used. +<h2 class="title"><a name="EXAMPLES">Examples</a></h2> +Print two copies of a document to the default printer: +<pre class="man"> + + lpr -# 2 filename + +</pre> +Print a double-sided legal document to a printer called "foo": +<pre class="man"> + + lpr -P foo -o media=legal -o sides=two-sided-long-edge filename + +</pre> +Print a presentation document 2-up to a printer called "foo": +<pre class="man"> + + lpr -P foo -o number-up=2 filename +</pre> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> -<i>cancel(1)</i>, <i>lp(1)</i>, <i>lpadmin(8)</i>, <i>lpoptions(1)</i>, -<i>lpq(1)</i>, <i>lprm(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-lp.html?TOPIC=Man+Pages"><b>lp</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-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 © 2007-2014 by Apple Inc. </body> </html> diff --git a/man/lp.man b/man/lp.man index 623849516..1c27349f5 100644 --- a/man/lp.man +++ b/man/lp.man @@ -1,252 +1,222 @@ .\" .\" "$Id$" .\" -.\" lp man page for CUPS. +.\" lp man page for CUPS. .\" -.\" Copyright 2007-2013 by Apple Inc. -.\" Copyright 1997-2006 by Easy Software Products. +.\" Copyright 2007-2014 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. .\" -.\" These coded instructions, statements, and computer programs are the -.\" property of Apple Inc. and are protected by Federal copyright -.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" -.\" which should have been included with this file. If this file is -.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". .\" -.TH lp 1 "CUPS" "16 July 2012" "Apple Inc." +.TH lp 1 "CUPS" "11 June 2014" "Apple Inc." .SH NAME -lp - print files +lp \- print files .SH SYNOPSIS .B lp -[ -E ] [ -U +[ +.B \-E +] [ +.B \-U .I username -] [ -c ] [ -d -.I destination[/instance] -] [ -h -.I hostname[:port] -] [ -m ] [ -n +] [ +.B \-c +] [ +\fB\-d \fIdestination\fR[\fB/\fIinstance\fR] +] [ +\fB\-h \fIhostname\fR[\fB:\fIport\fR] +] [ +.B \-m +] [ +.B \-n .I num-copies -] [ -o -.I option[=value] -] [ -q +] [ +\fB\-o \fIoption\fR[\fB=\fIvalue\fR] +] [ +.B \-q .I priority -] [ -s ] [ -t +] [ +.B \-s +] [ +.B \-t .I title -] [ -H +] [ +.B \-H .I handling -] [ -P +] [ +.B \-P .I page-list -] [ -- ] [ +] [ +.B \-\- +] [ .I file(s) ] .br .B lp -[ -E ] [ -U +[ +.B \-E +] [ +.B \-U .I username -] [ -c ] [ -h -.I hostname[:port] -] [ -i +] [ +.B \-c +] [ +\fB\-h \fIhostname\fR[\fB:\fIport\fR] +] [ +.B \-i .I job-id -] [ -n +] [ +.B \-n .I num-copies -] [ -o -.I option[=value] -] [ -q +] [ +\fB\-o \fIoption\fR[\fB=\fIvalue\fR] +] [ +.B \-q .I priority -] [ -t +] [ +.B \-t .I title -] [ -H +] [ +.B \-H .I handling -] [ -P +] [ +.B \-P .I page-list ] .SH DESCRIPTION -\fIlp\fR submits files for printing or alters a pending job. Use -a filename of "-" to force printing from the standard input. -.SH THE DEFAULT DESTINATION -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 \fIlpoptions(1)\fR command is used, -followed by the default set using the \fIlpadmin(8)\fR command. +\fBlp\fR submits files for printing or alters a pending job. +Use a filename of "-" to force printing from the standard input. +.SS THE DEFAULT DESTINATION +CUPS provides many ways to set the default destination. The \fBLPDEST\fR and \fBPRINTER\fR environment variables are consulted first. +If neither are set, the current default set using the +.BR lpoptions (1) +command is used, followed by the default set using the +.BR lpadmin (8) +command. .SH OPTIONS The following options are recognized by \fIlp\fR: .TP 5 --- -.br -Marks the end of options; use this to print a file whose name -begins with a dash (-). +.B \-\- +Marks the end of options; use this to print a file whose name begins with a dash (\-). .TP 5 --E -.br +.B \-E Forces encryption when connecting to the server. .TP 5 --U username -.br +\fB\-U \fIusername\fR Specifies the username to use when connecting to the server. .TP 5 --c -.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. +.B \-c +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. .TP 5 --d destination -.br +\fB\-d \fIdestination\fR Prints files to the named printer. .TP 5 --h hostname[:port] -.br +\fB\-h \fIhostname\fR[\fB:\fIport\fR] Chooses an alternate server. .TP 5 --i job-id -.br +\fB\-i \fIjob-id\fR Specifies an existing job to modify. .TP 5 --m -.br +.B \-m Sends an email when the job is completed. .TP 5 --n copies -.br -Sets the number of copies to print from 1 to 100. +\fB\-n \fIcopies\fR +Sets the number of copies to print. .TP 5 --o "name=value [name=value ...]" -.br +\fB\-o "\fIname\fB=\fIvalue \fR[ ... \fIname\fB=\fIvalue \fR]\fB"\fR Sets one or more job options. .TP 5 --q priority -.br -Sets the job priority from 1 (lowest) to 100 (highest). The -default priority is 50. +\fB\-q \fIpriority\fR +Sets the job priority from 1 (lowest) to 100 (highest). +The default priority is 50. .TP 5 --s -.br +.B \-s Do not report the resulting job IDs (silent mode.) .TP 5 --t "name" -.br +\fB\-t "\fIname\fB"\fR Sets the job name. .TP 5 --H hh:mm +\fB\-H \fIhh:mm\fR .TP 5 --H hold +\fB\-H hold\fR .TP 5 --H immediate +\fB-H immediate\fR .TP 5 --H restart +\fB-H restart\fR .TP 5 --H resume -.br -Specifies when the job should be printed. A value of \fIimmediate\fR will print -the file immediately, a value of \fIhold\fR 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 \fIresume\fR with the \fI-i\fR option to resume a held job. -Use a value of \fIrestart\fR with the \fI-i\fR option to restart -a completed job. -.TP 5 --P page-list -.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. -.SH COMMON JOB OPTIONS -Aside from the printer-specific options reported by the -\fIlpoptions(1)\fR command, the following generic options are -available: +\fB-H resume\fR +Specifies when the job should be printed. +A value of \fIimmediate\fR will print the file immediately, a value of \fIhold\fR 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 \fIresume\fR with the \fI-i\fR option to resume a held job. +Use a value of \fIrestart\fR with the \fI-i\fR option to restart a completed job. .TP 5 --o media=size -.br -Sets the page size to \fIsize\fR. Most printers support at least -the size names "a4", "letter", and "legal". +\fB\-P \fIpage-list\fR +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. +.SS COMMON JOB OPTIONS +Aside from the printer-specific options reported by the +.BR lpoptions (1) +command, the following generic options are available: .TP 5 --o landscape +\fB\-o media=\fIsize\fR +Sets the page size to \fIsize\fR. Most printers support at least the size names "a4", "letter", and "legal". .TP 5 --o orientation-requested=4 -.br +\fB\-o orientation\-requested=4\fR Prints the job in landscape (rotated 90 degrees). .TP 5 --o sides=one-sided +\fB\-o sides=one\-sided\fR +Prints on one side of the paper. .TP 5 --o sides=two-sided-long-edge +\fB\-o sides=two\-sided\-long\-edge\fR +Prints on both sides of the paper for portrait output. .TP 5 --o sides=two-sided-short-edge -.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. +\fB\-o sides=two\-sided\-short\-edge\fR +Prints on both sides of the paper for landscape output. .TP 5 --o fit-to-page -.br +\fB\-o fit\-to\-page\fR Scales the print file to fit on the page. .TP 5 --o number-up=2 -.TP 5 --o number-up=4 -.TP 5 --o number-up=6 -.TP 5 --o number-up=9 -.TP 5 --o number-up=16 -.br -Prints multiple document pages on each output page. -.TP 5 --o cpi=N -.br -Sets the number of characters per inch to use when printing a -text file. The default is 10. -.TP 5 --o lpi=N -.br -Sets the number of lines per inch to use when printing a text -file. The default is 6. -.TP 5 --o page-bottom=N -.TP 5 --o page-left=N -.TP 5 --o page-right=N -.TP 5 --o page-top=N -.br -Sets the page margins when printing text files. The values are in -points - there are 72 points to the inch. +\fB\-o number\-up=\fR{\fI2|4|6|9|16\fR} +Prints 2, 4, 6, 9, or 16 document (input) pages on each output page. +.SH CONFORMING TO +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 \fInot\fR case-sensitive. +.LP +The \fI-q\fR 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). .SH EXAMPLES -Print a double-sided legal document to a printer called "foo": +Print two copies of a document to the default printer: .nf - lp -d foo -o media=legal -o sides=two-sided-long-edge filename + + lp -n 2 filename + .fi -.LP -Print an image across 4 pages: +Print a double-sided legal document to a printer called "foo": .nf - lp -d bar -o scaling=200 filename + + lp -d foo -o media=legal -o sides=two-sided-long-edge filename + .fi -.LP -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": .nf - lp -d bar -o cpi=12 -o lpi=8 -o page-left=72 filename + + lp -d foo -o number-up=2 filename .fi -.SH COMPATIBILITY -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 \fInot\fR case-sensitive. -.LP -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). .SH SEE ALSO -\fIcancel(1)\fR, \fIlpadmin(8)\fR, \fIlpmove(8)\fR, \fIlpoptions(1)\fR, -\fIlpstat(1)\fR, -.br -http://localhost:631/help +.BR cancel (1), +.BR lpadmin (8), +.BR lpoptions (1), +.BR lpq (1), +.BR lpr (1), +.BR lprm (1), +.BR lpstat (1), +CUPS Online Help (http://localhost:631/help) .SH COPYRIGHT -Copyright 2007-2013 by Apple Inc. +Copyright \[co] 2007-2014 by Apple Inc. .\" .\" End of "$Id$". .\" diff --git a/man/lpadmin.man b/man/lpadmin.man index eda0aec6d..899b0354d 100644 --- a/man/lpadmin.man +++ b/man/lpadmin.man @@ -1,227 +1,212 @@ .\" .\" "$Id$" .\" -.\" lpadmin man page for CUPS. +.\" lpadmin man page for CUPS. .\" -.\" Copyright 2007-2013 by Apple Inc. -.\" Copyright 1997-2006 by Easy Software Products. +.\" Copyright 2007-2014 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. .\" -.\" These coded instructions, statements, and computer programs are the -.\" property of Apple Inc. and are protected by Federal copyright -.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" -.\" which should have been included with this file. If this file is -.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". .\" -.TH lpadmin 8 "CUPS" "16 July 2012" "Apple Inc." +.TH lpadmin 8 "CUPS" "11 June 2014" "Apple Inc." .SH NAME lpadmin \- configure cups printers and classes .SH SYNOPSIS .B lpadmin -[ -E ] [-U +[ +.B \-E +] [ +.B \-U .I username -] [ -h -.I server[:port] -] -d +] [ +\fB\-h \fIserver\fR[\fB:\fIport\fR] +] +.B \-d .I destination .br .B lpadmin -[ -E ] [-U +[ +.B \-E +] [ +.B \-U .I username -] [ -h -.I server[:port] -] -p +] [ +\fB\-h \fIserver\fR[\fB:\fIport\fR] +] +.B \-p .I destination -[ -R +[ +.B \-R .I name-default ] .I option(s) .br .B lpadmin -[ -E ] [-U +[ +.B \-E +] [ +.B \-U .I username -] [ -h -.I server[:port] -] -x +] [ +\fB\-h \fIserver\fR[\fB:\fIport\fR] +] +.B \-x .I destination .SH DESCRIPTION -\fIlpadmin\fR configures printer and class queues provided by -CUPS. It can also be used to set the server default printer or -class. +\fBlpadmin\fR configures printer and class queues provided by CUPS. +It can also be used to set the server default printer or class. .LP -When specified before the \fI-d\fR, \fI-p\fR, or \fI-x\fR -options, the \fI-E\fR option forces encryption when connecting to -the server. +When specified before the \fI-d\fR, \fI-p\fR, or \fI-x\fR options, the \fI-E\fR option forces encryption when connecting to the server. .LP -The first form of the command (\fI-d\fR) sets the default printer -or class to \fIdestination\fR. Subsequent print jobs submitted -via the \fIlp(1)\fR or \fIlpr(1)\fR commands will use this -destination unless the user specifies otherwise with the -\fIlpoptions(1)\fR command. +The first form of the command (\fI-d\fR) sets the default printer or class to \fIdestination\fR. +Subsequent print jobs submitted via the +.BR lp (1) +or +.BR lpr (1) +commands will use this destination unless the user specifies otherwise with the +.BR lpoptions (1) +command. .LP -The second form of the command (\fI-p\fR) configures the named -printer or class. The additional options are described below. +The second form of the command (\fI-p\fR) configures the named printer or class. The additional options are described below. .LP -The third form of the command (\fI-x\fR) deletes the printer or -class \fIdestination\fR. Any jobs that are pending for the -destination will be removed and any job that is currently printed -will be aborted. -.SH CONFIGURATION OPTIONS -The following options are recognized when configuring a printer -queue: -.TP 5 --c class -.br -Adds the named \fIprinter\fR to \fIclass\fR. If \fIclass\fR does -not exist it is created automatically. +The third form of the command (\fI-x\fR) deletes the printer or class \fIdestination\fR. +Any jobs that are pending for the destination will be removed and any job that is currently printed will be aborted. +.SH OPTIONS +The following options are recognized when configuring a printer queue: .TP 5 --i interface -.br -Sets a System V style interface script for the printer. This -option cannot be specified with the \fI-P\fR option (PPD file) -and is intended for providing support for legacy printer drivers. +\fB\-c \fIclass\fR +Adds the named \fIprinter\fR to \fIclass\fR. +If \fIclass\fR does not exist it is created automatically. .TP 5 --m model -.br -Sets a standard System V interface script or PPD file for the printer from the -\fImodel\fR directory or using one of the driver interfaces. Use the \fI-m\fR -option with the \fIlpinfo(8)\fR command to get a list of supported models. +\fB\-i \fIinterface\fR +Sets a System V style interface script for the printer. +This option cannot be specified with the \fI-P\fR option (PPD file) and is intended for providing support for legacy printer drivers. .TP 5 --o cupsIPPSupplies=true +\fB\-m \fImodel\fR +Sets a standard System V interface script or PPD file for the printer from the \fImodel\fR directory or using one of the driver interfaces. +Use the \fI-m\fR option with the +.BR lpinfo (8) +command to get a list of supported models. .TP 5 --o cupsIPPSupplies=false -.br +\fB\-o cupsIPPSupplies=true\fR +.TP 5 +\fB\-o cupsIPPSupplies=false\fR Specifies whether IPP supply level values should be reported. .TP 5 --o cupsSNMPSupplies=true +\fB\-o cupsSNMPSupplies=true\fR .TP 5 --o cupsSNMPSupplies=false -.br +\fB\-o cupsSNMPSupplies=false\fR Specifies whether SNMP supply level (RFC 3805) values should be reported. .TP 5 --o job-k-limit=value -.br -Sets the kilobyte limit for per-user quotas. The value is an -integer number of kilobytes; one kilobyte is 1024 bytes. +\fB\-o job\-k\-limit=\fIvalue\fR +Sets the kilobyte limit for per-user quotas. +The value is an integer number of kilobytes; one kilobyte is 1024 bytes. .TP 5 --o job-page-limit=value -.br -Sets the page limit for per-user quotas. The value is the integer -number of pages that can be printed; double-sided pages are -counted as two pages. +\fB\-o job\-page\-limit=\fIvalue\fR +Sets the page limit for per-user quotas. +The value is the integer number of pages that can be printed; double-sided pages are counted as two pages. .TP 5 --o job-quota-period=value -.br -Sets the accounting period for per-user quotas. The value is an -integer number of seconds; 86,400 seconds are in one day. +\fB-o job\-quota\-period=\fIvalue\fR +Sets the accounting period for per-user quotas. +The value is an integer number of seconds; 86,400 seconds are in one day. .TP 5 --o job-sheets-default=banner +\fB\-o job\-sheets\-default=\fIbanner\fR .TP 5 --o job-sheets-default=banner,banner -.br +\fB\-o job\-sheets\-default=\fIbanner\fB,\fIbanner\fR Sets the default banner page(s) to use for print jobs. .TP 5 --o name=value -.br -Sets a PPD option for the printer. PPD options can be listed using the \fI-l\fR -option with the \fIlpoptions(1)\fR command. -.TP 5 --o name-default=value -.br -Sets a default server-side option for the destination. Any print-time -option can be defaulted, e.g. "-o cpi-default=17" to set the default -"cpi" option value to 17. -.TP 5 --o port-monitor=name -.br -Sets the binary communications program to use when printing, -"none", "bcp", or "tbcp". The default program is "none". The -specified port monitor must be listed in the printer's PPD file. -.TP 5 --o printer-error-policy=name -.br -Sets the error policy to be used when the printer backend is -unable to send the job to the printer. The name must be one of -"abort-job", "retry-job", "retry-current-job", or "stop-printer". The default -error policy is "stop-printer" for printers and "retry-current-job" for +\fB\-o \fIname\fB=\fIvalue\fR +Sets a PPD option for the printer. +PPD options can be listed using the \fI-l\fR option with the +.BR lpoptions (1) +command. +.TP 5 +\fB\-o \fIname\fB-default=\fIvalue\fR +Sets a default server-side option for the destination. +Any print-time option can be defaulted, e.g., "-o number-up-default=2" to set the default "number-up" option value to 2. +.TP 5 +\fB\-o port\-monitor=\fIname\fR +Sets the binary communications program to use when printing, "none", "bcp", or "tbcp". +The default program is "none". +The specified port monitor must be listed in the printer's PPD file. +.TP 5 +\fB\-o printer-error-policy=\fIname\fR +Sets the error policy to be used when the printer backend is unable to send the job to the printer. +The name must be one of "abort-job", "retry-job", "retry-current-job", or "stop-printer". +The default error policy is "stop-printer" for printers and "retry-current-job" for classes. .TP 5 --o printer-is-shared=true/false -.br +\fB\-o printer\-is\-shared=true\fR +.TP 5 +\fB\-o printer\-is\-shared=false\fR Sets the destination to shared/published or unshared/unpublished. -Shared/published destinations are publicly announced by the server -on the LAN based on the browsing configuration in -\fBcupsd.conf\fR, while unshared/unpublished destinations are not -announced. The default value is "true". +Shared/published destinations are publicly announced by the server on the LAN based on the browsing configuration in \fIcupsd.conf\fR, while unshared/unpublished destinations are not announced. +The default value is "true". .TP 5 --o printer-op-policy=name -.br -Sets the IPP operation policy associated with the destination. The -name must be defined in the \fBcupsd.conf\fR in a Policy section. +\fB\-o printer-op-policy=\fIname\fR +Sets the IPP operation policy associated with the destination. +The name must be defined in the \fIcupsd.conf\fR in a Policy section. The default operation policy is "default". .TP 5 --R name-default -.br +\fB\-R \fIname\fB\-default\fR Deletes the named option from \fIprinter\fR. .TP 5 --r class -.br -Removes the named \fIprinter\fR from \fIclass\fR. If the -resulting class becomes empty it is removed. +\fB\-r \fIclass\fR +Removes the named \fIprinter\fR from \fIclass\fR. +If the resulting class becomes empty it is removed. .TP 5 --u allow:user,user,@group +\fB-u allow:\fR{\fIuser\fR|\fB@\fIgroup\fR}{\fB,\fIuser\fR|\fB,@\fIgroup\fR}* .TP 5 --u deny:user,user,@group +\fB-u deny:\fR{\fIuser\fR|\fB@\fIgroup\fR}{\fB,\fIuser\fR|\fB,@\fIgroup\fR}* .TP 5 --u allow:all +\fB\-u allow:all\fR .TP 5 --u deny:none -.br -Sets user-level access control on a destination. Names starting with -"@" are interpreted as UNIX groups. The latter two forms turn -user-level access control off. +\fB\-u deny:none\fR +Sets user-level access control on a destination. +Names starting with "@" are interpreted as UNIX groups. +The latter two forms turn user-level access control off. .TP 5 --v "device-uri" -.br -Sets the \fIdevice-uri\fR attribute of the printer queue. Use the \fI-v\fR -option with the \fIlpinfo(8)\fR command to get a list of supported device URIs -and schemes. +\fB\-v "\fIdevice-uri\fB"\fR +Sets the \fIdevice-uri\fR attribute of the printer queue. +Use the \fI-v\fR option with the +.BR lpinfo (8) +command to get a list of supported device URIs and schemes. .TP 5 --D "info" -.br +\fB\-D "\fIinfo\fB"\fR Provides a textual description of the destination. .TP 5 --E -.br +.B \-E Enables the destination and accepts jobs; this is the same as running the -\fIcupsaccept(8)\fR and \fIcupsenable(8)\fR programs on the destination. +.BR cupsaccept (8) +and +.BR cupsenable (8) +programs on the destination. .TP 5 --L "location" -.br +\fB\-L "\fIlocation\fB"\fR Provides a textual location of the destination. .TP 5 --P ppd-file -.br -Specifies a PostScript Printer Description file to use with the -printer. If specified, this option overrides the \fI-i\fR option -(interface script). -.SH COMPATIBILITY -Unlike the System V printing system, CUPS allows printer names to -contain any printable character except SPACE, TAB, "/", or "#". +\fB\-P \fIppd-file\fR +Specifies a PostScript Printer Description file to use with the printer. +If specified, this option overrides the \fI-i\fR option (interface script). +.SH CONFORMING TO +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 \fInot\fR case-sensitive. -Finally, the CUPS version of \fIlpadmin\fR may ask the user for -an access password depending on the printing system -configuration. This differs from the System V version which -requires the root user to execute this command. -.SH LIMITATIONS -The CUPS version of \fIlpadmin\fR does not support all of the -System V or Solaris printing system configuration options. +Finally, the CUPS version of \fBlpadmin\fR may ask the user for an access password depending on the printing system configuration. +This differs from the System V version which requires the root user to execute this command. +.SH NOTES +The CUPS version of \fBlpadmin\fR does not support all of the System V or Solaris printing system configuration options. .SH SEE ALSO -\fIcupsaccept(8)\fR, \fIcupsenable(8)\fR, \fIlpinfo(8)\fR, -\fIlpoptions(1)\fR, -.br -http://localhost:631/help +.BR cupsaccept (8), +.BR cupsenable (8), +.BR lpinfo (8), +.BR lpoptions (1), +CUPS Online Help (http://localhost:631/help) .SH COPYRIGHT -Copyright 2007-2013 by Apple Inc. +Copyright \[co] 2007-2014 by Apple Inc. .\" .\" End of "$Id$". .\" diff --git a/man/lpr.man b/man/lpr.man index 73a8667d4..78c71dd37 100644 --- a/man/lpr.man +++ b/man/lpr.man @@ -1,122 +1,149 @@ .\" .\" "$Id$" .\" -.\" lpr man page for CUPS. +.\" lpr man page for CUPS. .\" -.\" Copyright 2007-2013 by Apple Inc. -.\" Copyright 1997-2006 by Easy Software Products. +.\" Copyright 2007-2013 by Apple Inc. +.\" Copyright 1997-2006 by Easy Software Products. .\" -.\" These coded instructions, statements, and computer programs are the -.\" property of Apple Inc. and are protected by Federal copyright -.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" -.\" which should have been included with this file. If this file is -.\" file is missing or damaged, see the license at "http://www.cups.org/". +.\" These coded instructions, statements, and computer programs are the +.\" property of Apple Inc. and are protected by Federal copyright +.\" law. Distribution and use rights are outlined in the file "LICENSE.txt" +.\" which should have been included with this file. If this file is +.\" file is missing or damaged, see the license at "http://www.cups.org/". .\" -.TH lpr 1 "CUPS" "29 August 2008" "Apple Inc." +.TH lpr 1 "CUPS" "11 June 2014" "Apple Inc." .SH NAME lpr \- print files .SH SYNOPSIS .B lpr -[ -E ] [ -H -.I server[:port] -] [ -U +[ +.B \-E +] [ +\fB\-H \fIserver\fR[\fB:\fIport\fR] +] [ +.B \-U .I username -] [ -P -.I destination[/instance] -] [ -# +] [ +\fB\-P \fIdestination\fR[\fB/\fIinstance\fR] +] [ +.B \-# .I num-copies -[ -h ] [ -l ] [ -m ] [ -o -.I option[=value] -] [ -p] [ -q ] [ -r ] [ -C/J/T +[ +.B \-h +] [ +.B \-l +] [ +.B \-m +] [ +\fB\-o \fIoption\fR[\fB=\fIvalue\fR] +] [ +.B \-p +] [ +.B \-q +] [ +.B \-r +] [ +.B \-C +.I title +] [ +.B \-J +.I title +] [ +.B \-T .I title ] [ .I file(s) ] .SH DESCRIPTION -\fIlpr\fR submits files for printing. Files named on the command -line are sent to the named printer (or the default destination if no -destination is specified). If no files are listed on the command-line, -\fIlpr\fR reads the print file from the standard input. -.SH THE DEFAULT DESTINATION -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 \fIlpoptions(1)\fR command is used, -followed by the default set using the \fIlpadmin(8)\fR command. +\fBlpr\fR submits files for printing. +Files named on the command line are sent to the named printer or the default destination if no destination is specified. +If no files are listed on the command-line, \fBlpr\fR reads the print file from the standard input. +.SS THE DEFAULT DESTINATION +CUPS provides many ways to set the default destination. The \fBLPDEST\fR and \fBPRINTER\fR environment variables are consulted first. +If neither are set, the current default set using the +.BR lpoptions (1) +command is used, followed by the default set using the +.BR lpadmin (8) +command. .SH OPTIONS The following options are recognized by \fIlpr\fR: .TP 5 --E -.br +.B \-E Forces encryption when connecting to the server. .TP 5 --H server[:port] -.br +\fB\-H \fIserver\fR[\fB:\fIport\fR] Specifies an alternate server. .TP 5 --C "name" +\fB\-C "\fIname\fB"\fR .TP 5 --J "name" +\fB\-J "\fIname\fB"\fR .TP 5 --T "name" -.br -Sets the job name. +\fB\-T "\fIname\fB"\fR +Sets the job name/title. .TP 5 --P destination[/instance] -.br +\fB\-P \fIdestination\fR[\fB/\fIinstance\fR] Prints files to the named printer. .TP 5 --U username -.br +\fB\-U \fIusername\fR Specifies an alternate username. .TP 5 --# \fIcopies\fR -.br -Sets the number of copies to print from 1 to 100. +\fB\-# \fIcopies\fR +Sets the number of copies to print. .TP 5 --h -.br -Disables banner printing. This option is equivalent to "-o -job-sheets=none". +.B \-h +Disables banner printing. This option is equivalent to \fI-o job\-sheets=none\fR. .TP 5 --l -.br -Specifies that the print file is already formatted for the -destination and should be sent without filtering. This option is -equivalent to "-o raw". +.B \-l +Specifies that the print file is already formatted for the destination and should be sent without filtering. +This option is equivalent to \fI-o raw\fR. .TP 5 --m -.br +.B \-m Send an email on job completion. .TP 5 --o option[=value] -.br +\fB\-o \fIoption\fR[\fB=\fIvalue\fR] Sets a job option. .TP 5 --p -.br -Specifies that the print file should be formatted with a shaded -header with the date, time, job name, and page number. This -option is equivalent to "-o prettyprint" and is only useful when -printing text files. +.B \-p +Specifies that the print file should be formatted with a shaded header with the date, time, job name, and page number. +This option is equivalent to \fI\-o prettyprint\fR and is only useful when printing text files. .TP 5 --q -.br +.B \-q Hold job for printing. .TP 5 --r -.br -Specifies that the named print files should be deleted after -printing them. -.SH COMPATIBILITY -The "c", "d", "f", "g", "i", "n", "t", "v", and "w" options -are not supported by CUPS and produce a warning message if used. +.B \-r +Specifies that the named print files should be deleted after submitting them. +.SH NOTES +The \fI\-c\fR, \fI\-d\fR, \fI\-f\fR, \fI\-g\fR, \fI\-i\fR, \fI\-n\fR, \fI\-t\fR, \fI\-v\fR, and \fI\-w\fR options are not supported by CUPS and produce a warning message if used. +.SH EXAMPLES +Print two copies of a document to the default printer: +.nf + + lpr -# 2 filename + +.fi +Print a double-sided legal document to a printer called "foo": +.nf + + lpr -P foo -o media=legal -o sides=two-sided-long-edge filename + +.fi +Print a presentation document 2-up to a printer called "foo": +.nf + + lpr -P foo -o number-up=2 filename +.fi .SH SEE ALSO -\fIcancel(1)\fR, \fIlp(1)\fR, \fIlpadmin(8)\fR, \fIlpoptions(1)\fR, -\fIlpq(1)\fR, \fIlprm(1)\fR, \fIlpstat(1)\fR, -.br -http://localhost:631/help +.BR cancel (1), +.BR lp (1), +.BR lpadmin (8), +.BR lpoptions (1), +.BR lpq (1), +.BR lprm (1), +.BR lpstat (1), +CUPS Online Help (http://localhost:631/help) .SH COPYRIGHT -Copyright 2007-2013 by Apple Inc. +Copyright \[co] 2007-2014 by Apple Inc. .\" .\" End of "$Id$". .\" |