]> git.ipfire.org Git - thirdparty/cups.git/blob - man/lp.man
Load cups into easysw/current.
[thirdparty/cups.git] / man / lp.man
1 .\"
2 .\" "$Id: lp.man 6649 2007-07-11 21:46:42Z mike $"
3 .\"
4 .\" lp man page for the Common UNIX Printing System (CUPS).
5 .\"
6 .\" Copyright 2007 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" "23 March 2006" "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 OPTIONS
66 The following options are recognized by \fIlp\fR:
67 .TP 5
68 --
69 .br
70 Marks the end of options; use this to print a file whose name
71 begins with a dash (-).
72 .TP 5
73 -E
74 .br
75 Forces encryption when connecting to the server.
76 .TP 5
77 -U username
78 .br
79 Specifies the username to use when connecting to the server.
80 .TP 5
81 -c
82 .br
83 This option is provided for backwards-compatibility only. On
84 systems that support it, this option forces the print file to be
85 copied to the spool directory before printing. In CUPS, print
86 files are always sent to the scheduler via IPP which has the
87 same effect.
88 .TP 5
89 -d destination
90 .br
91 Prints files to the named printer.
92 .TP 5
93 -h hostname[:port]
94 .br
95 Chooses an alternate server.
96 .TP 5
97 -i job-id
98 .br
99 Specifies an existing job to modify.
100 .TP 5
101 -m
102 .br
103 Sends an email when the job is completed.
104 .TP 5
105 -n copies
106 .br
107 Sets the number of copies to print from 1 to 100.
108 .TP 5
109 -o "name=value [name=value ...]"
110 .br
111 Sets one or more job options.
112 .TP 5
113 -q priority
114 .br
115 Sets the job priority from 1 (lowest) to 100 (highest). The
116 default priority is 50.
117 .TP 5
118 -s
119 .br
120 Do not report the resulting job IDs (silent mode.)
121 .TP 5
122 -t "name"
123 .br
124 Sets the job name.
125 .TP 5
126 -u username
127 .br
128 Submits jobs as \fIusername\fR.
129 .TP 5
130 -H hh:mm
131 .TP 5
132 -H hold
133 .TP 5
134 -H immediate
135 .TP 5
136 -H restart
137 .TP 5
138 -H resume
139 .br
140 Specifies when the job should be printed. A value of
141 \fIimmediate\fR will print the file immediately, a value of
142 \fIhold\fR will hold the job indefinitely, and a time value
143 (HH:MM) will hold the job until the specified time. Use a value
144 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).
153 .SH COMMON JOB OPTIONS
154 Aside from the printer-specific options reported by the
155 \fIlpoptions(1)\fR command, the following generic options are
156 available:
157 .TP 5
158 -o media=size
159 .br
160 Sets the page size to \fIsize\fR. Most printers support at least
161 the size names "a4", "letter", and "legal".
162 .TP 5
163 -o landscape
164 .TP 5
165 -o orientation-requested=4
166 .br
167 Prints the job in landscape (rotated 90 degrees).
168 .TP 5
169 -o sides=one-sided
170 .TP 5
171 -o sides=two-sided-long-edge
172 .TP 5
173 -o sides=two-sided-short-edge
174 .br
175 Prints on one or two sides of the paper. The value
176 "two-sided-long-edge" is normally used when printing portrait
177 (unrotated) pages, while "two-sided-short-edge" is used for
178 landscape pages.
179 .TP 5
180 -o fitplot
181 .br
182 Scales the print file to fit on the page.
183 .TP 5
184 -o scaling=number
185 .br
186 Scales image files to use up to \fInumber\fR percent of the page.
187 Values greater than 100 cause the image file to be printed across
188 multiple pages.
189 .TP 5
190 -o cpi=N
191 .br
192 Sets the number of characters per inch to use when printing a
193 text file. The default is 10.
194 .TP 5
195 -o lpi=N
196 .br
197 Sets the number of lines per inch to use when printing a text
198 file. The default is 6.
199 .TP 5
200 -o page-bottom=N
201 .TP 5
202 -o page-left=N
203 .TP 5
204 -o page-right=N
205 .TP 5
206 -o page-top=N
207 .br
208 Sets the page margins when printing text files. The values are in
209 points - there are 72 points to the inch.
210 .SH EXAMPLES
211 Print a double-sided legal document to a printer called "foo":
212 .nf
213 lp -d foo -o media=legal -o sides=two-sided-long-edge filename
214 .fi
215 .LP
216 Print an image across 4 pages:
217 .nf
218 lp -d bar -o scaling=200 filename
219 .fi
220 .LP
221 Print a text file with 12 characters per inch, 8 lines per inch, and
222 a 1 inch left margin:
223 .nf
224 lp -d bar -o cpi=12 -o lpi=8 -o page-left=72 filename
225 .fi
226 .SH COMPATIBILITY
227 Unlike the System V printing system, CUPS allows printer names to
228 contain any printable character except SPACE, TAB, "/", or "#".
229 Also, printer and class names are \fInot\fR case-sensitive.
230 .LP
231 The "q" option accepts a different range of values than the
232 Solaris lp command, matching the IPP job priority values (1-100,
233 100 is highest priority) instead of the Solaris values (0-39, 0
234 is highest priority).
235 .SH SEE ALSO
236 \fIcancel(1)\fR, \fIlpmove(8)\fR, \fIlpoptions(1)\fR, \fIlpstat(1)\fR,
237 .br
238 http://localhost:631/help
239 .SH COPYRIGHT
240 Copyright 2007 by Apple Inc.
241 .\"
242 .\" End of "$Id: lp.man 6649 2007-07-11 21:46:42Z mike $".
243 .\"