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

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<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>[ -E ] [ -U
<i>username
</i>] [ -c ] [ -d
<i>destination[/instance]
</i>] [ -h
<i>hostname[:port]
</i>] [ -m ] [ -n
<i>num-copies
</i>] [ -o
<i>option[=value]
</i>] [ -q
<i>priority
</i>] [ -s ] [ -t
<i>title
</i>] [ -H
<i>handling
</i>] [ -P
<i>page-list
</i>] [ -- ] [
<i>file(s)
</i>]
<br>
<b>lp
</b>[ -E ] [ -U
<i>username
</i>] [ -c ] [ -h
<i>hostname[:port]
</i>] [ -i
<i>job-id
</i>] [ -n
<i>num-copies
</i>] [ -o
<i>option[=value]
</i>] [ -q
<i>priority
</i>] [ -t
<i>title
</i>] [ -H
<i>handling
</i>] [ -P
<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 <a href='man-lpoptions.html?TOPIC=Man+Pages'>lpoptions(1)</a> command is used,
followed by the default set using the <a href='man-lpadmin.html?TOPIC=Man+Pages'>lpadmin(8)</a> command.
<h2 class="title"><a name="OPTIONS">Options</a></h2>
The following options are recognized by <i>lp</i>:
<dl>
<dt>--
</dt>
<dd></dd>
<dd>Marks the end of options; use this to print a file whose name
begins with a dash (-).
</dd>
<dt>-E
</dt>
<dd></dd>
<dd>Forces encryption when connecting to the server.
</dd>
<dt>-U username
</dt>
<dd></dd>
<dd>Specifies the username to use when connecting to the server.
</dd>
<dt>-c
</dt>
<dd></dd>
<dd>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.
</dd>
<dt>-d destination
</dt>
<dd></dd>
<dd>Prints files to the named printer.
</dd>
<dt>-h hostname[:port]
</dt>
<dd></dd>
<dd>Chooses an alternate server.
</dd>
<dt>-i job-id
</dt>
<dd></dd>
<dd>Specifies an existing job to modify.
</dd>
<dt>-m
</dt>
<dd></dd>
<dd>Sends an email when the job is completed.
</dd>
<dt>-n copies
</dt>
<dd></dd>
<dd>Sets the number of copies to print from 1 to 100.
</dd>
<dt>-o "name=value [name=value ...]"
</dt>
<dd></dd>
<dd>Sets one or more job options.
</dd>
<dt>-q priority
</dt>
<dd></dd>
<dd>Sets the job priority from 1 (lowest) to 100 (highest). The
default priority is 50.
</dd>
<dt>-s
</dt>
<dd></dd>
<dd>Do not report the resulting job IDs (silent mode.)
</dd>
<dt>-t "name"
</dt>
<dd></dd>
<dd>Sets the job name.
</dd>
<dt>-H hh:mm
</dt>
<dd></dd>
<dt>-H hold
</dt>
<dd></dd>
<dt>-H immediate
</dt>
<dd></dd>
<dt>-H restart
</dt>
<dd></dd>
<dt>-H resume
</dt>
<dd></dd>
<dd>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.
</dd>
<dt>-P page-list
</dt>
<dd></dd>
<dd>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.
</dd>
</dl>
<h2 class="title"><a name="COMMON_JOB_OPTIONS">Common Job Options</a></h2>
Aside from the printer-specific options reported by the
<a href='man-lpoptions.html?TOPIC=Man+Pages'>lpoptions(1)</a> command, the following generic options are
available:
<dl>
<dt>-o media=size
</dt>
<dd></dd>
<dd>Sets the page size to <i>size</i>. Most printers support at least
the size names "a4", "letter", and "legal".
</dd>
<dt>-o landscape
</dt>
<dd></dd>
<dt>-o orientation-requested=4
</dt>
<dd></dd>
<dd>Prints the job in landscape (rotated 90 degrees).
</dd>
<dt>-o sides=one-sided
</dt>
<dd></dd>
<dt>-o sides=two-sided-long-edge
</dt>
<dd></dd>
<dt>-o sides=two-sided-short-edge
</dt>
<dd></dd>
<dd>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.
</dd>
<dt>-o fit-to-page
</dt>
<dd></dd>
<dd>Scales the print file to fit on the page.
</dd>
<dt>-o number-up=2
</dt>
<dd></dd>
<dt>-o number-up=4
</dt>
<dd></dd>
<dt>-o number-up=6
</dt>
<dd></dd>
<dt>-o number-up=9
</dt>
<dd></dd>
<dt>-o number-up=16
</dt>
<dd></dd>
<dd>Prints multiple document pages on each output page.
</dd>
<dt>-o cpi=N
</dt>
<dd></dd>
<dd>Sets the number of characters per inch to use when printing a
text file. The default is 10.
</dd>
<dt>-o lpi=N
</dt>
<dd></dd>
<dd>Sets the number of lines per inch to use when printing a text
file. The default is 6.
</dd>
<dt>-o page-bottom=N
</dt>
<dd></dd>
<dt>-o page-left=N
</dt>
<dd></dd>
<dt>-o page-right=N
</dt>
<dd></dd>
<dt>-o page-top=N
</dt>
<dd></dd>
<dd>Sets the page margins when printing text files. The values are in
points - there are 72 points to the inch.
</dd>
</dl>
<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
Print a double-sided legal document to a printer called "foo":
<pre>
    lp -d foo -o media=legal -o sides=two-sided-long-edge filename
</pre>
<p>Print an image across 4 pages:
<pre>
    lp -d bar -o scaling=200 filename
</pre>
<p>Print a text file with 12 characters per inch, 8 lines per inch, and
a 1 inch left margin:
<pre>
    lp -d bar -o cpi=12 -o lpi=8 -o page-left=72 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>
<a href='man-cancel.html?TOPIC=Man+Pages'>cancel(1)</a>, <a href='man-lpadmin.html?TOPIC=Man+Pages'>lpadmin(8)</a>, <a href='man-lpmove.html?TOPIC=Man+Pages'>lpmove(8)</a>, <a href='man-lpoptions.html?TOPIC=Man+Pages'>lpoptions(1)</a>,
<a href='man-lpstat.html?TOPIC=Man+Pages'>lpstat(1)</a>,
<br>
<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.

</body>
</html>
Commit	Line	Data
	1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	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>
	13	<b>lp
	14	</b>[ -E ] [ -U
	15	<i>username
	16	</i>] [ -c ] [ -d
	17	<i>destination[/instance]
	18	</i>] [ -h
	19	<i>hostname[:port]
	20	</i>] [ -m ] [ -n
	21	<i>num-copies
	22	</i>] [ -o
	23	<i>option[=value]
	24	</i>] [ -q
	25	<i>priority
	26	</i>] [ -s ] [ -t
	27	<i>title
	28	</i>] [ -H
	29	<i>handling
	30	</i>] [ -P
	31	<i>page-list
	32	</i>] [ -- ] [
	33	<i>file(s)
	34	</i>]
	35	<br>
	36	<b>lp
	37	</b>[ -E ] [ -U
	38	<i>username
	39	</i>] [ -c ] [ -h
	40	<i>hostname[:port]
	41	</i>] [ -i
	42	<i>job-id
	43	</i>] [ -n
	44	<i>num-copies
	45	</i>] [ -o
	46	<i>option[=value]
	47	</i>] [ -q
	48	<i>priority
	49	</i>] [ -t
	50	<i>title
	51	</i>] [ -H
	52	<i>handling
	53	</i>] [ -P
	54	<i>page-list
	55	</i>]
	56	<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
	57	<i>lp</i> submits files for printing or alters a pending job. Use
	58	a filename of "-" to force printing from the standard input.
	59	<h2 class="title"><a name="THE_DEFAULT_DESTINATION">The Default Destination</a></h2>
	60	CUPS provides many ways to set the default destination. The "LPDEST" and
	61	"PRINTER" environment variables are consulted first. If neither are set,
	62	the current default set using the <a href='man-lpoptions.html?TOPIC=Man+Pages'>lpoptions(1)</a> command is used,
	63	followed by the default set using the <a href='man-lpadmin.html?TOPIC=Man+Pages'>lpadmin(8)</a> command.
	64	<h2 class="title"><a name="OPTIONS">Options</a></h2>
	65	The following options are recognized by <i>lp</i>:
	66	<dl>
	67	<dt>--
	68	</dt>
	69	<dd></dd>
	70	<dd>Marks the end of options; use this to print a file whose name
	71	begins with a dash (-).
	72	</dd>
	73	<dt>-E
	74	</dt>
	75	<dd></dd>
	76	<dd>Forces encryption when connecting to the server.
	77	</dd>
	78	<dt>-U username
	79	</dt>
	80	<dd></dd>
	81	<dd>Specifies the username to use when connecting to the server.
	82	</dd>
	83	<dt>-c
	84	</dt>
	85	<dd></dd>
	86	<dd>This option is provided for backwards-compatibility only. On
	87	systems that support it, this option forces the print file to be
	88	copied to the spool directory before printing. In CUPS, print
	89	files are always sent to the scheduler via IPP which has the
	90	same effect.
	91	</dd>
	92	<dt>-d destination
	93	</dt>
	94	<dd></dd>
	95	<dd>Prints files to the named printer.
	96	</dd>
	97	<dt>-h hostname[:port]
	98	</dt>
	99	<dd></dd>
	100	<dd>Chooses an alternate server.
	101	</dd>
	102	<dt>-i job-id
	103	</dt>
	104	<dd></dd>
	105	<dd>Specifies an existing job to modify.
	106	</dd>
	107	<dt>-m
	108	</dt>
	109	<dd></dd>
	110	<dd>Sends an email when the job is completed.
	111	</dd>
	112	<dt>-n copies
	113	</dt>
	114	<dd></dd>
	115	<dd>Sets the number of copies to print from 1 to 100.
	116	</dd>
	117	<dt>-o "name=value [name=value ...]"
	118	</dt>
	119	<dd></dd>
	120	<dd>Sets one or more job options.
	121	</dd>
	122	<dt>-q priority
	123	</dt>
	124	<dd></dd>
	125	<dd>Sets the job priority from 1 (lowest) to 100 (highest). The
	126	default priority is 50.
	127	</dd>
	128	<dt>-s
	129	</dt>
	130	<dd></dd>
	131	<dd>Do not report the resulting job IDs (silent mode.)
	132	</dd>
	133	<dt>-t "name"
	134	</dt>
	135	<dd></dd>
	136	<dd>Sets the job name.
	137	</dd>
	138	<dt>-H hh:mm
	139	</dt>
	140	<dd></dd>
	141	<dt>-H hold
	142	</dt>
	143	<dd></dd>
	144	<dt>-H immediate
	145	</dt>
	146	<dd></dd>
	147	<dt>-H restart
	148	</dt>
	149	<dd></dd>
	150	<dt>-H resume
	151	</dt>
	152	<dd></dd>
	153	<dd>Specifies when the job should be printed. A value of <i>immediate</i> will print
	154	the file immediately, a value of <i>hold</i> will hold the job indefinitely, and
	155	a UTC time value (HH:MM) will hold the job until the specified UTC (not local)
	156	time. Use a value of <i>resume</i> with the <i>-i</i> option to resume a held job.
	157	Use a value of <i>restart</i> with the <i>-i</i> option to restart
	158	a completed job.
	159	</dd>
	160	<dt>-P page-list
	161	</dt>
	162	<dd></dd>
	163	<dd>Specifies which pages to print in the document. The list can
	164	contain a list of numbers and ranges (#-#) separated by commas
	165	(e.g. 1,3-5,16). The page numbers refer to the output pages and
	166	not the document's original pages - options like "number-up" can
	167	affect the numbering of the pages.
	168	</dd>
	169	</dl>
	170	<h2 class="title"><a name="COMMON_JOB_OPTIONS">Common Job Options</a></h2>
	171	Aside from the printer-specific options reported by the
	172	<a href='man-lpoptions.html?TOPIC=Man+Pages'>lpoptions(1)</a> command, the following generic options are
	173	available:
	174	<dl>
	175	<dt>-o media=size
	176	</dt>
	177	<dd></dd>
	178	<dd>Sets the page size to <i>size</i>. Most printers support at least
	179	the size names "a4", "letter", and "legal".
	180	</dd>
	181	<dt>-o landscape
	182	</dt>
	183	<dd></dd>
	184	<dt>-o orientation-requested=4
	185	</dt>
	186	<dd></dd>
	187	<dd>Prints the job in landscape (rotated 90 degrees).
	188	</dd>
	189	<dt>-o sides=one-sided
	190	</dt>
	191	<dd></dd>
	192	<dt>-o sides=two-sided-long-edge
	193	</dt>
	194	<dd></dd>
	195	<dt>-o sides=two-sided-short-edge
	196	</dt>
	197	<dd></dd>
	198	<dd>Prints on one or two sides of the paper. The value
	199	"two-sided-long-edge" is normally used when printing portrait
	200	(unrotated) pages, while "two-sided-short-edge" is used for
	201	landscape pages.
	202	</dd>
	203	<dt>-o fit-to-page
	204	</dt>
	205	<dd></dd>
	206	<dd>Scales the print file to fit on the page.
	207	</dd>
	208	<dt>-o number-up=2
	209	</dt>
	210	<dd></dd>
	211	<dt>-o number-up=4
	212	</dt>
	213	<dd></dd>
	214	<dt>-o number-up=6
	215	</dt>
	216	<dd></dd>
	217	<dt>-o number-up=9
	218	</dt>
	219	<dd></dd>
	220	<dt>-o number-up=16
	221	</dt>
	222	<dd></dd>
	223	<dd>Prints multiple document pages on each output page.
	224	</dd>
	225	<dt>-o cpi=N
	226	</dt>
	227	<dd></dd>
	228	<dd>Sets the number of characters per inch to use when printing a
	229	text file. The default is 10.
	230	</dd>
	231	<dt>-o lpi=N
	232	</dt>
	233	<dd></dd>
	234	<dd>Sets the number of lines per inch to use when printing a text
	235	file. The default is 6.
	236	</dd>
	237	<dt>-o page-bottom=N
	238	</dt>
	239	<dd></dd>
	240	<dt>-o page-left=N
	241	</dt>
	242	<dd></dd>
	243	<dt>-o page-right=N
	244	</dt>
	245	<dd></dd>
	246	<dt>-o page-top=N
	247	</dt>
	248	<dd></dd>
	249	<dd>Sets the page margins when printing text files. The values are in
	250	points - there are 72 points to the inch.
	251	</dd>
	252	</dl>
	253	<h2 class="title"><a name="EXAMPLES">Examples</a></h2>
	254	Print a double-sided legal document to a printer called "foo":
	255	<pre>
	256	lp -d foo -o media=legal -o sides=two-sided-long-edge filename
	257	</pre>
	258	<p>Print an image across 4 pages:
	259	<pre>
	260	lp -d bar -o scaling=200 filename
	261	</pre>
	262	<p>Print a text file with 12 characters per inch, 8 lines per inch, and
	263	a 1 inch left margin:
	264	<pre>
	265	lp -d bar -o cpi=12 -o lpi=8 -o page-left=72 filename
	266	</pre>
	267	<h2 class="title"><a name="COMPATIBILITY">Compatibility</a></h2>
	268	Unlike the System V printing system, CUPS allows printer names to
	269	contain any printable character except SPACE, TAB, "/", or "#".
	270	Also, printer and class names are <i>not</i> case-sensitive.
	271	<p>The "q" option accepts a different range of values than the
	272	Solaris lp command, matching the IPP job priority values (1-100,
	273	100 is highest priority) instead of the Solaris values (0-39, 0
	274	is highest priority).
	275	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
	276	<a href='man-cancel.html?TOPIC=Man+Pages'>cancel(1)</a>, <a href='man-lpadmin.html?TOPIC=Man+Pages'>lpadmin(8)</a>, <a href='man-lpmove.html?TOPIC=Man+Pages'>lpmove(8)</a>, <a href='man-lpoptions.html?TOPIC=Man+Pages'>lpoptions(1)</a>,
	277	<a href='man-lpstat.html?TOPIC=Man+Pages'>lpstat(1)</a>,
	278	<br>
	279	<a href='http://localhost:631/help'>http://localhost:631/help</a>
	280	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
	281	Copyright 2007-2013 by Apple Inc.
	282
	283	</body>
	284	</html>