Add Printer Options to lpr / lp man pages

[michaelrsweet]

Version: 2.0-feature
CUPS.org User: odyx

Hi Michael,

Christopher Swingley reported the following bug against cups 1.1.23:
http://bugs.debian.org/304504

It would be convenient to have the printer options (all those things
available with -o option) listed in the manual page. I've attached a
patch against lpr.1 that could be applied. The same code could probably
be inserted into the lp manual page.

I have attached his patch here.

Thanks for considering!

[michaelrsweet]

CUPS.org User: mike

Will add some examples as part of the man page modernization bug (STR #4372).

[michaelrsweet]

CUPS.org User: mike

Fixed in Subversion repository.

[michaelrsweet]

"lpr.1.patch":

--- lpr.1.orig 2005-04-13 08:38:30.000000000 -0800
+++ lpr.1 2005-04-13 08:36:27.000000000 -0800
@@ -93,6 +93,116 @@
-r
.br
Specifies that the named print files should be deleted after printing them.
+.SH JOB OPTIONS
+The following job options are recognized by most CUPS drivers:
+.TP 5
+media=\fILetter,Legal,A4,COM10,DL,Transparency,Upper,Lower,MultiPurpose,LargeCapacity\fR
+.br
+Selects media size, type, and source. Case-insensitive.
+.TP 5
+landscape
+.br
+Print in landscape orientation.
+.TP 5
+sides=\fIone-sided | two-sided-short-edge | two-sided-long-edge\rR
+.br
+Duplexing options, if available.
+.TP 5
+job-sheets=\fInone | classified | confidential | secret | standard | topstandard | unclassified\fR
+.br
+Prints a banner page. If only one banner file is specified, it will be printed
+before the files in the job. If a second banner file is specified, it is printed after
+the files in the job.
+.TP 5
+page-ranges=\fIrange\fR
+.br
+Select a range of pages for printing. For example, \fI-o page-ranges=1,3-5,9-12\fR.
+.TP 5
+page-set=\fIodd | even\fR
+.br
+Select odd or even pages.
+.TP 5
+output-order=\fInormal | reverse\fR
+.br
+Set the output order of all pages.
+.TP 5
+number-up=\fI1 | 2 | 4 | 6 | 9 | 16\fR
+.br
+Select N-Up printing.
+.TP 5
+number-up-layout=\fIlrtb | btlr | btrl | lrbt | rlbt | rltb | tblr | tbrl\fR
+.br
+Layout of pages on each output page (bottom, top, left right, etc.).
+.TP 5
+page-border=\fInone | double | double-thick | single | single-thick\fR
+.br
+Draw a border around each page.
+.TP 5
+mirror
+.br
+Print a mirror image.
+.TP 5
+brightness=\fIpercent\fR
+.br
+Control the overall brightness of the output.
+.TP 5
+gamma=\fIvalue\fR
+.br
+Control the overall gamma correction of the output. Values above 1000 will lighten the print,
+values less thatn 1000 will darken it.
+.TP 5
+cpi=\fIvalue\fR
+.br
+For text files, set the number of characters per inch. The default is 10.
+.TP 5
+lpi=\fIvalue\fR
+.br
+For text files, set the number of lines per inch. The default is 6.
+.TP 5
+columns=\fIvalue\fR
+.br
+For text files, set the number of text columns. The default is 1.
+.TP 5
+page-(left|right|top|bottom)=\fIvalue\fR
+.br
+Adjust the page margins. The argument is in points; each point is 1/72 inch or 0.35mm.
+.TP 5
+prettyprint
+.br
+Puts a header at the top of each page with the page number, job title, and the date. Also,
+C and C++ keywords are highlighed and comment lines are italicized.
+.TP 5
+position=\fIcenter | top | left | right | top-left | top-right | bottom | bottom-left | bottom-right\fR
+.br
+Position image files on the page.
+.TP 5
+scaling=\fIpercent\fR
+.br
+Scale the image in relation to the size of the page (not the image). A scaling of 100 percent will
+fill the page as completely as the image aspect ratio allows. A scaling of 200 percent will print on
+up to 4 pages.
+.TP 5
+ppi=\fIvalue\fR
+.br
+The resolution of the image in pixels per inch.
+.TP 5
+natural-scaling=\fIpercent\fR
+.br
+Size in relation to the natural image size. A scaling of 100 percent will print the image at it's natural size.
+.TP 5
+hue=\fIvalue\fR
+.br
+Adjust the hue of the printed image from -360 to 360.
+.TP 5
+saturation=\fIpercent\fR
+.br
+Adjust the color saturation of the printed image. A saturation of 0 will produce a black and white
+print, while a value of 200 will make the colors extremely intense.
+.TP 5
+raw
+.br
+Send files directly to the printer without any filtering. None of the other options will
+be used with this option.
.SH COMPATIBILITY
The "c", "d", "f", "g", "i", "m", "n", "t", "v", and "w" options are not
supported by CUPS and will produce a warning message if used.

[alxwk]

I don't understand why for adding options the existing lines (like those describing lpi or cpi) were needed to be deleted, while they are still exist and work. I wasted half a day trying to figure them out, digging up manual pages from a decade ago.