]> git.ipfire.org Git - thirdparty/cups.git/blob - man/lp.man
Changelog.
[thirdparty/cups.git] / man / lp.man
1 .\"
2 .\" "$Id$"
3 .\"
4 .\" lp man page for CUPS.
5 .\"
6 .\" Copyright 2007-2013 by Apple Inc.
7 .\" Copyright 1997-2006 by Easy Software Products.
8 .\"
9 .\" These coded instructions, statements, and computer programs are the
10 .\" property of Apple Inc. and are protected by Federal copyright
11 .\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 .\" which should have been included with this file. If this file is
13 .\" file is missing or damaged, see the license at "http://www.cups.org/".
14 .\"
15 .TH lp 1 "CUPS" "16 July 2012" "Apple Inc."
16 .SH NAME
17 lp - print files
18 .SH SYNOPSIS
19 .B lp
20 [ -E ] [ -U
21 .I username
22 ] [ -c ] [ -d
23 .I destination[/instance]
24 ] [ -h
25 .I hostname[:port]
26 ] [ -m ] [ -n
27 .I num-copies
28 ] [ -o
29 .I option[=value]
30 ] [ -q
31 .I priority
32 ] [ -s ] [ -t
33 .I title
34 ] [ -H
35 .I handling
36 ] [ -P
37 .I page-list
38 ] [ -- ] [
39 .I file(s)
40 ]
41 .br
42 .B lp
43 [ -E ] [ -U
44 .I username
45 ] [ -c ] [ -h
46 .I hostname[:port]
47 ] [ -i
48 .I job-id
49 ] [ -n
50 .I num-copies
51 ] [ -o
52 .I option[=value]
53 ] [ -q
54 .I priority
55 ] [ -t
56 .I title
57 ] [ -H
58 .I handling
59 ] [ -P
60 .I page-list
61 ]
62 .SH DESCRIPTION
63 \fIlp\fR submits files for printing or alters a pending job. Use
64 a filename of "-" to force printing from the standard input.
65 .SH THE DEFAULT DESTINATION
66 CUPS provides many ways to set the default destination. The "LPDEST" and
67 "PRINTER" environment variables are consulted first. If neither are set,
68 the current default set using the \fIlpoptions(1)\fR command is used,
69 followed by the default set using the \fIlpadmin(8)\fR command.
70 .SH OPTIONS
71 The following options are recognized by \fIlp\fR:
72 .TP 5
73 --
74 .br
75 Marks the end of options; use this to print a file whose name
76 begins with a dash (-).
77 .TP 5
78 -E
79 .br
80 Forces encryption when connecting to the server.
81 .TP 5
82 -U username
83 .br
84 Specifies the username to use when connecting to the server.
85 .TP 5
86 -c
87 .br
88 This option is provided for backwards-compatibility only. On
89 systems that support it, this option forces the print file to be
90 copied to the spool directory before printing. In CUPS, print
91 files are always sent to the scheduler via IPP which has the
92 same effect.
93 .TP 5
94 -d destination
95 .br
96 Prints files to the named printer.
97 .TP 5
98 -h hostname[:port]
99 .br
100 Chooses an alternate server.
101 .TP 5
102 -i job-id
103 .br
104 Specifies an existing job to modify.
105 .TP 5
106 -m
107 .br
108 Sends an email when the job is completed.
109 .TP 5
110 -n copies
111 .br
112 Sets the number of copies to print from 1 to 100.
113 .TP 5
114 -o "name=value [name=value ...]"
115 .br
116 Sets one or more job options.
117 .TP 5
118 -q priority
119 .br
120 Sets the job priority from 1 (lowest) to 100 (highest). The
121 default priority is 50.
122 .TP 5
123 -s
124 .br
125 Do not report the resulting job IDs (silent mode.)
126 .TP 5
127 -t "name"
128 .br
129 Sets the job name.
130 .TP 5
131 -H hh:mm
132 .TP 5
133 -H hold
134 .TP 5
135 -H immediate
136 .TP 5
137 -H restart
138 .TP 5
139 -H resume
140 .br
141 Specifies when the job should be printed. A value of \fIimmediate\fR will print
142 the file immediately, a value of \fIhold\fR will hold the job indefinitely, and
143 a UTC time value (HH:MM) will hold the job until the specified UTC (not local)
144 time. Use a value of \fIresume\fR with the \fI-i\fR option to resume a held job.
145 Use a value of \fIrestart\fR with the \fI-i\fR option to restart
146 a completed job.
147 .TP 5
148 -P page-list
149 .br
150 Specifies which pages to print in the document. The list can
151 contain a list of numbers and ranges (#-#) separated by commas
152 (e.g. 1,3-5,16). The page numbers refer to the output pages and
153 not the document's original pages - options like "number-up" can
154 affect the numbering of the pages.
155 .SH COMMON JOB OPTIONS
156 Aside from the printer-specific options reported by the
157 \fIlpoptions(1)\fR command, the following generic options are
158 available:
159 .TP 5
160 -o media=size
161 .br
162 Sets the page size to \fIsize\fR. Most printers support at least
163 the size names "a4", "letter", and "legal".
164 .TP 5
165 -o landscape
166 .TP 5
167 -o orientation-requested=4
168 .br
169 Prints the job in landscape (rotated 90 degrees).
170 .TP 5
171 -o sides=one-sided
172 .TP 5
173 -o sides=two-sided-long-edge
174 .TP 5
175 -o sides=two-sided-short-edge
176 .br
177 Prints on one or two sides of the paper. The value
178 "two-sided-long-edge" is normally used when printing portrait
179 (unrotated) pages, while "two-sided-short-edge" is used for
180 landscape pages.
181 .TP 5
182 -o fit-to-page
183 .br
184 Scales the print file to fit on the page.
185 .TP 5
186 -o number-up=2
187 .TP 5
188 -o number-up=4
189 .TP 5
190 -o number-up=6
191 .TP 5
192 -o number-up=9
193 .TP 5
194 -o number-up=16
195 .br
196 Prints multiple document pages on each output page.
197 .TP 5
198 -o cpi=N
199 .br
200 Sets the number of characters per inch to use when printing a
201 text file. The default is 10.
202 .TP 5
203 -o lpi=N
204 .br
205 Sets the number of lines per inch to use when printing a text
206 file. The default is 6.
207 .TP 5
208 -o page-bottom=N
209 .TP 5
210 -o page-left=N
211 .TP 5
212 -o page-right=N
213 .TP 5
214 -o page-top=N
215 .br
216 Sets the page margins when printing text files. The values are in
217 points - there are 72 points to the inch.
218 .SH EXAMPLES
219 Print a double-sided legal document to a printer called "foo":
220 .nf
221 lp -d foo -o media=legal -o sides=two-sided-long-edge filename
222 .fi
223 .LP
224 Print an image across 4 pages:
225 .nf
226 lp -d bar -o scaling=200 filename
227 .fi
228 .LP
229 Print a text file with 12 characters per inch, 8 lines per inch, and
230 a 1 inch left margin:
231 .nf
232 lp -d bar -o cpi=12 -o lpi=8 -o page-left=72 filename
233 .fi
234 .SH COMPATIBILITY
235 Unlike the System V printing system, CUPS allows printer names to
236 contain any printable character except SPACE, TAB, "/", or "#".
237 Also, printer and class names are \fInot\fR case-sensitive.
238 .LP
239 The "q" option accepts a different range of values than the
240 Solaris lp command, matching the IPP job priority values (1-100,
241 100 is highest priority) instead of the Solaris values (0-39, 0
242 is highest priority).
243 .SH SEE ALSO
244 \fIcancel(1)\fR, \fIlpadmin(8)\fR, \fIlpmove(8)\fR, \fIlpoptions(1)\fR,
245 \fIlpstat(1)\fR,
246 .br
247 http://localhost:631/help
248 .SH COPYRIGHT
249 Copyright 2007-2013 by Apple Inc.
250 .\"
251 .\" End of "$Id$".
252 .\"