]> git.ipfire.org Git - thirdparty/cups.git/commitdiff
Add common options to lp/lpr man pages (Issue #4794)
authorMichael Sweet <michael.r.sweet@gmail.com>
Mon, 2 May 2016 22:58:42 +0000 (18:58 -0400)
committerMichael Sweet <michael.r.sweet@gmail.com>
Mon, 2 May 2016 22:58:42 +0000 (18:58 -0400)
doc/help/options.html
man/lp.man
man/lpr.man

index 9f3a81a11f3fda52500f5f7b2fc84befe82ac0ad..044cdb612092d53992e4fee1d62920712bda01f1 100644 (file)
@@ -145,11 +145,11 @@ lpr -#<EM>num-copies</EM> filename
 </PRE>
 
 <P>Copies are normally <EM>not</EM> collated for you. Use the
-<CODE>-o Collate=True</CODE> option to get collated copies:</P>
+<CODE>-o collate=true</CODE> option to get collated copies:</P>
 
 <PRE CLASS="command">
-lp -n <EM>num-copies</EM> -o Collate=True filename
-lpr -#<EM>num-copies</EM> -o Collate=True filename
+lp -n <EM>num-copies</EM> -o collate=true filename
+lpr -#<EM>num-copies</EM> -o collate=true filename
 </PRE>
 
 
@@ -452,18 +452,6 @@ can make the output page numbering not match the document page numbers.</p>
 </blockquote>
 
 
-<H3><A NAME="PAGESET">Selecting Even or Odd Pages</A></H3>
-
-<P>Use the <CODE>-o page-set=set</CODE> option to select the even or odd pages:</P>
-
-<PRE CLASS="command">
-lp -o page-set=odd filename
-lp -o page-set=even filename
-lpr -o page-set=even filename
-</PRE>
-
-<P>The default is to print all pages.
-
 <H3><A NAME="NUMBERUP">N-Up Printing</A></H3>
 
 <P>The <CODE>-o number-up=value</CODE> option selects N-Up
@@ -577,78 +565,5 @@ lpr -o raw filename
 lpr -l filename
 </PRE>
 
-
-<H2 CLASS="title"><A NAME="TEXTOPTIONS">Text Options</A></H2>
-
-<P>CUPS supports several options that are only used when printing
-plain text files. These options have absolutely no effect on
-PostScript, PDF, HP-GL/2, or image files.</P>
-
-<H3><A NAME="CPI">Setting the Number of Characters Per Inch</A></H3>
-
-<P>The <CODE>-o cpi=value</CODE> option sets the number of
-characters per inch:</P>
-
-<PRE CLASS="command">
-lp -o cpi=10 filename
-lp -o cpi=12 filename
-lpr -o cpi=17 filename
-</PRE>
-
-<P>The default characters per inch is 10.</P>
-
-<H3><A NAME="LPI">Setting the Number of Lines Per Inch</A></H3>
-
-<P>The <CODE>-o lpi=value</CODE> option sets the number of lines
-per inch:</P>
-
-<PRE CLASS="command">
-lp -o lpi=6 filename
-lpr -o lpi=8 filename
-</PRE>
-
-<P>The default lines per inch is 6.</P>
-
-<H3><A NAME="MARGINS">Setting the Page Margins</A></H3>
-
-<P>Normally the page margins are set to the hard limits of the
-printer. Use the <CODE>-o page-left=value</CODE>, <CODE>-o
-page-right=value</CODE>, <CODE>-o page-top=value</CODE>, and
-<CODE>-o page-bottom=value</CODE> options to adjust the page
-margins:</P>
-
-<PRE CLASS="command">
-lp -o page-left=<EM>value</EM> filename
-lp -o page-right=<EM>value</EM> filename
-lp -o page-top=<EM>value</EM> filename
-lp -o page-bottom=<EM>value</EM> filename
-lpr -o page-left=<EM>value</EM> -o page-right=<EM>value</EM> -o page-top=<EM>value</EM> -o page-bottom=<EM>value</EM> filename
-</PRE>
-
-<P>The <CODE>value</CODE> argument is the margin in points; each
-point is 1/72 inch or 0.35mm.</P>
-
-<H3><A NAME="PRETTYPRINT">Pretty Printing</A></H3>
-
-<P>The <CODE>-o prettyprint</CODE> option puts a header at the
-top of each page with the page number, job title (usually the
-filename), and the date. Also, C and C++ keywords are
-highlighted, and comment lines are italicized:</P>
-
-<PRE CLASS="command">
-lp -o prettyprint filename
-lpr -o prettyprint filename
-</PRE>
-
-<H3><A NAME="WRAP">Turning Off Text Wrapping</A></H3>
-
-<P>The <CODE>-o nowrap</CODE> option disables wrapping of long lines:</P>
-
-<PRE CLASS="command">
-lp -o nowrap filename
-lpr -o nowrap filename
-</PRE>
-
-
 </BODY>
 </HTML>
index 4892b37cbabe8b6d8fea2e54082cb4819da4a003..03b10e5e20067cfcb613430b5a0791729bedb2c3 100644 (file)
@@ -1,7 +1,7 @@
 .\"
 .\" lp man page for CUPS.
 .\"
-.\" Copyright 2007-2014 by Apple Inc.
+.\" Copyright 2007-2016 by Apple Inc.
 .\" Copyright 1997-2006 by Easy Software Products.
 .\"
 .\" These coded instructions, statements, and computer programs are the
@@ -10,7 +10,7 @@
 .\" 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" "11 June 2014" "Apple Inc."
+.TH lp 1 "CUPS" "2 May 2016" "Apple Inc."
 .SH NAME
 lp \- print files
 .SH SYNOPSIS
@@ -127,6 +127,7 @@ Sets the number of copies to print.
 .TP 5
 \fB\-o "\fIname\fB=\fIvalue \fR[ ... \fIname\fB=\fIvalue \fR]\fB"\fR
 Sets one or more job options.
+See "COMMON JOB OPTIONS" below.
 .TP 5
 \fB\-q \fIpriority\fR
 Sets the job priority from 1 (lowest) to 100 (highest).
@@ -161,11 +162,64 @@ Aside from the printer-specific options reported by the
 .BR lpoptions (1)
 command, the following generic options are available:
 .TP 5
+\fB\-o collate=true\fR
+Prints collated copies.
+.TP 5
+\fB\-o fit\-to\-page\fR
+Scales the print file to fit on the page.
+.TP 5
+\fB\-o job-hold-until=\fIwhen\fR
+Holds the job until the specified local time.
+"when" can be "indefinite" to hold the until released, "day-time" to print the job between 6am and 6pm local time, "night" to print the job between 6pm and 6am local time, "second-shift" to print the job between 4pm and 12am local time, "third-shift" to print the job between 12am and 8am local time, or "weekend" to print the job on Saturday or Sunday.
+.TP 5
+\fB\-o job-hold-until=\fIhh:mm\fR
+Holds the job until the specified time in hours and minutes UTC.
+.TP 5
+\fB\-o job-priority=\fIpriority\fR
+Set the priority to a value from 1 (lowest) to 100 (highest), which influences when a job is scheduled for printing.
+The default priority is typically 50.
+.TP 5
+\fB\-o job-sheets=\fIname\fR\fR
+Prints a cover page (banner) with the document.
+The "name" can be "classified", "confidential", "secret", "standard", "topsecret", or "unclassified".
+.TP 5
+\fB\-o job-sheets=\fIstart-name,end-name\fR\fR
+Prints cover pages (banners) with the document.
+.TP 5
 \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
+\fB\-o mirror\fR
+Mirrors each page.
+.TP 5
+\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.
+.TP 5
+\fB\-o number\-up\-layout=\fIlayout\fR
+Specifies the layout of pages with the "number-up" option.
+The "layout" string can be "btlr", "btrl", "lrbt", "lrtb", "rlbt", "rltb", "tblr", or "tbrl" - the first two letters determine the column order while the second two letters determine the row order.
+"bt" is bottom-to-top, "lr" is left-to-right, "rl" is right-to-left, and "tb" is top-to-bottom.
+.TP 5
 \fB\-o orientation\-requested=4\fR
-Prints the job in landscape (rotated 90 degrees).
+Prints the job in landscape (rotated 90 degrees counter-clockwise).
+.TP 5
+\fB\-o orientation\-requested=5\fR
+Prints the job in landscape (rotated 90 degrees clockwise).
+.TP 5
+\fB\-o orientation\-requested=6\fR
+Prints the job in reverse portrait (rotated 180 degrees).
+.TP 5
+\fB\-o outputorder=reverse\fR
+Prints pages in reverse order.
+.TP 5
+\fB\-o page\-border=\fIborder\fR
+Prints a border around each document page.
+"border" is "double", "double\-thick", "single", or "single\-thick".
+.TP 5
+\fB\-o page\-ranges=\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.
 .TP 5
 \fB\-o sides=one\-sided\fR
 Prints on one side of the paper.
@@ -175,12 +229,6 @@ Prints on both sides of the paper for portrait output.
 .TP 5
 \fB\-o sides=two\-sided\-short\-edge\fR
 Prints on both sides of the paper for landscape output.
-.TP 5
-\fB\-o fit\-to\-page\fR
-Scales the print file to fit on the page.
-.TP 5
-\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.
@@ -214,4 +262,4 @@ Print a presentation document 2-up to a printer called "foo":
 .BR lpstat (1),
 CUPS Online Help (http://localhost:631/help)
 .SH COPYRIGHT
-Copyright \[co] 2007-2015 by Apple Inc.
+Copyright \[co] 2007-2016 by Apple Inc.
index 8faad49ef8407699b7a068d8193b23495b331f8e..553d0592d44e9fce94a94696a053b31566897e9e 100644 (file)
@@ -1,7 +1,7 @@
 .\"
 .\" lpr man page for CUPS.
 .\"
-.\" Copyright 2007-2013 by Apple Inc.
+.\" Copyright 2007-2016 by Apple Inc.
 .\" Copyright 1997-2006 by Easy Software Products.
 .\"
 .\" These coded instructions, statements, and computer programs are the
@@ -10,7 +10,7 @@
 .\" 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" "11 June 2014" "Apple Inc."
+.TH lpr 1 "CUPS" "2 May 2016" "Apple Inc."
 .SH NAME
 lpr \- print files
 .SH SYNOPSIS
@@ -101,6 +101,7 @@ Send an email on job completion.
 .TP 5
 \fB\-o \fIoption\fR[\fB=\fIvalue\fR]
 Sets a job option.
+See "COMMON JOB OPTIONS" below.
 .TP 5
 .B \-p
 Specifies that the print file should be formatted with a shaded header with the date, time, job name, and page number.
@@ -111,6 +112,78 @@ Hold job for printing.
 .TP 5
 .B \-r
 Specifies that the named print files should be deleted after submitting them.
+.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
+\fB\-o collate=true\fR
+Prints collated copies.
+.TP 5
+\fB\-o fit\-to\-page\fR
+Scales the print file to fit on the page.
+.TP 5
+\fB\-o job-hold-until=\fIwhen\fR
+Holds the job until the specified local time.
+"when" can be "indefinite" to hold the until released, "day-time" to print the job between 6am and 6pm local time, "night" to print the job between 6pm and 6am local time, "second-shift" to print the job between 4pm and 12am local time, "third-shift" to print the job between 12am and 8am local time, or "weekend" to print the job on Saturday or Sunday.
+.TP 5
+\fB\-o job-hold-until=\fIhh:mm\fR
+Holds the job until the specified time in hours and minutes UTC.
+.TP 5
+\fB\-o job-priority=\fIpriority\fR
+Set the priority to a value from 1 (lowest) to 100 (highest), which influences when a job is scheduled for printing.
+The default priority is typically 50.
+.TP 5
+\fB\-o job-sheets=\fIname\fR\fR
+Prints a cover page (banner) with the document.
+The "name" can be "classified", "confidential", "secret", "standard", "topsecret", or "unclassified".
+.TP 5
+\fB\-o job-sheets=\fIstart-name,end-name\fR\fR
+Prints cover pages (banners) with the document.
+.TP 5
+\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
+\fB\-o mirror\fR
+Mirrors each page.
+.TP 5
+\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.
+.TP 5
+\fB\-o number\-up\-layout=\fIlayout\fR
+Specifies the layout of pages with the "number-up" option.
+The "layout" string can be "btlr", "btrl", "lrbt", "lrtb", "rlbt", "rltb", "tblr", or "tbrl" - the first two letters determine the column order while the second two letters determine the row order.
+"bt" is bottom-to-top, "lr" is left-to-right, "rl" is right-to-left, and "tb" is top-to-bottom.
+.TP 5
+\fB\-o orientation\-requested=4\fR
+Prints the job in landscape (rotated 90 degrees counter-clockwise).
+.TP 5
+\fB\-o orientation\-requested=5\fR
+Prints the job in landscape (rotated 90 degrees clockwise).
+.TP 5
+\fB\-o orientation\-requested=6\fR
+Prints the job in reverse portrait (rotated 180 degrees).
+.TP 5
+\fB\-o outputorder=reverse\fR
+Prints pages in reverse order.
+.TP 5
+\fB\-o page\-border=\fIborder\fR
+Prints a border around each document page.
+"border" is "double", "double\-thick", "single", or "single\-thick".
+.TP 5
+\fB\-o page\-ranges=\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.
+.TP 5
+\fB\-o sides=one\-sided\fR
+Prints on one side of the paper.
+.TP 5
+\fB\-o sides=two\-sided\-long\-edge\fR
+Prints on both sides of the paper for portrait output.
+.TP 5
+\fB\-o sides=two\-sided\-short\-edge\fR
+Prints on both sides of the paper for landscape output.
 .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
@@ -141,4 +214,4 @@ Print a presentation document 2-up to a printer called "foo":
 .BR lpstat (1),
 CUPS Online Help (http://localhost:631/help)
 .SH COPYRIGHT
-Copyright \[co] 2007-2015 by Apple Inc.
+Copyright \[co] 2007-2016 by Apple Inc.