[thirdparty/cups.git] / doc / help / man-lp.html

<!DOCTYPE HTML>
<html>
<!-- SECTION: Man Pages -->
<head>
	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	<title>lp(1)</title>
</head>
<body>
<h1 class="title">lp(1)</h1>
<h2 class="title"><a name="NAME">Name</a></h2>
lp - print files
<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
<b>lp</b>
[
<b>-E</b>
] [
<b>-U</b>
<i>username</i>
] [
<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>
] [
<b>-o </b><i>option</i>[<b>=</b><i>value</i>]
] [
<b>-q</b>
<i>priority</i>
] [
<b>-s</b>
] [
<b>-t</b>
<i>title</i>
] [
<b>-H</b>
<i>handling</i>
] [
<b>-P</b>
<i>page-list</i>
] [
<b>--</b>
] [
<i>file(s)</i>
]
<br>
<b>lp</b>
[
<b>-E</b>
] [
<b>-U</b>
<i>username</i>
] [
<b>-c</b>
] [
<b>-h </b><i>hostname</i>[<b>:</b><i>port</i>]
] [
<b>-i</b>
<i>job-id</i>
] [
<b>-n</b>
<i>num-copies</i>
] [
<b>-o </b><i>option</i>[<b>=</b><i>value</i>]
] [
<b>-q</b>
<i>priority</i>
] [
<b>-t</b>
<i>title</i>
] [
<b>-H</b>
<i>handling</i>
] [
<b>-P</b>
<i>page-list</i>
]
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<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
<b>lpoptions</b>(1)
command is used, followed by the default set using the
<b>lpadmin</b>(8)
command.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The following options are recognized by <i>lp</i>:
<dl class="man">
<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.
See "COMMON JOB OPTIONS" below.
<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>
<h3><a name="COMMON_JOB_OPTIONS">Common Job Options</a></h3>
Aside from the printer-specific options reported by the
<b>lpoptions</b>(1)
command, the following generic options are available:
<dl class="man">
<dt><b>-o job-sheets=</b><i>name</i>
<dd style="margin-left: 5.0em">Prints a cover page (banner) with the document.
The "name" can be "classified", "confidential", "secret", "standard", "topsecret", or "unclassified".
<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 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.
<dt><b>-o orientation-requested=4</b>
<dd style="margin-left: 5.0em">Prints the job in landscape (rotated 90 degrees counter-clockwise).
<dt><b>-o orientation-requested=5</b>
<dd style="margin-left: 5.0em">Prints the job in landscape (rotated 90 degrees clockwise).
<dt><b>-o orientation-requested=6</b>
<dd style="margin-left: 5.0em">Prints the job in reverse portrait (rotated 180 degrees).
<dt><b>-o print-quality=3</b>
<dd style="margin-left: 5.0em"><dt><b>-o print-quality=4</b>
<dd style="margin-left: 5.0em"><dt><b>-o print-quality=5</b>
<dd style="margin-left: 5.0em">Specifies the output quality - draft (3), normal (4), or best (5).
<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.
</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 two copies of a document to the default printer:
<pre class="man">

    lp -n 2 filename

</pre>
Print a double-sided legal document to a printer called "foo":
<pre class="man">

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

</pre>
Print a presentation document 2-up to a printer called "bar":
<pre class="man">

    lp -d bar -o number-up=2 filename
</pre>
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<b>cancel</b>(1),
<b>lpadmin</b>(8),
<b>lpoptions</b>(1),
<b>lpq</b>(1),
<b>lpr</b>(1),
<b>lprm</b>(1),
<b>lpstat</b>(1),
CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright &copy; 2007-2019 by Apple Inc.

</body>
</html>
Commit	Line	Data
c277f98c	1	<!DOCTYPE HTML>
94436c5a MS	2	<html>
	3	<!-- SECTION: Man Pages -->
	4	<head>
	5	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	6	<title>lp(1)</title>
	7	</head>
	8	<body>
	9	<h1 class="title">lp(1)</h1>
	10	<h2 class="title"><a name="NAME">Name</a></h2>
	11	lp - print files
	12	<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
c277f98c	13	<b>lp</b>
cfa19b58 MS	14	[
	15	<b>-E</b>
	16	] [
	17	<b>-U</b>
c277f98c	18	<i>username</i>
cfa19b58 MS	19	] [
	20	<b>-c</b>
	21	] [
	22	<b>-d </b><i>destination</i>[<b>/</b><i>instance</i>]
	23	] [
	24	<b>-h </b><i>hostname</i>[<b>:</b><i>port</i>]
	25	] [
	26	<b>-m</b>
	27	] [
	28	<b>-n</b>
c277f98c	29	<i>num-copies</i>
cfa19b58 MS	30	] [
	31	<b>-o </b><i>option</i>[<b>=</b><i>value</i>]
	32	] [
	33	<b>-q</b>
c277f98c	34	<i>priority</i>
cfa19b58 MS	35	] [
	36	<b>-s</b>
	37	] [
	38	<b>-t</b>
c277f98c	39	<i>title</i>
cfa19b58 MS	40	] [
cfa19b58 MS	41	<b>-H</b>
c277f98c	42	<i>handling</i>
cfa19b58 MS	43	] [
cfa19b58 MS	44	<b>-P</b>
c277f98c	45	<i>page-list</i>
cfa19b58 MS	46	] [
	47	<b>--</b>
	48	] [
c277f98c MS	49	<i>file(s)</i>
	50	]
	51	<br>
	52	<b>lp</b>
cfa19b58 MS	53	[
	54	<b>-E</b>
	55	] [
	56	<b>-U</b>
c277f98c	57	<i>username</i>
cfa19b58 MS	58	] [
	59	<b>-c</b>
	60	] [
	61	<b>-h </b><i>hostname</i>[<b>:</b><i>port</i>]
	62	] [
	63	<b>-i</b>
c277f98c	64	<i>job-id</i>
cfa19b58 MS	65	] [
cfa19b58 MS	66	<b>-n</b>
c277f98c	67	<i>num-copies</i>
cfa19b58 MS	68	] [
	69	<b>-o </b><i>option</i>[<b>=</b><i>value</i>]
	70	] [
	71	<b>-q</b>
c277f98c	72	<i>priority</i>
cfa19b58 MS	73	] [
cfa19b58 MS	74	<b>-t</b>
c277f98c	75	<i>title</i>
cfa19b58 MS	76	] [
cfa19b58 MS	77	<b>-H</b>
c277f98c	78	<i>handling</i>
cfa19b58 MS	79	] [
cfa19b58 MS	80	<b>-P</b>
c277f98c MS	81	<i>page-list</i>
c277f98c MS	82	]
94436c5a	83	<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
cfa19b58 MS	84	<b>lp</b> submits files for printing or alters a pending job.
	85	Use a filename of "-" to force printing from the standard input.
	86	<h3><a name="THE_DEFAULT_DESTINATION">The Default Destination</a></h3>
	87	CUPS provides many ways to set the default destination. The <b>LPDEST</b> and <b>PRINTER</b> environment variables are consulted first.
	88	If neither are set, the current default set using the
696f74ae	89	<b>lpoptions</b>(1)
cfa19b58	90	command is used, followed by the default set using the
87030afb	91	<b>lpadmin</b>(8)
cfa19b58	92	command.
94436c5a MS	93	<h2 class="title"><a name="OPTIONS">Options</a></h2>
94436c5a MS	94	The following options are recognized by <i>lp</i>:
2909c66c	95	<dl class="man">
cfa19b58 MS	96	<dt><b>--</b>
	97	<dd style="margin-left: 5.0em">Marks the end of options; use this to print a file whose name begins with a dash (-).
	98	<dt><b>-E</b>
	99	<dd style="margin-left: 5.0em">Forces encryption when connecting to the server.
	100	<dt><b>-U </b><i>username</i>
	101	<dd style="margin-left: 5.0em">Specifies the username to use when connecting to the server.
	102	<dt><b>-c</b>
	103	<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.
	104	In CUPS, print files are always sent to the scheduler via IPP which has the same effect.
	105	<dt><b>-d </b><i>destination</i>
	106	<dd style="margin-left: 5.0em">Prints files to the named printer.
	107	<dt><b>-h </b><i>hostname</i>[<b>:</b><i>port</i>]
	108	<dd style="margin-left: 5.0em">Chooses an alternate server.
	109	<dt><b>-i </b><i>job-id</i>
	110	<dd style="margin-left: 5.0em">Specifies an existing job to modify.
	111	<dt><b>-m</b>
	112	<dd style="margin-left: 5.0em">Sends an email when the job is completed.
	113	<dt><b>-n </b><i>copies</i>
	114	<dd style="margin-left: 5.0em">Sets the number of copies to print.
	115	<dt><b>-o "</b><i>name</i><b>=</b><i>value </i>[ ... <i>name</i><b>=</b><i>value </i>]<b>"</b>
	116	<dd style="margin-left: 5.0em">Sets one or more job options.
423e6ddb	117	See "COMMON JOB OPTIONS" below.
cfa19b58 MS	118	<dt><b>-q </b><i>priority</i>
	119	<dd style="margin-left: 5.0em">Sets the job priority from 1 (lowest) to 100 (highest).
	120	The default priority is 50.
	121	<dt><b>-s</b>
	122	<dd style="margin-left: 5.0em">Do not report the resulting job IDs (silent mode.)
	123	<dt><b>-t "</b><i>name</i><b>"</b>
	124	<dd style="margin-left: 5.0em">Sets the job name.
	125	<dt><b>-H </b><i>hh:mm</i>
	126	<dd style="margin-left: 5.0em"><dt><b>-H hold</b>
	127	<dd style="margin-left: 5.0em"><dt><b>-H immediate</b>
	128	<dd style="margin-left: 5.0em"><dt><b>-H restart</b>
	129	<dd style="margin-left: 5.0em"><dt><b>-H resume</b>
	130	<dd style="margin-left: 5.0em">Specifies when the job should be printed.
	131	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.
	132	Use a value of <i>resume</i> with the <i>-i</i> option to resume a held job.
	133	Use a value of <i>restart</i> with the <i>-i</i> option to restart a completed job.
	134	<dt><b>-P </b><i>page-list</i>
	135	<dd style="margin-left: 5.0em">Specifies which pages to print in the document.
	136	The list can contain a list of numbers and ranges (#-#) separated by commas, e.g., "1,3-5,16".
	137	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.
2909c66c	138	</dl>
cfa19b58	139	<h3><a name="COMMON_JOB_OPTIONS">Common Job Options</a></h3>
94436c5a	140	Aside from the printer-specific options reported by the
696f74ae	141	<b>lpoptions</b>(1)
cfa19b58	142	command, the following generic options are available:
2909c66c	143	<dl class="man">
423e6ddb MS	144	<dt><b>-o job-sheets=</b><i>name</i>
	145	<dd style="margin-left: 5.0em">Prints a cover page (banner) with the document.
	146	The "name" can be "classified", "confidential", "secret", "standard", "topsecret", or "unclassified".
cfa19b58 MS	147	<dt><b>-o media=</b><i>size</i>
cfa19b58 MS	148	<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".
423e6ddb MS	149	<dt><b>-o number-up=</b>{<i>2\|4\|6\|9\|16</i>}
423e6ddb MS	150	<dd style="margin-left: 5.0em">Prints 2, 4, 6, 9, or 16 document (input) pages on each output page.
cfa19b58	151	<dt><b>-o orientation-requested=4</b>
423e6ddb MS	152	<dd style="margin-left: 5.0em">Prints the job in landscape (rotated 90 degrees counter-clockwise).
	153	<dt><b>-o orientation-requested=5</b>
	154	<dd style="margin-left: 5.0em">Prints the job in landscape (rotated 90 degrees clockwise).
	155	<dt><b>-o orientation-requested=6</b>
	156	<dd style="margin-left: 5.0em">Prints the job in reverse portrait (rotated 180 degrees).
51c22b86 MS	157	<dt><b>-o print-quality=3</b>
	158	<dd style="margin-left: 5.0em"><dt><b>-o print-quality=4</b>
	159	<dd style="margin-left: 5.0em"><dt><b>-o print-quality=5</b>
	160	<dd style="margin-left: 5.0em">Specifies the output quality - draft (3), normal (4), or best (5).
cfa19b58 MS	161	<dt><b>-o sides=one-sided</b>
	162	<dd style="margin-left: 5.0em">Prints on one side of the paper.
	163	<dt><b>-o sides=two-sided-long-edge</b>
	164	<dd style="margin-left: 5.0em">Prints on both sides of the paper for portrait output.
	165	<dt><b>-o sides=two-sided-short-edge</b>
	166	<dd style="margin-left: 5.0em">Prints on both sides of the paper for landscape output.
2909c66c	167	</dl>
cfa19b58 MS	168	<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
	169	Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", or "#".
	170	Also, printer and class names are <i>not</i> case-sensitive.
	171	<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).
94436c5a	172	<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
cfa19b58	173	Print two copies of a document to the default printer:
2909c66c	174	<pre class="man">
cfa19b58 MS	175
	176	lp -n 2 filename
	177
94436c5a	178	</pre>
cfa19b58	179	Print a double-sided legal document to a printer called "foo":
2909c66c	180	<pre class="man">
cfa19b58 MS	181
	182	lp -d foo -o media=legal -o sides=two-sided-long-edge filename
	183
94436c5a	184	</pre>
51c22b86	185	Print a presentation document 2-up to a printer called "bar":
2909c66c	186	<pre class="man">
cfa19b58	187
51c22b86	188	lp -d bar -o number-up=2 filename
94436c5a	189	</pre>
94436c5a	190	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
87030afb MS	191	<b>cancel</b>(1),
87030afb MS	192	<b>lpadmin</b>(8),
696f74ae	193	<b>lpoptions</b>(1),
87030afb MS	194	<b>lpq</b>(1),
	195	<b>lpr</b>(1),
	196	<b>lprm</b>(1),
	197	<b>lpstat</b>(1),
cfa19b58	198	CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
94436c5a	199	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
87030afb	200	Copyright © 2007-2019 by Apple Inc.
94436c5a MS	201
	202	</body>
	203	</html>