From: msweet Date: Wed, 11 Jun 2014 23:35:37 +0000 (+0000) Subject: More man page updates. X-Git-Tag: v2.2b1~610 X-Git-Url: http://git.ipfire.org/?p=thirdparty%2Fcups.git;a=commitdiff_plain;h=cfa19b58e65e6f78221476ea97552e827fc663fd More man page updates. git-svn-id: svn+ssh://src.apple.com/svn/cups/cups.org/trunk@11922 a1ca3aef-8c08-0410-bb20-df032aa958be --- 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

Synopsis

lp -[ -E ] [ -U +[ +-E +] [ +-U username -] [ -c ] [ -d -destination[/instance] -] [ -h -hostname[:port] -] [ -m ] [ -n +] [ +-c +] [ +-d destination[/instance] +] [ +-h hostname[:port] +] [ +-m +] [ +-n num-copies -] [ -o -option[=value] -] [ -q +] [ +-o option[=value] +] [ +-q priority -] [ -s ] [ -t +] [ +-s +] [ +-t title -] [ -H +] [ +-H handling -] [ -P +] [ +-P page-list -] [ -- ] [ +] [ +-- +] [ file(s) ]
lp -[ -E ] [ -U +[ +-E +] [ +-U username -] [ -c ] [ -h -hostname[:port] -] [ -i +] [ +-c +] [ +-h hostname[:port] +] [ +-i job-id -] [ -n +] [ +-n num-copies -] [ -o -option[=value] -] [ -q +] [ +-o option[=value] +] [ +-q priority -] [ -t +] [ +-t title -] [ -H +] [ +-H handling -] [ -P +] [ +-P page-list ]

Description

-lp submits files for printing or alters a pending job. Use -a filename of "-" to force printing from the standard input. -

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 lpoptions(1) command is used, -followed by the default set using the lpadmin(8) command. +lp submits files for printing or alters a pending job. +Use a filename of "-" to force printing from the standard input. +

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 +lpoptions(1) +command is used, followed by the default set using the +lpadmin(8) +command.

Options

The following options are recognized by lp:
-
-- -

-Marks the end of options; use this to print a file whose name -begins with a dash (-). -
-E -

-Forces encryption when connecting to the server. -
-U username -

-Specifies the username to use when connecting to the server. -
-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. -
-d destination -

-Prints files to the named printer. -
-h hostname[:port] -

-Chooses an alternate server. -
-i job-id -

-Specifies an existing job to modify. -
-m -

-Sends an email when the job is completed. -
-n copies -

-Sets the number of copies to print from 1 to 100. -
-o "name=value [name=value ...]" -

-Sets one or more job options. -
-q priority -

-Sets the job priority from 1 (lowest) to 100 (highest). The -default priority is 50. -
-s -

-Do not report the resulting job IDs (silent mode.) -
-t "name" -

-Sets the job name. -
-H hh:mm -
-H hold -
-H immediate -
-H restart -
-H resume -

-Specifies when the job should be printed. A value of immediate will print -the file immediately, a value of hold 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 resume with the -i option to resume a held job. -Use a value of restart with the -i option to restart -a completed job. -
-P page-list -

-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. +
-- +
Marks the end of options; use this to print a file whose name begins with a dash (-). +
-E +
Forces encryption when connecting to the server. +
-U username +
Specifies the username to use when connecting to the server. +
-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. +
-d destination +
Prints files to the named printer. +
-h hostname[:port] +
Chooses an alternate server. +
-i job-id +
Specifies an existing job to modify. +
-m +
Sends an email when the job is completed. +
-n copies +
Sets the number of copies to print. +
-o "name=value [ ... name=value ]" +
Sets one or more job options. +
-q priority +
Sets the job priority from 1 (lowest) to 100 (highest). +The default priority is 50. +
-s +
Do not report the resulting job IDs (silent mode.) +
-t "name" +
Sets the job name. +
-H hh:mm +
-H hold +
-H immediate +
-H restart +
-H resume +
Specifies when the job should be printed. +A value of immediate will print the file immediately, a value of hold 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 resume with the -i option to resume a held job. +Use a value of restart with the -i option to restart a completed job. +
-P page-list +
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.
-

Common Job Options

+

Common Job Options

Aside from the printer-specific options reported by the -lpoptions(1) command, the following generic options are -available: +lpoptions(1) +command, the following generic options are available:
-
-o media=size -

-Sets the page size to size. Most printers support at least -the size names "a4", "letter", and "legal". -
-o landscape -
-o orientation-requested=4 -

-Prints the job in landscape (rotated 90 degrees). -
-o sides=one-sided -
-o sides=two-sided-long-edge -
-o sides=two-sided-short-edge -

-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. -
-o fit-to-page -

-Scales the print file to fit on the page. -
-o number-up=2 -
-o number-up=4 -
-o number-up=6 -
-o number-up=9 -
-o number-up=16 -

-Prints multiple document pages on each output page. -
-o cpi=N -

-Sets the number of characters per inch to use when printing a -text file. The default is 10. -
-o lpi=N -

-Sets the number of lines per inch to use when printing a text -file. The default is 6. -
-o page-bottom=N -
-o page-left=N -
-o page-right=N -
-o page-top=N -

-Sets the page margins when printing text files. The values are in -points - there are 72 points to the inch. +
-o media=size +
Sets the page size to size. Most printers support at least the size names "a4", "letter", and "legal". +
-o orientation-requested=4 +
Prints the job in landscape (rotated 90 degrees). +
-o sides=one-sided +
Prints on one side of the paper. +
-o sides=two-sided-long-edge +
Prints on both sides of the paper for portrait output. +
-o sides=two-sided-short-edge +
Prints on both sides of the paper for landscape output. +
-o fit-to-page +
Scales the print file to fit on the page. +
-o number-up={2|4|6|9|16} +
Prints 2, 4, 6, 9, or 16 document (input) pages on each output page.
+

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 not case-sensitive. +

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).

Examples

-Print a double-sided legal document to a printer called "foo": +Print two copies of a document to the default printer: 
-    lp -d foo -o media=legal -o sides=two-sided-long-edge filename
+
+    lp -n 2 filename
+
-

Print an image across 4 pages: +Print a double-sided legal document to a printer called "foo": 

-    lp -d bar -o scaling=200 filename
+
+    lp -d foo -o media=legal -o sides=two-sided-long-edge filename
+
-

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": 

-    lp -d bar -o cpi=12 -o lpi=8 -o page-left=72 filename
+
+    lp -d foo -o number-up=2 filename
-

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 not case-sensitive. -

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).

See Also

-cancel(1), lpadmin(8), lpmove(8), lpoptions(1), -lpstat(1), -
-http://localhost:631/help +cancel(1), +lpadmin(8), +lpoptions(1), +lpq(1), +lpr(1), +lprm(1), +lpstat(1), +CUPS Online Help (http://localhost:631/help)

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. 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

Synopsis

lpadmin -[ -E ] [-U +[ +-E +] [ +-U username -] [ -h -server[:port] -] -d +] [ +-h server[:port] +] +-d destination
lpadmin -[ -E ] [-U +[ +-E +] [ +-U username -] [ -h -server[:port] -] -p +] [ +-h server[:port] +] +-p destination -[ -R +[ +-R name-default ] option(s)
lpadmin -[ -E ] [-U +[ +-E +] [ +-U username -] [ -h -server[:port] -] -x +] [ +-h server[:port] +] +-x destination

Description

-lpadmin configures printer and class queues provided by -CUPS. It can also be used to set the server default printer or -class. -

When specified before the -d, -p, or -x -options, the -E option forces encryption when connecting to -the server. -

The first form of the command (-d) sets the default printer -or class to destination. Subsequent print jobs submitted -via the lp(1) or lpr(1) commands will use this -destination unless the user specifies otherwise with the -lpoptions(1) command. -

The second form of the command (-p) configures the named -printer or class. The additional options are described below. -

The third form of the command (-x) deletes the printer or -class destination. Any jobs that are pending for the -destination will be removed and any job that is currently printed -will be aborted. -

Configuration Options

-The following options are recognized when configuring a printer -queue: +lpadmin configures printer and class queues provided by CUPS. +It can also be used to set the server default printer or class. +

When specified before the -d, -p, or -x options, the -E option forces encryption when connecting to the server. +

The first form of the command (-d) sets the default printer or class to destination. +Subsequent print jobs submitted via the +lp(1) +or +lpr(1) +commands will use this destination unless the user specifies otherwise with the +lpoptions(1) +command. +

The second form of the command (-p) configures the named printer or class. The additional options are described below. +

The third form of the command (-x) deletes the printer or class destination. +Any jobs that are pending for the destination will be removed and any job that is currently printed will be aborted. +

Options

+The following options are recognized when configuring a printer queue:
-
-c class -

-Adds the named printer to class. If class does -not exist it is created automatically. -
-i interface -

-Sets a System V style interface script for the printer. This -option cannot be specified with the -P option (PPD file) -and is intended for providing support for legacy printer drivers. -
-m model -

-Sets a standard System V interface script or PPD file for the printer from the -model directory or using one of the driver interfaces. Use the -m -option with the lpinfo(8) command to get a list of supported models. -
-o cupsIPPSupplies=true -
-o cupsIPPSupplies=false -

-Specifies whether IPP supply level values should be reported. -
-o cupsSNMPSupplies=true -
-o cupsSNMPSupplies=false -

-Specifies whether SNMP supply level (RFC 3805) values should be reported. -
-o job-k-limit=value -

-Sets the kilobyte limit for per-user quotas. The value is an -integer number of kilobytes; one kilobyte is 1024 bytes. -
-o job-page-limit=value -

-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. -
-o job-quota-period=value -

-Sets the accounting period for per-user quotas. The value is an -integer number of seconds; 86,400 seconds are in one day. -
-o job-sheets-default=banner -
-o job-sheets-default=banner,banner -

-Sets the default banner page(s) to use for print jobs. -
-o name=value -

-Sets a PPD option for the printer. PPD options can be listed using the -l -option with the lpoptions(1) command. -
-o name-default=value -

-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. -
-o port-monitor=name -

-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. -
-o printer-error-policy=name -

-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 +
-c class +
Adds the named printer to class. +If class does not exist it is created automatically. +
-i interface +
Sets a System V style interface script for the printer. +This option cannot be specified with the -P option (PPD file) and is intended for providing support for legacy printer drivers. +
-m model +
Sets a standard System V interface script or PPD file for the printer from the model directory or using one of the driver interfaces. +Use the -m option with the +lpinfo(8) +command to get a list of supported models. +
-o cupsIPPSupplies=true +
-o cupsIPPSupplies=false +
Specifies whether IPP supply level values should be reported. +
-o cupsSNMPSupplies=true +
-o cupsSNMPSupplies=false +
Specifies whether SNMP supply level (RFC 3805) values should be reported. +
-o job-k-limit=value +
Sets the kilobyte limit for per-user quotas. +The value is an integer number of kilobytes; one kilobyte is 1024 bytes. +
-o job-page-limit=value +
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. +
-o job-quota-period=value +
Sets the accounting period for per-user quotas. +The value is an integer number of seconds; 86,400 seconds are in one day. +
-o job-sheets-default=banner +
-o job-sheets-default=banner,banner +
Sets the default banner page(s) to use for print jobs. +
-o name=value +
Sets a PPD option for the printer. +PPD options can be listed using the -l option with the +lpoptions(1) +command. +
-o name-default=value +
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. +
-o port-monitor=name +
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. +
-o printer-error-policy=name +
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. -
-o printer-is-shared=true/false -

-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 -cupsd.conf, while unshared/unpublished destinations are not -announced. The default value is "true". -
-o printer-op-policy=name -

-Sets the IPP operation policy associated with the destination. The -name must be defined in the cupsd.conf in a Policy section. +
-o printer-is-shared=true +
-o printer-is-shared=false +
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 cupsd.conf, while unshared/unpublished destinations are not announced. +The default value is "true". +
-o printer-op-policy=name +
Sets the IPP operation policy associated with the destination. +The name must be defined in the cupsd.conf in a Policy section. The default operation policy is "default". -
-R name-default -

-Deletes the named option from printer. -
-r class -

-Removes the named printer from class. If the -resulting class becomes empty it is removed. -
-u allow:user,user,@group -
-u deny:user,user,@group -
-u allow:all -
-u deny:none -

-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. -
-v "device-uri" -

-Sets the device-uri attribute of the printer queue. Use the -v -option with the lpinfo(8) command to get a list of supported device URIs -and schemes. -
-D "info" -

-Provides a textual description of the destination. -
-E -

-Enables the destination and accepts jobs; this is the same as running the -cupsaccept(8) and cupsenable(8) programs on the destination. -
-L "location" -

-Provides a textual location of the destination. -
-P ppd-file -

-Specifies a PostScript Printer Description file to use with the -printer. If specified, this option overrides the -i option -(interface script). +
-R name-default +
Deletes the named option from printer. +
-r class +
Removes the named printer from class. +If the resulting class becomes empty it is removed. +
-u allow:{user|@group}{,user|,@group}* +
-u deny:{user|@group}{,user|,@group}* +
-u allow:all +
-u deny:none +
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. +
-v "device-uri" +
Sets the device-uri attribute of the printer queue. +Use the -v option with the +lpinfo(8) +command to get a list of supported device URIs and schemes. +
-D "info" +
Provides a textual description of the destination. +
-E +
Enables the destination and accepts jobs; this is the same as running the +cupsaccept(8) +and +cupsenable(8) +programs on the destination. +
-L "location" +
Provides a textual location of the destination. +
-P ppd-file +
Specifies a PostScript Printer Description file to use with the printer. +If specified, this option overrides the -i option (interface script).
-

Compatibility

-Unlike the System V printing system, CUPS allows printer names to -contain any printable character except SPACE, TAB, "/", or "#". +

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 not case-sensitive. -Finally, the CUPS version of lpadmin 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. -

Limitations

-The CUPS version of lpadmin does not support all of the -System V or Solaris printing system configuration options. +Finally, the CUPS version of lpadmin 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. +

Notes

+The CUPS version of lpadmin does not support all of the System V or Solaris printing system configuration options.

See Also

-cupsaccept(8), cupsenable(8), lpinfo(8), -lpoptions(1), -
-http://localhost:631/help +cupsaccept(8), +cupsenable(8), +lpinfo(8), +lpoptions(1), +CUPS Online Help (http://localhost:631/help)

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. 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

Synopsis

lpr -[ -E ] [ -H -server[:port] -] [ -U +[ +-E +] [ +-H server[:port] +] [ +-U username -] [ -P -destination[/instance] -] [ -# +] [ +-P destination[/instance] +] [ +-# num-copies -[ -h ] [ -l ] [ -m ] [ -o -option[=value] -] [ -p] [ -q ] [ -r ] [ -C/J/T +[ +-h +] [ +-l +] [ +-m +] [ +-o option[=value] +] [ +-p +] [ +-q +] [ +-r +] [ +-C +title +] [ +-J +title +] [ +-T title ] [ file(s) ]

Description

-lpr 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, -lpr reads the print file from the standard input. -

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 lpoptions(1) command is used, -followed by the default set using the lpadmin(8) command. +lpr 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, lpr reads the print file from the standard input. +

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 +lpoptions(1) +command is used, followed by the default set using the +lpadmin(8) +command.

Options

The following options are recognized by lpr:
-
-E -

-Forces encryption when connecting to the server. -
-H server[:port] -

-Specifies an alternate server. -
-C "name" -
-J "name" -
-T "name" -

-Sets the job name. -
-P destination[/instance] -

-Prints files to the named printer. -
-U username -

-Specifies an alternate username. -
-# copies -

-Sets the number of copies to print from 1 to 100. -
-h -

-Disables banner printing. This option is equivalent to "-o -job-sheets=none". -
-l -

-Specifies that the print file is already formatted for the -destination and should be sent without filtering. This option is -equivalent to "-o raw". -
-m -

-Send an email on job completion. -
-o option[=value] -

-Sets a job option. -
-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 "-o prettyprint" and is only useful when -printing text files. -
-q -

-Hold job for printing. -
-r -

-Specifies that the named print files should be deleted after -printing them. +
-E +
Forces encryption when connecting to the server. +
-H server[:port] +
Specifies an alternate server. +
-C "name" +
-J "name" +
-T "name" +
Sets the job name/title. +
-P destination[/instance] +
Prints files to the named printer. +
-U username +
Specifies an alternate username. +
-# copies +
Sets the number of copies to print. +
-h +
Disables banner printing. This option is equivalent to -o job-sheets=none. +
-l +
Specifies that the print file is already formatted for the destination and should be sent without filtering. +This option is equivalent to -o raw. +
-m +
Send an email on job completion. +
-o option[=value] +
Sets a job option. +
-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 -o prettyprint and is only useful when printing text files. +
-q +
Hold job for printing. +
-r +
Specifies that the named print files should be deleted after submitting them.
-

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. +

Notes

+The -c, -d, -f, -g, -i, -n, -t, -v, and -w options are not supported by CUPS and produce a warning message if used. +

Examples

+Print two copies of a document to the default printer: +
+
+    lpr -# 2 filename
+
+
+Print a double-sided legal document to a printer called "foo": +
+
+    lpr -P foo -o media=legal -o sides=two-sided-long-edge filename
+
+
+Print a presentation document 2-up to a printer called "foo": +
+
+    lpr -P foo -o number-up=2 filename
+

See Also

-cancel(1), lp(1), lpadmin(8), lpoptions(1), -lpq(1), lprm(1), lpstat(1), -
-http://localhost:631/help +cancel(1), +lp(1), +lpadmin(8), +lpoptions(1), +lpq(1), +lprm(1), +lpstat(1), +CUPS Online Help (http://localhost:631/help)

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. 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$". .\"