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