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