]> git.ipfire.org Git - thirdparty/cups.git/blob - man/lp.man
Merge changes from CUPS 1.5svn-r9675.
[thirdparty/cups.git] / man / lp.man
1 .\"
2 .\" "$Id: lp.man 7889 2008-08-29 22:03:35Z mike $"
3 .\"
4 .\" lp man page for CUPS.
5 .\"
6 .\" Copyright 2007-2011 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" "31 March 2011" "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 -u username
132 .br
133 Submits jobs as \fIusername\fR.
134 .TP 5
135 -H hh:mm
136 .TP 5
137 -H hold
138 .TP 5
139 -H immediate
140 .TP 5
141 -H restart
142 .TP 5
143 -H resume
144 .br
145 Specifies when the job should be printed. A value of \fIimmediate\fR will print
146 the file immediately, a value of \fIhold\fR will hold the job indefinitely, and
147 a UTC time value (HH:MM) will hold the job until the specified UTC (not local)
148 time. Use a value of \fIresume\fR with the \fI-i\fR option to resume a held job.
149 Use a value of \fIrestart\fR with the \fI-i\fR option to restart
150 a completed job.
151 .TP 5
152 -P page-list
153 .br
154 Specifies which pages to print in the document. The list can
155 contain a list of numbers and ranges (#-#) separated by commas
156 (e.g. 1,3-5,16). The page numbers refer to the output pages and
157 not the document's original pages - options like "number-up" can
158 affect the numbering of the pages.
159 .SH COMMON JOB OPTIONS
160 Aside from the printer-specific options reported by the
161 \fIlpoptions(1)\fR command, the following generic options are
162 available:
163 .TP 5
164 -o media=size
165 .br
166 Sets the page size to \fIsize\fR. Most printers support at least
167 the size names "a4", "letter", and "legal".
168 .TP 5
169 -o landscape
170 .TP 5
171 -o orientation-requested=4
172 .br
173 Prints the job in landscape (rotated 90 degrees).
174 .TP 5
175 -o sides=one-sided
176 .TP 5
177 -o sides=two-sided-long-edge
178 .TP 5
179 -o sides=two-sided-short-edge
180 .br
181 Prints on one or two sides of the paper. The value
182 "two-sided-long-edge" is normally used when printing portrait
183 (unrotated) pages, while "two-sided-short-edge" is used for
184 landscape pages.
185 .TP 5
186 -o fitplot
187 .br
188 Scales the print file to fit on the page.
189 .TP 5
190 -o number-up=2
191 .TP 5
192 -o number-up=4
193 .TP 5
194 -o number-up=6
195 .TP 5
196 -o number-up=9
197 .TP 5
198 -o number-up=16
199 .br
200 Prints multiple document pages on each output page.
201 .TP 5
202 -o scaling=number
203 .br
204 Scales image files to use up to \fInumber\fR percent of the page.
205 Values greater than 100 cause the image file to be printed across
206 multiple pages.
207 .TP 5
208 -o cpi=N
209 .br
210 Sets the number of characters per inch to use when printing a
211 text file. The default is 10.
212 .TP 5
213 -o lpi=N
214 .br
215 Sets the number of lines per inch to use when printing a text
216 file. The default is 6.
217 .TP 5
218 -o page-bottom=N
219 .TP 5
220 -o page-left=N
221 .TP 5
222 -o page-right=N
223 .TP 5
224 -o page-top=N
225 .br
226 Sets the page margins when printing text files. The values are in
227 points - there are 72 points to the inch.
228 .SH EXAMPLES
229 Print a double-sided legal document to a printer called "foo":
230 .nf
231 lp -d foo -o media=legal -o sides=two-sided-long-edge filename
232 .fi
233 .LP
234 Print an image across 4 pages:
235 .nf
236 lp -d bar -o scaling=200 filename
237 .fi
238 .LP
239 Print a text file with 12 characters per inch, 8 lines per inch, and
240 a 1 inch left margin:
241 .nf
242 lp -d bar -o cpi=12 -o lpi=8 -o page-left=72 filename
243 .fi
244 .SH COMPATIBILITY
245 Unlike the System V printing system, CUPS allows printer names to
246 contain any printable character except SPACE, TAB, "/", or "#".
247 Also, printer and class names are \fInot\fR case-sensitive.
248 .LP
249 The "q" option accepts a different range of values than the
250 Solaris lp command, matching the IPP job priority values (1-100,
251 100 is highest priority) instead of the Solaris values (0-39, 0
252 is highest priority).
253 .SH SEE ALSO
254 \fIcancel(1)\fR, \fIlpadmin(8)\fR, \fIlpmove(8)\fR, \fIlpoptions(1)\fR,
255 \fIlpstat(1)\fR,
256 .br
257 http://localhost:631/help
258 .SH COPYRIGHT
259 Copyright 2007-2011 by Apple Inc.
260 .\"
261 .\" End of "$Id: lp.man 7889 2008-08-29 22:03:35Z mike $".
262 .\"