]> git.ipfire.org Git - thirdparty/cups.git/blame - doc/help/options.html
Merge changes from CUPS 1.4svn-r7817.
[thirdparty/cups.git] / doc / help / options.html
CommitLineData
4744bd90 1<HTML>
2<!-- SECTION: Getting Started -->
3<HEAD>
b94498cf 4 <TITLE>Command-Line Printing and Options</TITLE>
4744bd90 5</HEAD>
6<BODY>
7
8<P>CUPS provides both the System V (<A
9HREF="man-lp.html">lp(1)</A>) and Berkeley (<A
10HREF="man-lpr.html">lpr(1)</A>) printing commands for printing
11files. In addition, it supported a large number of standard and
12printer-specific options that allow you to control how and where
13files are printed.</P>
14
15
16<H2 CLASS="title"><A NAME="BASICS">Printing Files</A></H2>
17
18<P>CUPS understands many different types of files directly,
19including text, PostScript, PDF, and image files. This allows you
20to print from inside your applications or at the command-line,
21whichever is most convenient! Type either of the following
22commands to print a file to the default (or only) printer on the
23system:</P>
24
25<PRE CLASS="command">
26lp filename
27lpr filename
28</PRE>
29
30<H3><A NAME="PRINTER">Choosing a Printer</A></H3>
31
32<P>Many systems will have more than one printer available to the
33user. These printers can be attached to the local system via a
34parallel, serial, or USB port, or available over the network. Use
35the <A HREF="man-lpstat.html">lpstat(1)</A> command to see a list
36of available printers:</P>
37
38<PRE CLASS="command">
39lpstat -p -d
40</PRE>
41
42<P>The <CODE>-p</CODE> option specifies that you want to see a
43list of printers, and the <CODE>-d</CODE> option reports the
44current default printer or class.</P>
45
46<P>Use the <CODE>-d</CODE> option with the <B>lp</B> command to
47print to a specific printer:</P>
48
49<PRE CLASS="command">
50lp -d printer filename
51</PRE>
52
53<P>or the <CODE>-P</CODE> option with the <B>lpr</B> command:</P>
54
55<PRE CLASS="command">
56lpr -P printer filename
57</PRE>
58
59<H3><A NAME="DEFAULT">Setting the Default Printer</A></H3>
60
61<P>If you normally use a particular printer, you can tell CUPS to
62use it by default using the <A
63HREF="man-lpoptions.html">lpoptions(1)</A> command:</P>
64
65<PRE CLASS="command">
66lpoptions -d printer
67</PRE>
68
69<H3><A NAME="PIPE">Printing the Output of a Program</A></H3>
70
71<P>Both the <B>lp</B> and <B>lpr</B> commands support printing
72from the standard input:</P>
73
74<PRE CLASS="command">
75program | lp
76program | lp -d printer
77program | lpr
78program | lpr -P printer
79</PRE>
80
81<P>If the program does not provide any output, then nothing will
82be queued for printing.</P>
83
84<H3><A NAME="WITHOPTIONS">Specifying Printer Options</A></H3>
85
86<P>For many types of files, the default printer options may be
87sufficient for your needs. However, there may be times when you
88need to change the options for a particular file you are
89printing.</P>
90
91<P>The <B>lp</B> and <B>lpr</B> commands allow you to pass
92printer options using the <CODE>-o</CODE> option:</P>
93
94<PRE CLASS="command">
95lp -o landscape -o scaling=75 -o media=A4 filename.jpg
96lpr -o landscape -o scaling=75 -o media=A4 filename.jpg
97</PRE>
98
99<P>The available printer options vary depending on the printer.
100The standard options are described in the "<A
101HREF="#OPTIONS">Standard Printing Options</A>" section
b86bc4cf 102below. Printer-specific options are also available and can be
103listed using the <B>lpoptions</B> command:</P>
104
105<PRE CLASS="command">
106lpoptions -p printer -l
107</PRE>
4744bd90 108
f42414bf 109<H3><A NAME="INSTANCES">Creating Saved Options</A></H3>
110
111<P>Saved options are supported in CUPS through <em>printer
112instances</em>. Printer instances are, as their name implies, copies
113of a printer that have certain options associated with them. Use the
114<B>lpoptions</B> command to create a printer instance:</P>
115
116<PRE CLASS="command">
117lpoptions -p printer/instance -o name=value ...
118</PRE>
119
120<P>The <CODE>-p printer/instance</CODE> option provides the name of
121the instance, which is always the printer name, a slash, and the
122instance name which can contain any printable characters except
123space and slash. The remaining options are then associated with the
124instance instead of the main queue. For example, the following
125command creates a duplex instance of the LaserJet queue:</P>
126
127<PRE CLASS="command">
128lpoptions -p LaserJet/duplex -o sides=two-sided-long-edge
129</PRE>
130
131<P>Instances <em>do not</em> inherit lpoptions from the main
132queue.</P>
133
4744bd90 134<H3><A NAME="COPIES">Printing Multiple Copies</A></H3>
135
136<P>Both the <B>lp</B> and <B>lpr</B> commands have options for
137printing more than one copy of a file:</P>
138
139<PRE CLASS="command">
7ff4fea9
MS
140lp -n <EM>num-copies</EM> filename
141lpr -#<EM>num-copies</EM> filename
4744bd90 142</PRE>
143
144<P>Copies are normally <EM>not</EM> collated for you. Use the
145<CODE>-o Collate=True</CODE> option to get collated copies:</P>
146
147<PRE CLASS="command">
7ff4fea9
MS
148lp -n <EM>num-copies</EM> -o Collate=True filename
149lpr -#<EM>num-copies</EM> -o Collate=True filename
4744bd90 150</PRE>
151
152
153<H2 CLASS="title"><A NAME="CANCEL">Canceling a Print Job</A></H2>
154
155<P>The <A HREF="man-cancel.html">cancel(1)</A> and <A
156HREF="man-lprm.html">lprm(1)</A> commands cancel a print job:</P>
157
158<PRE CLASS="command">
7ff4fea9
MS
159cancel <EM>job-id</EM>
160lprm <EM>job-id</EM>
4744bd90 161</PRE>
162
7ff4fea9 163<P>The <EM>job-id</EM> is the number that was reported to you by
4744bd90 164the <B>lp</B> command. You can also get the job ID using the <A
165HREF="man-lpq.html">lpq(1)</A> or <A
166HREF="man-lpstat.html">lpstat</A> commands:</P>
167
168<PRE CLASS="command">
169lpq
170lpstat
171</PRE>
172
173
b94498cf 174<H2 CLASS="title"><A NAME="LPMOVE">Moving a Print Job</A></H2>
175
176<P>The <A HREF="man-lpmove.html">lpmove(8)</A> command moves a print
177job to a new printer or class:</P>
178
179<PRE CLASS="command">
7ff4fea9 180lpmove <EM>job-id</EM> <i>destination</i>
b94498cf 181</PRE>
182
7ff4fea9 183<P>The <EM>job-id</EM> is the number that was reported to you by
b94498cf 184the <B>lp</B> or <B>lpstat</B> commands. <i>Destination</i> is the
185name of a printer or class that you want to actually print the job.
186
187<BLOCKQUOTE><B>Note:</B>
188
189<P>The <B>lpmove</B> command is located in the system command
190directory (typically <VAR>/usr/sbin</VAR> or <VAR>/usr/local/sbin</VAR>),
191and so may not be in your command path. Specify the full path to the
192command if you get a "command not found" error, for example:
193
194<PRE CLASS="command">
195/usr/sbin/lpmove foo-123 bar
196</PRE>
197
198</BLOCKQUOTE>
199
200
4744bd90 201<H2 CLASS="title"><A NAME="OPTIONS">Standard Printing Options</A></H2>
202
203<P>The following options apply when printing all types of
204files.</P>
205
206<H3><A NAME="MEDIA">Selecting the Media Size, Type, and Source</A></H3>
207
208<P>The <CODE>-o media=xyz</CODE> option sets the media size,
209type, and/or source:</P>
210
211<PRE CLASS="command">
212lp -o media=Letter filename
213lp -o media=Letter,MultiPurpose filename
214lpr -o media=Letter,Transparency filename
215lpr -o media=Letter,MultiPurpose,Transparency filename
216</PRE>
217
218<P>The available media sizes, types, and sources depend on the
219printer, but most support the following options (case is not
220significant):</P>
221
222<UL>
223
224 <LI><CODE>Letter</CODE> - US Letter (8.5x11 inches, or 216x279mm)
225
226 <LI><CODE>Legal</CODE> - US Legal (8.5x14 inches, or 216x356mm)
227
228 <LI><CODE>A4</CODE> - ISO A4 (8.27x11.69 inches, or 210x297mm)
229
230 <LI><CODE>COM10</CODE> - US #10 Envelope (9.5x4.125 inches, or
231 241x105mm)
232
233 <LI><CODE>DL</CODE> - ISO DL Envelope (8.66x4.33 inches, or 220x110mm)
234
235 <LI><CODE>Transparency</CODE> - Transparency media type or source
236
237 <LI><CODE>Upper</CODE> - Upper paper tray
238
239 <LI><CODE>Lower</CODE> - Lower paper tray
240
241 <LI><CODE>MultiPurpose</CODE> - Multi-purpose paper tray
242
243 <LI><CODE>LargeCapacity</CODE> - Large capacity paper tray
244
245</UL>
246
247<P>The actual options supported are defined in the printer's PPD
248file in the <CODE>PageSize</CODE>, <CODE>InputSlot</CODE>, and
249<CODE>MediaType</CODE> options. You can list them using the
250<B>lpoptions(1)</B> command:</P>
251
252<PRE CLASS="command">
253lpoptions -p printer -l
254</PRE>
255
b86bc4cf 256<P>When <CODE>Custom</CODE> is listed for the <CODE>PageSize</CODE> option, you can specify custom media sizes using one of the following forms:</P>
257
258<PRE CLASS="command">
7ff4fea9
MS
259lp -o media=Custom.<EM>WIDTH</EM>x<EM>LENGTH</EM> filename
260lp -o media=Custom.<EM>WIDTH</EM>x<EM>LENGTH</EM>in filename
261lp -o media=Custom.<EM>WIDTH</EM>x<EM>LENGTH</EM>cm filename
262lp -o media=Custom.<EM>WIDTH</EM>x<EM>LENGTH</EM>mm filename
b86bc4cf 263</PRE>
264
265<P>where "WIDTH" and "LENGTH" are the width and length of the media in points, inches, centimeters, or millimeters, respectively.</P>
266
267
4744bd90 268<H3><A NAME="ORIENTATION">Setting the Orientation</A></H3>
269
270<P>The <CODE>-o landscape</CODE> option will rotate the page 90
271degrees to print in landscape orientation:</P>
272
273<PRE CLASS="command">
274lp -o landscape filename
275lpr -o landscape filename
276</PRE>
277
278<P>The <CODE>-o orientation-requested=N</CODE> option rotates the
279page depending on the value of N:</P>
280
281<UL>
282
283 <LI><CODE>-o orientation-requested=3</CODE> - portrait
284 orientation (no rotation)</LI>
285
286 <LI><CODE>-o orientation-requested=4</CODE> - landscape
287 orientation (90 degrees)</LI>
288
289 <LI><CODE>-o orientation-requested=5</CODE> - reverse
290 landscape or seascape orientation (270 degrees)</LI>
291
292 <LI><CODE>-o orientation-requested=6</CODE> - reverse
293 portrait or upside-down orientation (180 degrees)</LI>
294
295</UL>
296
7ff4fea9 297
4744bd90 298<H3><A NAME="SIDES">Printing On Both Sides of the Paper</A></H3>
299
300<P>The <CODE>-o sides=two-sided-short-edge</CODE> and <CODE>-o
301sides=two-sided-long-edge</CODE> options will enable two-sided
302printing on the printer if the printer supports it. The <CODE>-o
303sides=two-sided-short-edge</CODE> option is suitable for
304landscape pages, while the <CODE>-o
305sides=two-sided-long-edge</CODE> option is suitable for portrait
306pages:</P>
307
308<PRE CLASS="command">
309lp -o sides=two-sided-short-edge filename
310lp -o sides=two-sided-long-edge filename
311lpr -o sides=two-sided-long-edge filename
312</PRE>
313
314<P>The default is to print single-sided:</P>
315
316<PRE CLASS="command">
317lp -o sides=one-sided filename
318lpr -o sides=one-sided filename
319</PRE>
320
7ff4fea9 321
4744bd90 322<H3><A NAME="JOBSHEETS">Selecting the Banner Page(s)</A></H3>
323
324<P>The <CODE>-o jobsheets=start,end</CODE> option sets the banner
325page(s) to use for a job:</P>
326
327<PRE CLASS="command">
328lp -o job-sheets=none filename
329lp -o job-sheets=standard filename
330lpr -o job-sheets=classified,classified filename
331</PRE>
332
333<P>If only one banner file is specified, it will be printed
334before the files in the job. If a second banner file is
335specified, it is printed after the files in the job.</P>
336
337<P>The available banner pages depend on the local system
338configuration; CUPS includes the following banner files:</P>
339
340<UL>
341
342 <LI><CODE>none</CODE> - Do not produce a banner page.
343
344 <LI><CODE>classified</CODE> - A banner page with a "classified"
345 label at the top and bottom.
346
347 <LI><CODE>confidential</CODE> - A banner page with a
348 "confidential" label at the top and bottom.
349
350 <LI><CODE>secret</CODE> - A banner page with a "secret" label
351 at the top and bottom.
352
353 <LI><CODE>standard</CODE> - A banner page with no label at the
354 top and bottom.
355
356 <LI><CODE>topsecret</CODE> - A banner page with a "top secret"
357 label at the top and bottom.
358
359 <LI><CODE>unclassified</CODE> - A banner page with an
360 "unclassified" label at the top and bottom.
361
362</UL>
363
b86bc4cf 364
7ff4fea9
MS
365<H3><A NAME="JOBHOLDUNTIL">Holding Jobs for Later Printing</A></H3>
366
367<P>The <CODE>-o job-hold-until=when</CODE> option tells CUPS to
368delay printing until the "when" time, which can be one of the
369following:</P>
370
371<UL>
372
373 <LI><CODE>-o job-hold-until=indefinite</CODE>; print only
374 after released by the user or an administrator</LI>
375
376 <LI><CODE>-o job-hold-until=day-time</CODE>; print from
377 6am to 6pm local time</LI>
378
379 <LI><CODE>-o job-hold-until=night</CODE>; print from
380 6pm to 6am local time</LI>
381
382 <LI><CODE>-o job-hold-until=second-shift</CODE>; print from
383 4pm to 12am local time</LI>
384
385 <LI><CODE>-o job-hold-until=third-shift</CODE>; print from
386 12am to 8am local time</LI>
387
388 <LI><CODE>-o job-hold-until=weekend</CODE>; print on Saturday
389 or Sunday</LI>
390
391 <LI><CODE>-o job-hold-until=HH:MM</CODE>; print at the specified
392 UTC time</LI>
393
394</UL>
395
396<H3><A NAME="RELEASEJOB">Releasing Held Jobs</A></H3>
397
398<P>Aside from the web interface, you can use the <B>lp</B> command
399to release a held job:</P>
400
401<PRE CLASS="command">
402lp -i <em>job-id</em> -H resume
403</PRE>
404
405<P>where "job-id" is the job ID reported by the <B>lpstat</B>
406command.</P>
407
408
409<H3><A NAME="JOBPRIORITY">Setting the Job Priority</A></H3>
410
411<P>The <CODE>-o job-priority=NNN</CODE> option tells CUPS to
412assign a priority to your job from 1 (lowest) to 100 (highest),
413which influences where the job appears in the print queue. Higher
414priority jobs are printed before lower priority jobs, however
415submitting a new job with a high priority will not interrupt an
416</P>
417
418
b86bc4cf 419<H3><A NAME="OUTPUTORDER">Specifying the Output Order</A></H3>
420
421<P>The <CODE>-o outputorder=normal</CODE> and <CODE>-o outputorder=reverse</CODE> options specify the order of the pages. Normal order prints page 1 first, page 2 second, and so forth. Reverse order prints page 1 last.</P>
422
423
4744bd90 424<H3><A NAME="PAGERANGES">Selecting a Range of Pages</A></H3>
425
426<P>The <CODE>-o page-ranges=pages</CODE> option selects a range
427of pages for printing:</P>
428
429<PRE CLASS="command">
430lp -o page-ranges=1 filename
431lp -o page-ranges=1-4 filename
432lp -o page-ranges=1-4,7,9-12 filename
433lpr -o page-ranges=1-4,7,9-12 filename
434</PRE>
435
436<P>As shown above, the <CODE>pages</CODE> value can be a single page, a
437range of pages, or a collection of page numbers and ranges separated by
438commas. The pages will always be printed in ascending order, regardless
439of the order of the pages in the <CODE>page-ranges</CODE> option.
440
441<P>The default is to print all pages.
442
443<H3><A NAME="PAGESET">Selecting Even or Odd Pages</A></H3>
444
445<P>Use the <CODE>-o page-set=set</CODE> option to select the even or odd pages:</P>
446
447<PRE CLASS="command">
448lp -o page-set=odd filename
449lp -o page-set=even filename
450lpr -o page-set=even filename
451</PRE>
452
453<P>The default is to print all pages.
454
455<H3><A NAME="NUMBERUP">N-Up Printing</A></H3>
456
457<P>The <CODE>-o number-up=value</CODE> option selects N-Up
458printing. N-Up printing places multiple document pages on a
459single printed page. CUPS supports 1, 2, 4, 6, 9, and 16-Up
460formats; the default format is 1-Up:</P>
461
462<PRE CLASS="command">
463lp -o number-up=1 filename
464lp -o number-up=2 filename
465lp -o number-up=4 filename
466lpr -o number-up=16 filename
467</PRE>
468
469<P>The <CODE>-o page-border=value</CODE> option chooses the
470border to draw around each page:</P>
471
472<UL>
473 <LI><CODE>-o page-border=double</CODE>; draw two hairline borders around each page</LI>
474 <LI><CODE>-o page-border=double-thick</CODE>; draw two 1pt borders around each page</LI>
475 <LI><CODE>-o page-border=none</CODE>; do not draw a border (default)</LI>
476 <LI><CODE>-o page-border=single</CODE>; draw one hairline border around each page</LI>
477 <LI><CODE>-o page-border=single-thick</CODE>; draw one 1pt border around each page</LI>
478</UL>
479
480<P>The <CODE>-o number-up-layout=value</CODE> option chooses the
481layout of the pages on each output page:</P>
482
483<UL>
484 <LI><CODE>-o number-up-layout=btlr</CODE>; Bottom to top, left to right</LI>
485 <LI><CODE>-o number-up-layout=btrl</CODE>; Bottom to top, right to left</LI>
486 <LI><CODE>-o number-up-layout=lrbt</CODE>; Left to right, bottom to top</LI>
487 <LI><CODE>-o number-up-layout=lrtb</CODE>; Left to right, top to bottom (default)</LI>
488 <LI><CODE>-o number-up-layout=rlbt</CODE>; Right to left, bottom to top</LI>
489 <LI><CODE>-o number-up-layout=rltb</CODE>; Right to left, top to bottom</LI>
490 <LI><CODE>-o number-up-layout=tblr</CODE>; Top to bottom, left to right</LI>
491 <LI><CODE>-o number-up-layout=tbrl</CODE>; Top to bottom, right to left</LI>
492</UL>
493
494<H3><A NAME="FITPLOT">Scaling to Fit</A></H3>
495
496<P>The <CODE>-o fitplot</CODE> option specifies that the document
497should be scaled to fit on the page:</P>
498
499<PRE CLASS="command">
500lp -o fitplot filename
501lpr -o fitplot filename
502</PRE>
503
504<P>The default is to use the size specified in the file.</P>
505
7ff4fea9
MS
506<BLOCKQUOTE><B>Note:</B>
507
508<P>This feature depends upon an accurate size in
4744bd90 509the print file. If no size is given in the file, the page may be
7ff4fea9
MS
510scaled incorrectly!
511
512</BLOCKQUOTE>
513
514<H3><A NAME="OUTPUTORDER">Printing in Reverse Order</A></H3>
515
516<P>The <CODE>-o outputorder=reverse</CODE> option will print the
517pages in reverse order:</P>
518
519<PRE CLASS="command">
520lp -o outputorder=reverse filename
521lpr -o outputorder=reverse filename
522</PRE>
523
524<P>Similarly, the <CODE>-o outputorder=normal</CODE> option will
525print starting with page 1:</P>
526
527<PRE CLASS="command">
528lp -o outputorder=normal filename
529lpr -o outputorder=normal filename
530</PRE>
531
532<P>The default is <CODE>-o outputorder=normal</CODE> for
533printers that print face down and <CODE>-o outputorder=reverse</CODE>
534for printers that print face up.
535
536<H3><A NAME="MIRROR">Printing Mirrored Pages</A></H3>
537
538<P>The <CODE>-o mirror</CODE> option flips each page along the
539vertical access to produce a mirrored image:</P>
540
541<PRE CLASS="command">
542lp -o mirror filename
543lpr -o mirror filename
544</PRE>
545
546<P>This is typically used when printing on T-shirt transfer
547media or sometimes on transparencies.</P>
4744bd90 548
549<H3><A NAME="RAW">Raw or Unfiltered Output</A></H3>
550
551<P>The <CODE>-o raw</CODE> option allows you to send files
552directly to a printer without filtering. This is sometimes
553required when printing from applications that provide their own
554"printer drivers" for your printer:</P>
555
556<PRE CLASS="command">
557lp -o raw filename
558lpr -o raw filename
559</PRE>
560
561<P>The <CODE>-l</CODE> option can also be used with the
562<B>lpr</B> command to send files directly to a printer:</P>
563
564<PRE CLASS="command">
565lpr -l filename
566</PRE>
567
568
569<H2 CLASS="title"><A NAME="TEXTOPTIONS">Text Options</A></H2>
570
571<P>CUPS supports several options that are only used when printing
572plain text files. These options have absolutely no effect on
573PostScript, PDF, HP-GL/2, or image files.</P>
574
575<H3><A NAME="CPI">Setting the Number of Characters Per Inch</A></H3>
576
577<P>The <CODE>-o cpi=value</CODE> option sets the number of
578characters per inch:</P>
579
580<PRE CLASS="command">
581lp -o cpi=10 filename
582lp -o cpi=12 filename
583lpr -o cpi=17 filename
584</PRE>
585
586<P>The default characters per inch is 10.</P>
587
588<H3><A NAME="LPI">Setting the Number of Lines Per Inch</A></H3>
589
590<P>The <CODE>-o lpi=value</CODE> option sets the number of lines
591per inch:</P>
592
593<PRE CLASS="command">
594lp -o lpi=6 filename
595lpr -o lpi=8 filename
596</PRE>
597
598<P>The default lines per inch is 6.</P>
599
600<H3><A NAME="COLUMNS">Setting the Number of Columns</A></H3>
601
602<P>The <CODE>-o columns=value</CODE> option sets the number of
603text columns:</P>
604
605<PRE CLASS="command">
606lp -o columns=2 filename
607lpr -o columns=3 filename
608</PRE>
609
610<P>The default number of columns is 1.</P>
611
612<H3><A NAME="MARGINS">Setting the Page Margins</A></H3>
613
614<P>Normally the page margins are set to the hard limits of the
615printer. Use the <CODE>-o page-left=value</CODE>, <CODE>-o
616page-right=value</CODE>, <CODE>-o page-top=value</CODE>, and
617<CODE>-o page-bottom=value</CODE> options to adjust the page
618margins:</P>
619
620<PRE CLASS="command">
7ff4fea9
MS
621lp -o page-left=<EM>value</EM> filename
622lp -o page-right=<EM>value</EM> filename
623lp -o page-top=<EM>value</EM> filename
624lp -o page-bottom=<EM>value</EM> filename
625lpr -o page-left=<EM>value</EM> -o page-right=<EM>value</EM> -o page-top=<EM>value</EM> -o page-bottom=<EM>value</EM> filename
4744bd90 626</PRE>
627
628<P>The <CODE>value</CODE> argument is the margin in points; each
629point is 1/72 inch or 0.35mm.</P>
630
631<H3><A NAME="PRETTYPRINT">Pretty Printing</A></H3>
632
633<P>The <CODE>-o prettyprint</CODE> option puts a header at the
634top of each page with the page number, job title (usually the
635filename), and the date. Also, C and C++ keywords are
636highlighted, and comment lines are italicized:</P>
637
638<PRE CLASS="command">
639lp -o prettyprint filename
640lpr -o prettyprint filename
641</PRE>
642
79e1d494 643<H3><A NAME="WRAP">Turning Off Text Wrapping</A></H3>
7ff4fea9
MS
644
645<P>The <CODE>-o nowrap</CODE> option disables wrapping of long lines:</P>
646
647<PRE CLASS="command">
648lp -o nowrap filename
649lpr -o nowrap filename
650</PRE>
651
652
653<H2 CLASS="title"><SPAN CLASS="info">Not Supported on Mac OS X</SPAN><A NAME="IMAGEOPTIONS">Image Options</A></H2>
654
655<P>CUPS supports several options that are only used when printing
656image files. These options have absolutely no effect on PostScript, PDF,
657HP-GL/2, or text files.</P>
658
659<H3><A NAME="position">Positioning Images</A></H3>
660
661<P>The <CODE>-o position=name</CODE> option specifies the position of the
662image on the page:
663
664<UL>
665
666 <LI><CODE>center</CODE> - Center the image on the page (default)
667
668 <LI><CODE>top</CODE> - Print the image centered at the top of the page
669
670 <LI><CODE>left</CODE> - Print the image centered on the left of page
671
672 <LI><CODE>right</CODE> - Print the image centered on the right of the page
673
674 <LI><CODE>top-left</CODE> - Print the image at the top left corner of
675 the page
676
677 <LI><CODE>top-right</CODE> - Print the image at the top right corner of
678 the page
679
680 <LI><CODE>bottom</CODE> - Print the image centered at the bottom of
681 the page
682
683 <LI><CODE>bottom-left</CODE> - Print the image at the bottom left
684 corner of the page
685
686 <LI><CODE>bottom-right</CODE> - Print the image at the bottom right
687 corner of the page
688
689</UL>
690
691<H3><A NAME="scaling">Scaling Images</A></H3>
692
693<P>The <CODE>-o scaling=percent</CODE>, <CODE>-o
694ppi=value</CODE>, and <CODE>-o natural-scaling=percent</CODE>
695options change the size of a printed image:
696
697<PRE CLASS="command">
698lp -o scaling=<EM>percent</EM> filename
699lp -o ppi=<EM>value</EM> filename
700lpr -o natural-scaling=<EM>percent</EM> filename
701</PRE>
702
703<P>The <CODE>scaling=percent</CODE> value is a number from 1 to 800
704specifying the size in relation to the page (<EM>not</EM> the image.) A
705scaling of 100 percent will fill the page as completely as the image
706aspect ratio allows. A scaling of 200 percent will print on up to 4
707pages.
708
709<P>The <CODE>ppi=value</CODE> value is a number from 1 to 1200 specifying the
710resolution of the image in pixels per inch. An image that is 3000x2400
711pixels will print 10x8 inches at 300 pixels per inch, for example. If
712the specified resolution makes the image larger than the page, multiple
713pages will be printed to satisfy the request.
714
715<P>The <CODE>natural-scaling=percent</CODE> value is a number
716from 1 to 800 specifying the size in relation to the natural
717image size. A scaling of 100 percent will print the image at its
718natural size, while a scaling of 50 percent will print the image
719at half its natural size. If the specified scaling makes the
720image larger than the page, multiple pages will be printed to
721satisfy the request.
722
7ff4fea9
MS
723
724<H2 CLASS="title"><A NAME="HPGL2OPTIONS">HP-GL/2 Options</A></H2>
725
726<P>CUPS supports several options that are only used when printing
727HP-GL/2 files. These options have absolutely no effect on PostScript, PDF,
728image, or text files.</P>
729
730<H3><A NAME="blackplot">Printing in Black</A></H3>
731
732<P>The <CODE>-o blackplot</CODE> option specifies that all pens should
733plot in black:</P>
734
735<PRE CLASS="command">
736lp -o blackplot filename
737lpr -o blackplot filename
738</PRE>
739
740<P>The default is to use the colors defined in the plot file or the
741standard pen colors defined in the HP-GL/2 reference manual from
742Hewlett Packard.
743
744<H3><A NAME="penwidth">Setting the Default Pen Width</A></H3>
745
746<P>The <CODE>-o penwidth=value</CODE> option specifies the default pen
747width for HP-GL/2 files:</P>
748
749<PRE CLASS="command">
750lp -o penwidth=<EM>value</EM> filename
751lpr -o penwidth=<EM>value</EM> filename
752</PRE>
753
754<P>The pen width <CODE>value</CODE> specifies the pen width in micrometers.
755The default value of 1000 produces lines that are 1 millimeter in width.
756Specifying a pen width of 0 produces lines that are exactly 1 pixel wide.</P>
757
758<BLOCKQUOTE><B>Note:</B>
759
760<P>This option is ignored when the pen widths are set in the plot
761file.
762
763</BLOCKQUOTE>
764
4744bd90 765</BODY>
766</HTML>