]>
Commit | Line | Data |
---|---|---|
ef416fc2 | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> |
2 | <html> | |
4744bd90 | 3 | <!-- SECTION: Specifications --> |
ef416fc2 | 4 | <head> |
5 | <title>CUPS PPD Extensions</title> | |
6 | <meta name='keywords' content='Programming, PostScript Printer Description'> | |
a4d04587 | 7 | <link rel='stylesheet' type='text/css' href='../cups.css'> |
ef416fc2 | 8 | </head> |
9 | <body> | |
10 | <!-- | |
09a101d6 | 11 | "$Id: spec-ppd.html 6602 2007-06-22 22:13:13Z mike $" |
ef416fc2 | 12 | |
13 | CUPS PPD extensions specification for the Common UNIX Printing System (CUPS). | |
14 | ||
f7deaa1a | 15 | Copyright 1997-2007 by Easy Software Products. |
ef416fc2 | 16 | |
17 | These coded instructions, statements, and computer programs are the | |
18 | property of Easy Software Products and are protected by Federal | |
19 | copyright law. Distribution and use rights are outlined in the file | |
20 | "LICENSE.txt" which should have been included with this file. If this | |
21 | file is missing or damaged please contact Easy Software Products | |
22 | at: | |
23 | ||
24 | Attn: CUPS Licensing Information | |
25 | Easy Software Products | |
26 | 44141 Airport View Drive, Suite 204 | |
27 | Hollywood, Maryland 20636 USA | |
28 | ||
29 | Voice: (301) 373-9600 | |
30 | EMail: cups-info@cups.org | |
31 | WWW: http://www.cups.org | |
32 | --> | |
33 | ||
34 | <h2 class='title'><a name='INTRODUCTION'>Introduction</a></h2> | |
35 | ||
36 | <p>This specification describes the attributes and extensions | |
37 | that CUPS adds to <a | |
4744bd90 | 38 | href="http://partners.adobe.com/public/developer/en/ps/5003.PPD_Spec_v4.3.pdf"> |
ef416fc2 | 39 | Adobe TechNote #5003: PostScript Printer Description File Format |
40 | Specification Version 4.3</a>. PostScript Printer Description | |
41 | ("PPD") files describe the capabilities of each printer and are | |
42 | used by CUPS to support printer-specific features and intelligent | |
43 | filtering.</p> | |
44 | ||
45 | <h2 class='title'><a name='SYNTAX'>PPD File Syntax</a></h2> | |
46 | ||
47 | <p>The PPD format is text-based and uses lines of up to 255 | |
48 | characters terminated by a carriage return, linefeed, or | |
49 | combination of carriage return and line feed. The following ABNF | |
50 | definition [RFC2234] defines the general format of lines in a PPD | |
51 | file:</p> | |
52 | ||
53 | <pre class='command'> | |
54 | PPD-FILE = HEADER +(DATA / COMMENT / LINE-END) | |
55 | ||
56 | HEADER = "*" 0x50.50.44.2D.41.64.6F.62.65 ":" ; *PPD-Adobe: | |
57 | *WSP DQUOTE "4.3" DQUOTE LINE-END | |
58 | ||
59 | COMMENT = "*%" *TCHAR LINE-END | |
60 | ||
61 | DATA = "*" 1*KCHAR [ WSP 1*KCHAR [ "/" 1*TCHAR ] ] ":" | |
62 | 1*(*WSP VALUE) LINE-END | |
63 | ||
64 | VALUE = 1*TCHAR / DQUOTE 1*SCHAR DQUOTE | |
65 | ||
66 | KCHAR = ALPHA / DIGIT / "_" / "." / "-" | |
67 | ||
68 | SCHAR = LINE-END / WSP / %x21 / %x23-7E / %xA0-FF | |
69 | ||
70 | TCHAR = %x20-7E / %xA0-FF | |
71 | ||
72 | LINE-END = CR / LF / CR LF | |
73 | </pre> | |
74 | ||
75 | ||
76 | <h2 class='title'><a name='ATTRIBUTES'>General Attributes</a></h2> | |
77 | ||
4744bd90 | 78 | <h3>APBookFile</h3> |
79 | ||
80 | <p class='summary'>*APBookFile: "file URL"</p> | |
81 | ||
82 | <p>This string attribute specifies the Apple help book file to use | |
83 | for this printer driver.</p> | |
84 | ||
85 | <p>Example:</p> | |
86 | ||
87 | <pre class='command'> | |
88 | *APBookFile: "file:///Library/Printers/vendor/Help/filename" | |
89 | </pre> | |
90 | ||
a4d04587 | 91 | <h3>APDuplexRequiresFlippedMargin</h3> |
92 | ||
93 | <p class='summary'>*APDuplexRequiresFlippedMargin: boolean</p> | |
94 | ||
95 | <p>This boolean attribute notifies the RIP filters that the | |
96 | destination printer does not require the top and bottom margins | |
97 | of the <tt>ImageableArea</tt> swapped for the back page. The | |
411affcf | 98 | default is <tt>true</tt> when <tt>cupsFlipDuplex</tt> is <tt>true</tt> and <tt>false</tt> otherwise.</p> |
ef416fc2 | 99 | |
a4d04587 | 100 | <p>Example:</p> |
ef416fc2 | 101 | |
102 | <pre class='command'> | |
411affcf | 103 | <em>*% Flip the back side images</em> |
104 | *cupsFlipDuplex: true | |
105 | ||
a4d04587 | 106 | <em>*% Don't swap the top and bottom margins for the back side</em> |
107 | *APDuplexRequiresFlippedMargin: false | |
ef416fc2 | 108 | </pre> |
109 | ||
a4d04587 | 110 | <p>Also see the related <tt>cupsFlipDuplex</tt> attribute.</p> |
111 | ||
09a101d6 | 112 | <h3>APPrinterPreset</h3> |
113 | ||
114 | <p class='summary'>*APPrinterPreset name/text: "*Option Choice ..."</p> | |
115 | ||
116 | <p>This attribute defines presets for multiple options that show up | |
117 | in the print dialog on Mac OS X. Each preset maps to one or more | |
118 | pairs of PPD options and choices.</p> | |
119 | ||
120 | <p>Examples:</p> | |
121 | ||
122 | <pre class='command'> | |
123 | *APPrinterPreset Text/Text Printing on Plain Paper: " | |
124 | *MediaType Plain | |
125 | *ColorModel Gray | |
126 | *Resolution 600dpi" | |
127 | *End | |
128 | ||
129 | *APPrinterPreset Photo/Photo Printing on Glossy Paper: " | |
130 | *MediaType Glossy | |
131 | *ColorModel RGB | |
132 | *Resolution 300dpi" | |
133 | *End | |
134 | </pre> | |
135 | ||
3d8365b8 | 136 | <h3>APRemoteQueueID</h3> |
137 | ||
138 | <p class='summary'>*APRemoteQueueID: "string"</p> | |
139 | ||
140 | <p>This string attribute notifies the scheduler that this PPD is for a remote CUPS printer, typically shared via Bonjour.</p> | |
141 | ||
142 | <p>Example:</p> | |
143 | ||
144 | <pre class='command'> | |
145 | *APRemoteQueueID: "myprinter" | |
146 | </pre> | |
147 | ||
2abf387c | 148 | <h3>cupsEvenDuplex</h3> |
149 | ||
150 | <p class='summary'>*cupsEvenDuplex: boolean</p> | |
151 | ||
152 | <p>This boolean attribute notifies the RIP filters that the | |
153 | destination printer requires an even number of pages when 2-sided | |
154 | printing is selected. The default value is <code>false</code>.</p> | |
155 | ||
156 | <p>Example:</p> | |
157 | ||
158 | <pre class='command'> | |
159 | <em>*% Always send an even number of pages when duplexing</em> | |
160 | *cupsEvenDuplex: true | |
161 | </pre> | |
162 | ||
3d8365b8 | 163 | <h3>cupsFax</h3> |
164 | ||
165 | <p class='summary'>*cupsFax: boolean</p> | |
166 | ||
167 | <p>This boolean attribute specifies whether the PPD defines a facsimile device. The default is <tt>false</tt>.</p> | |
168 | ||
169 | <p>Examples:</p> | |
170 | ||
171 | <pre class='command'> | |
172 | *cupsFax: true | |
173 | </pre> | |
174 | ||
a4d04587 | 175 | <h3>cupsFilter</h3> |
176 | ||
177 | <p class='summary'>*cupsFilter: "source/type cost program"</p> | |
178 | ||
179 | <p>This string attribute provides a conversion rule from the | |
180 | given source type to the printer's native format using the | |
181 | filter "program". If a printer supports the source type directly, | |
182 | the special filter program "-" may be specified.</p> | |
ef416fc2 | 183 | |
184 | <p>Examples:</p> | |
185 | ||
186 | <pre class='command'> | |
187 | <em>*% Standard raster printer driver filter</em> | |
188 | *cupsFilter: "application/vnd.cups-raster 100 rastertofoo" | |
189 | ||
190 | <em>*% Plain text filter</em> | |
191 | *cupsFilter: "text/plain 10 texttofoo" | |
192 | ||
193 | <em>*% Pass-through filter for PostScript printers</em> | |
194 | *cupsFilter: "application/vnd.cups-postscript 0 -" | |
195 | </pre> | |
196 | ||
197 | <h3>cupsFlipDuplex</h3> | |
198 | ||
a4d04587 | 199 | <p class='summary'>*cupsFlipDuplex: boolean</p> |
200 | ||
09a101d6 | 201 | <blockquote><b>Note:</b> The <tt>cupsFlipDuplex</tt> attribute is |
202 | not supported on Mac OS X 10.5.x or earlier.</blockquote> | |
203 | ||
204 | <p>This boolean attribute specifies the coordinate system of the | |
205 | back side of the media when doing 2-sided printing using a CUPS | |
206 | raster driver. <a href='#TABLE_1'>Table 1</a> shows how | |
207 | <code>cupsFlipDuplex</code> interacts with the <code>Tumble</code> | |
208 | page attribute. The default value is <code>false</code>.</p> | |
209 | ||
210 | <div class='table'> | |
211 | <table width='80%' summary='Back Side Raster Coordinate System'> | |
212 | <caption>Table 1: <a name='TABLE_1'>Back Side Raster Coordinate System</a></caption> | |
213 | <thead> | |
214 | <tr> | |
215 | <th>cupsFlipDuplex</th> | |
216 | <th>Tumble</th> | |
217 | <th>Image Presentation</th> | |
218 | </tr> | |
219 | </thead> | |
220 | <tbody> | |
221 | <tr> | |
222 | <td><code>false</code></td> | |
223 | <td><code>false</code></td> | |
224 | <td>Left-to-right, top-to-bottom</td> | |
225 | </tr> | |
226 | <tr> | |
227 | <td><code>false</code></td> | |
228 | <td><code>true</code></td> | |
229 | <td>Left-to-right, top-to-bottom</td> | |
230 | </tr> | |
231 | <tr> | |
232 | <td><code>true</code></td> | |
233 | <td><code>false</code></td> | |
234 | <td>Left-to-right, bottom-to-top</td> | |
235 | </tr> | |
236 | <tr> | |
237 | <td><code>true</code></td> | |
238 | <td><code>true</code></td> | |
239 | <td>Right-to-left, top-to-bottom</td> | |
240 | </tr> | |
241 | </tbody> | |
242 | </table> | |
243 | </div> | |
ef416fc2 | 244 | |
245 | <p>Example:</p> | |
246 | ||
247 | <pre class='command'> | |
248 | <em>*% Flip the page image for the back side of duplexed output</em> | |
249 | *cupsFlipDuplex: true | |
250 | </pre> | |
251 | ||
2abf387c | 252 | <p>Also see the related <tt>APDuplexRequiresFlippedMargins</tt> |
253 | attribute.</p> | |
a4d04587 | 254 | |
09a101d6 | 255 | <h3>cupsIPPFinishings</h3> |
256 | ||
257 | <p class='summary'>*cupsIPPFinishings number/text: "*Option Choice ..."</p> | |
258 | ||
259 | <p>This attribute defines a mapping from IPP <code>finishings</code> | |
260 | values to PPD options and choices.</p> | |
261 | ||
262 | <p>Examples:</p> | |
263 | ||
264 | <pre class='command'> | |
265 | *cupsIPPFinishings 4/staple: "*StapleLocation SinglePortrait" | |
266 | *cupsIPPFinishings 5/punch: "*PunchMedia Yes *PunchLocation LeftSide" | |
267 | *cupsIPPFinishings 20/staple-top-left: "*StapleLocation SinglePortrait" | |
268 | *cupsIPPFinishings 21/staple-bottom-left: "*StapleLocation SingleLandscape" | |
269 | </pre> | |
270 | ||
4744bd90 | 271 | <h3>cupsIPPReason</h3> |
272 | ||
273 | <p class='summary'>*cupsIPPReason reason/Reason Text: "optional URIs"</p> | |
274 | ||
275 | <p>This optional attribute maps custom | |
276 | <code>printer-state-reasons</code> keywords that are generated by | |
277 | the driver to human readable text. The optional URIs string | |
278 | contains zero or more URIs separated by a newline. Each URI can | |
279 | be a CUPS server absolute path to a help file under the | |
280 | scheduler's <code>DocumentRoot</code> directory, a full HTTP URL | |
281 | ("http://www.domain.com/path/to/help/page.html"), or any other | |
282 | valid URI which directs the user at additional information | |
283 | concerning the condition that is being reported.</p> | |
284 | ||
285 | <p>Examples:</p> | |
286 | ||
287 | <pre class='command'> | |
288 | <em>*% Map com.vendor-error to text but no page</em> | |
289 | *cupsIPPReason com.vendor-error/A serious error occurred: "" | |
290 | ||
291 | <em>*% Map com.vendor-error to text and a local page</em> | |
292 | *cupsIPPReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html" | |
293 | ||
294 | <em>*% Map com.vendor-error to text and a remote page</em> | |
295 | *cupsIPPReason com.vendor-error/A serious error occurred: "http://www.vendor.com/help" | |
296 | ||
297 | <em>*% Map com.vendor-error to text and a local, Apple help book, and remote page</em> | |
298 | *APHelpBook: "file:///Library/Printers/vendor/Help/filename" | |
299 | *cupsIPPReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html | |
300 | help:anchor='com.vendor-error'%20bookID=Vendor%20Help | |
301 | http://www.vendor.com/help" | |
302 | *End | |
303 | </pre> | |
304 | ||
a4d04587 | 305 | <h3>cupsLanguages</h3> |
306 | ||
307 | <p class='summary'>*cupsLanguages: "locale list"</p> | |
308 | ||
309 | <p>This attribute describes which language localizations are | |
310 | included in the PPD. The "locale list" string is a space-delimited | |
b94498cf | 311 | list of locale names ("en", "en_US", "fr_CA", etc.)</p> |
a4d04587 | 312 | |
313 | <p>Example:</p> | |
314 | ||
315 | <pre class='command'> | |
316 | <em>*% Specify Canadian, UK, and US English, and Candian and French French</em> | |
b94498cf | 317 | *cupsLanguages: "en_CA en_UK en_US fr_CA fr_CA" |
a4d04587 | 318 | </pre> |
319 | ||
ef416fc2 | 320 | <h3>cupsManualCopies</h3> |
321 | ||
a4d04587 | 322 | <p class='summary'>*cupsManualCopies: boolean</p> |
323 | ||
ef416fc2 | 324 | <p>This boolean attribute notifies the RIP filters that the |
325 | destination printer does not support copy generation in | |
a4d04587 | 326 | hardware. The default value is <code>false</code>.</p> |
ef416fc2 | 327 | |
328 | <p>Example:</p> | |
329 | ||
330 | <pre class='command'> | |
331 | <em>*% Tell the RIP filters to generate the copies for us</em> | |
332 | *cupsManualCopies: true | |
333 | </pre> | |
334 | ||
335 | <h3>cupsModelNumber</h3> | |
336 | ||
a4d04587 | 337 | <p class='summary'>*cupsModelNumber: number</p> |
338 | ||
ef416fc2 | 339 | <p>This integer attribute specifies a printer-specific model |
340 | number. This number can be used by a filter program to adjust | |
341 | the output for a specific model of printer.</p> | |
342 | ||
343 | <p>Example:</p> | |
344 | ||
345 | <pre class='command'> | |
346 | <em>*% Specify an integer for a driver-specific model number</em> | |
347 | *cupsModelNumber: 1234 | |
348 | </pre> | |
349 | ||
f7deaa1a | 350 | |
351 | <h3>cupsPJLCharset</h3> | |
352 | ||
353 | <p class='summary'>*cupsPJLCharset: "ISO character set name"</p> | |
354 | ||
355 | <p>This string attribute specifies the character set that is used | |
356 | for strings in PJL commands. If not specified, US-ASCII is | |
357 | assumed.</p> | |
358 | ||
359 | <p>Example:</p> | |
360 | ||
361 | <pre class='command'> | |
362 | <em>*% Specify UTF-8 is used in PJL strings</em> | |
363 | *cupsPJLCharset: "UTF-8" | |
364 | </pre> | |
365 | ||
366 | ||
ef416fc2 | 367 | <h3>cupsPortMonitor</h3> |
368 | ||
a4d04587 | 369 | <p class='summary'>*cupsPortMonitor urischeme/Descriptive Text: "port monitor"</p> |
370 | ||
ef416fc2 | 371 | <p>This string attribute specifies printer-specific "port |
372 | monitor" filters that may be used with the printer. The CUPS | |
373 | scheduler also looks for the <tt>Protocols</tt> attribute to see | |
374 | if the <tt>BCP</tt> or <tt>TBCP</tt> protocols are supported. If | |
375 | so, the corresponding port monitor ("bcp" and "tbcp", | |
376 | respectively) is listed in the printer's | |
377 | <tt>port-monitor-supported</tt> attribute.</p> | |
378 | ||
a4d04587 | 379 | <p>The "urischeme" portion of the attribute specifies the URI scheme |
380 | that this port monitor should be used for. Typically this is used to | |
381 | pre-select a particular port monitor for each type of connection that | |
382 | is supported by the printer. The "port monitor" string can be "none" | |
383 | to disable the port monitor for the given URI scheme.</p> | |
384 | ||
ef416fc2 | 385 | <p>Examples:</p> |
386 | ||
387 | <pre class='command'> | |
388 | <em>*% Specify a PostScript printer that supports the TBCP protocol</em> | |
389 | *Protocols: TBCP PJL | |
390 | ||
a4d04587 | 391 | <em>*% Specify that TBCP should be used for socket connections but not USB</em> |
392 | *cupsPortMonitor socket/AppSocket Printing: "tbcp" | |
393 | *cupsPortMonitor usb/USB Printing: "none" | |
394 | ||
ef416fc2 | 395 | <em>*% Specify a printer-specific port monitor for an Epson USB printer</em> |
a4d04587 | 396 | *cupsPortMonitor usb/USB Status Monitor: "epson-usb" |
ef416fc2 | 397 | </pre> |
398 | ||
f7deaa1a | 399 | <h3>cupsPreFilter</h3> |
400 | ||
401 | <p class='summary'>*cupsPreFilter: "source/type cost program"</p> | |
402 | ||
403 | <p>This string attribute provides a pre-filter rule. The pre-filter | |
404 | program will be inserted in the conversion chain immediately | |
405 | before the filter that accepts the given MIME type.</p> | |
406 | ||
407 | <p>Examples:</p> | |
408 | ||
409 | <pre class='command'> | |
410 | <em>*% PDF pre-filter</em> | |
411 | *cupsPreFilter: "application/pdf 100 mypdfprefilter" | |
412 | ||
413 | <em>*% PNG pre-filter</em> | |
414 | *cupsPreFilter: "image/png 0 mypngprefilter" | |
415 | </pre> | |
416 | ||
ef416fc2 | 417 | <h3>cupsVersion</h3> |
418 | ||
a4d04587 | 419 | <p class='summary'>*cupsVersion: major.minor</p> |
420 | ||
ef416fc2 | 421 | <p>This required attribute describes which version of the CUPS |
422 | PPD file extensions was used. Currently it must be the string | |
423 | "1.0", "1.1", or "1.2".</p> | |
424 | ||
425 | <p>Example:</p> | |
426 | ||
427 | <pre class='command'> | |
428 | <em>*% Specify a CUPS 1.2 driver</em> | |
429 | *cupsVersion: "1.2" | |
430 | </pre> | |
431 | ||
ef416fc2 | 432 | <h2 class='title'><a name='OPTIONS'>Custom Options</a></h2> |
433 | ||
434 | <p>CUPS supports custom options using an extension of the | |
435 | <tt>CustomPageSize</tt> and <tt>ParamCustomPageSize</tt> | |
436 | syntax:</p> | |
437 | ||
438 | <pre class='command'> | |
439 | *CustomFoo True: "command" | |
440 | *ParamCustomFoo Name1/Text 1: order type minimum maximum | |
441 | *ParamCustomFoo Name2/Text 2: order type minimum maximum | |
442 | ... | |
443 | *ParamCustomFoo NameN/Text N: order type minimum maximum | |
444 | </pre> | |
445 | ||
446 | <p>When the base option is part of the <tt>JCLSetup</tt> section, | |
447 | the "command" string contains JCL commands with "\order" | |
448 | placeholders for each numbered parameter. The CUPS API handles | |
a4d04587 | 449 | any necessary value quoting for HP-PJL commands. For example, if |
450 | the JCL command string is "@PJL SET PASSCODE=\1" and the first | |
451 | option value is "1234" then CUPS will output the string | |
452 | "@PJL SET PASSCODE=1234".</p> | |
ef416fc2 | 453 | |
454 | <p>For non-<tt>JCLSetup</tt> options, the "order" value is a | |
455 | number from 1 to N and specifies the order of values as they are | |
a4d04587 | 456 | placed on the stack before the command. For example, if the |
457 | PostScript command string is | |
458 | "<</cupsReal1 2 1 roll>>setpagedevice" and the | |
459 | option value is "2.0" then CUPS will output the string | |
460 | "2.0 <</cupsReal1 2 1 roll>>setpagedevice".</p> | |
ef416fc2 | 461 | |
462 | <p>The "type" is one of the following keywords:</p> | |
463 | ||
464 | <ul> | |
465 | ||
466 | <li><tt>curve</tt> - a real value from "minimum" to | |
467 | "maximum" representing a gamma correction curve using the | |
468 | function: f(x) = x <sup>value</sup></li> | |
469 | ||
470 | <li><tt>int</tt> - an integer value from "minimum" to | |
471 | "maximum"</li> | |
472 | ||
473 | <li><tt>invcurve</tt> - a real value from "minimum" to | |
474 | "maximum" representing a gamma correction curve using the | |
475 | function: f(x) = x <sup>1 / value</sup></li> | |
476 | ||
477 | <li><tt>passcode</tt> - a string of numbers value with a | |
478 | minimum of "minimum" numbers and a maximum of "maximum" | |
a4d04587 | 479 | numbers ("minimum" and "maximum" are numbers and passcode |
480 | strings are not displayed in the user interface)</li> | |
ef416fc2 | 481 | |
482 | <li><tt>password</tt> - a string value with a minimum of | |
483 | "minimum" characters and a maximum of "maximum" | |
a4d04587 | 484 | characters ("minimum" and "maximum" are numbers and password |
485 | strings are not displayed in the user interface)</li> | |
ef416fc2 | 486 | |
487 | <li><tt>points</tt> - a measurement value in points from | |
488 | "minimum" to "maximum"</li> | |
489 | ||
490 | <li><tt>real</tt> - a real value from "minimum" to | |
491 | "maximum"</li> | |
492 | ||
493 | <li><tt>string</tt> - a string value with a minimum of | |
494 | "minimum" characters and a maximum of "maximum" | |
a4d04587 | 495 | characters ("minimum" and "maximum" are numbers)</li> |
ef416fc2 | 496 | |
497 | </ul> | |
498 | ||
499 | <p>Examples:</p> | |
500 | ||
501 | <pre class='command'> | |
502 | <em>*% Base JCL key code option</em> | |
503 | *OpenUI JCLPasscode/Key Code: PickOne | |
504 | *OrderDependency: 10 JCLSetup *JCLPasscode | |
505 | *DefaultJCLPasscode: None | |
506 | *JCLPasscode None/No Code: "" | |
507 | *JCLPasscode 1111: "@PJL SET PASSCODE = 1111<0A>" | |
508 | *JCLPasscode 2222: "@PJL SET PASSCODE = 2222<0A>" | |
509 | *JCLPasscode 3333: "@PJL SET PASSCODE = 3333<0A>" | |
510 | *JCLCloseUI: *JCLPasscode | |
511 | ||
512 | <em>*% Custom JCL key code option</em> | |
513 | *CustomJCLPasscode True: "@PJL SET PASSCODE = \1<0A>" | |
514 | *ParamCustomJCLPasscode Code/Key Code: 1 passcode 4 4 | |
515 | ||
516 | ||
a4d04587 | 517 | <em>*% Base PostScript watermark option</em> |
518 | *OpenUI WatermarkText/Watermark Text: PickOne | |
519 | *OrderDependency: 10 AnySetup *WatermarkText | |
520 | *DefaultWatermarkText: None | |
521 | *WatermarkText None: "" | |
522 | *WatermarkText Draft: "<</cupsString1(Draft)>>setpagedevice" | |
523 | *CloseUI: *WatermarkText | |
524 | ||
525 | <em>*% Custom PostScript watermark option</em> | |
b86bc4cf | 526 | *CustomWatermarkText True: "<</cupsString1 3 -1 roll>>setpagedevice" |
a4d04587 | 527 | *ParamCustomWatermarkText Text: 1 string 0 32 |
528 | ||
529 | ||
ef416fc2 | 530 | <em>*% Base PostScript gamma/density option</em> |
531 | *OpenUI GammaDensity/Gamma and Density: PickOne | |
532 | *OrderDependency: 10 AnySetup *GammaDensity | |
533 | *DefaultGammaDensity: Normal | |
534 | *GammaDensity Normal/Normal: "<</cupsReal1 1.0/cupsReal2 1.0>>setpagedevice" | |
535 | *GammaDensity Light/Lighter: "<</cupsReal1 0.9/cupsReal2 0.67>>setpagedevice" | |
536 | *GammaDensity Dark/Darker: "<</cupsReal1 1.1/cupsReal2 1.5>>setpagedevice" | |
a4d04587 | 537 | *CloseUI: *GammaDensity |
ef416fc2 | 538 | |
539 | <em>*% Custom PostScript gamma/density option</em> | |
b86bc4cf | 540 | *CustomGammaDensity True: "<</cupsReal1 3 -1 roll/cupsReal2 5 -1>>setpagedevice" |
ef416fc2 | 541 | *ParamCustomGammaDensity Gamma: 1 curve 0.1 10 |
542 | *ParamCustomGammaDensity Density: 2 real 0 2 | |
543 | </pre> | |
544 | ||
545 | ||
546 | <h2 class='title'><a name='PROFILES'>Color Profiles</a></h2> | |
547 | ||
a4d04587 | 548 | <p>CUPS supports two types of color profiles. The first type is |
549 | based on sRGB and is used by the standard CUPS raster filters and | |
550 | ESP Ghostscript. The second type is based on ICC profiles and is | |
551 | used by the Core Graphics-based filters on MacOS X.</p> | |
552 | ||
553 | <blockquote><b>Note:</b> At this time, none of the CUPS raster | |
554 | filters support ICC profiles. This will be addressed as time | |
555 | and resources permit.</blockquote> | |
556 | ||
ef416fc2 | 557 | <h3>cupsColorProfile</h3> |
558 | ||
a4d04587 | 559 | <p class='summary'>*cupsColorProfile Resolution/MediaType: "density |
560 | gamma m00 m01 m02 m10 m11 m12 m20 m21 m22"</p> | |
ef416fc2 | 561 | |
a4d04587 | 562 | <p>This string attribute specifies an sRGB-based color profile |
563 | consisting of gamma and density controls and a 3x3 CMY color | |
564 | transform matrix.</p> | |
ef416fc2 | 565 | |
566 | <p>The <i>Resolution</i> and <i>MediaType</i> values may be "-" | |
567 | to act as a wildcard. Otherwise they must match one of the | |
568 | <tt>Resolution</tt> or <tt>MediaType</tt> attributes defined in | |
569 | the PPD file.</p> | |
570 | ||
571 | <p>The <i>density</i> and <i>gamma</i> values define gamma and | |
572 | density adjustment function such that:</p> | |
573 | ||
574 | <pre class='command'> | |
575 | f(x) = density * x <sup style='font-size: 100%'>gamma</sup> | |
576 | </pre> | |
577 | ||
578 | <p>The <i>m00</i> through <i>m22</i> values define a 3x3 | |
579 | transformation matrix for the CMY color values. The density | |
580 | function is applied <i>after</i> the CMY transformation:</p> | |
581 | ||
582 | <pre class='command'> | |
583 | | m00 m01 m02 | | |
584 | | m10 m11 m12 | | |
585 | | m20 m21 m22 | | |
586 | </pre> | |
587 | ||
588 | <p>Examples:</p> | |
589 | ||
590 | <pre class='command'> | |
591 | <em>*% Specify a profile for printing at 360dpi on all media types</em> | |
592 | *cupsColorProfile 360dpi/-: "1.0 1.5 1.0 0.0 -0.2 -0.4 1.0 0.0 -0.2 0.0 1.0" | |
593 | ||
594 | <em>*% Specify a profile for printing at 720dpi on Glossy media</em> | |
595 | *cupsColorProfile 720dpi/Glossy: "1.0 2.5 1.0 0.0 -0.2 -0.4 1.0 0.0 -0.2 0.0 1.0" | |
596 | ||
597 | <em>*% Specify a default profile for printing at all other resolutions and media types</em> | |
598 | *cupsColorProfile -/-: "0.9 2.0 1.0 0.0 -0.2 -0.4 1.0 0.0 -0.2 0.0 1.0" | |
599 | </pre> | |
600 | ||
601 | <h3>cupsICCProfile</h3> | |
602 | ||
a4d04587 | 603 | <p class='summary'>*cupsICCProfile |
604 | ColorModel.MediaType.Resolution/Description: "filename"</p> | |
ef416fc2 | 605 | |
a4d04587 | 606 | <p>This attribute specifies an ICC color profile that is |
607 | used to convert the document colors to the device | |
608 | colorspace. The <tt>ColorModel</tt>, <tt>MediaType</tt>, and | |
ef416fc2 | 609 | <tt>Resolution</tt> keywords specify a selector for color |
610 | profiles. If omitted, the color profile will match any option | |
611 | keyword for the corresponding main keyword.</p> | |
612 | ||
613 | <p>The <tt>Description</tt> specifies human-readable text that | |
614 | is associated with the color profile. The <tt>filename</tt> | |
615 | portion specifies the ICC color profile to use; if the filename | |
616 | is not absolute, it is loaded relative to the | |
617 | <var>/usr/share/cups/profiles</var> directory.</p> | |
618 | ||
619 | <p>Examples:</p> | |
620 | ||
621 | <pre class='command'> | |
622 | <em>*% Specify a profile for CMYK printing at 360dpi on all media types</em> | |
623 | *cupsICCProfile CMYK..360dpi/360dpi CMYK: "vendor/foo-360-cmyk.icc" | |
624 | ||
625 | <em>*% Specify a profile for RGB printing at 720dpi on Glossy media</em> | |
626 | *cupsColorProfile RGB.Glossy.720dpi/720dpi Glossy: "vendor/foo-720-glossy-rgb.icc" | |
627 | ||
628 | <em>*% Specify a default profile for printing at all other resolutions and media types</em> | |
fa73b229 | 629 | *cupsICCProfile ../Default: "vendor/foo-default.icc" |
ef416fc2 | 630 | </pre> |
631 | ||
632 | <h4>Customizing the Profile Selection Keywords</h4> | |
633 | ||
a9252913 | 634 | <p>The <tt>MediaType</tt> and <tt>Resolution</tt> keywords can be |
635 | reassigned to different main keywords, allowing drivers to do | |
636 | color profile selection based on different parameters. The | |
637 | <tt>cupsICCQualifier2</tt> and <tt>cupsICCQualifier3</tt> | |
ef416fc2 | 638 | attributes define the mapping from selector to main keyword:</p> |
639 | ||
640 | <pre class='command'> | |
a9252913 | 641 | *cupsICCQualifier2: MainKeyword2 |
642 | *cupsICCQualifier3: MainKeyword3 | |
ef416fc2 | 643 | </pre> |
644 | ||
645 | <p>The default mapping is as follows:</p> | |
646 | ||
647 | <pre class='command'> | |
ef416fc2 | 648 | *cupsICCQualifier2: MediaType |
649 | *cupsICCQualifier3: Resolution | |
650 | </pre> | |
651 | ||
652 | ||
ecdc0628 | 653 | <h2 class='title'><a name='I18N'>Globalized PPD Support</a></h2> |
ef416fc2 | 654 | |
655 | <p>CUPS 1.2 and higher adds support for PPD files containing multiple | |
a4d04587 | 656 | languages by following the following additional rules:</p> |
ef416fc2 | 657 | |
658 | <ol> | |
659 | ||
a4d04587 | 660 | <li>The <tt>LanguageVersion</tt> MUST be <tt>English</tt></li> |
661 | ||
662 | <li>The <tt>LanguageEncoding</tt> MUST be <tt>ISOLatin1</tt></li> | |
663 | ||
664 | <li>The <tt>cupsLanguages</tt> attribute MUST be provided and | |
665 | list each of the supported locales in the PPD file</li> | |
666 | ||
667 | <li>Main and option keywords MUST NOT exceed 34 (instead of 40) | |
668 | characters to allow room for the locale prefixes in translation | |
669 | attributes</li> | |
ef416fc2 | 670 | |
a4d04587 | 671 | <li>The main keyword "Translation" MUST NOT be used</li> |
ef416fc2 | 672 | |
a4d04587 | 673 | <li>Translation strings included with the main and option |
674 | keywords MUST NOT contain characters outside the ASCII | |
675 | subset of ISOLatin1 and UTF-8; developers wishing to use | |
676 | characters outside ASCII MUST provide a separate set of | |
677 | English localization attributes for the affected keywords.</li> | |
ef416fc2 | 678 | |
a4d04587 | 679 | <li>Localizations are specified using a locale prefix of |
ef416fc2 | 680 | the form "ll" or "ll_CC." where "ll" is the 2-letter ISO |
681 | language code and "CC" is the 2-letter ISO country | |
b94498cf | 682 | code<ul> |
683 | <li>A generic language translation ("ll") SHOULD be provided with country-specific differences ("ll_CC") provided only as needed</li> | |
684 | <li>For historical reasons, the "zh" and "zh_CN" locales map to Simplified Chinese while the "zh_TW" locale maps to Traditional Chinese</li> | |
685 | </ul></li> | |
ef416fc2 | 686 | |
a4d04587 | 687 | <li>Locale-specific translation strings MUST be encoded |
688 | using UTF-8.</li> | |
ef416fc2 | 689 | |
a4d04587 | 690 | <li>Main keywords MUST be localized using one of the |
ef416fc2 | 691 | following forms: |
692 | <p><tt>*ll.Translation MainKeyword/translation | |
693 | text: ""</tt><br /> | |
694 | <tt>*ll_CC.Translation MainKeyword/translation | |
695 | text: ""</tt></p></li> | |
696 | ||
a4d04587 | 697 | <li>Option keywords MUST be localized using one of the |
ef416fc2 | 698 | following forms: |
699 | <p><tt>*ll.MainKeyword OptionKeyword/translation | |
700 | text: ""</tt><br /> | |
701 | <tt>*ll_CC.MainKeyword OptionKeyword/translation | |
702 | text: ""</tt></p></li> | |
703 | ||
a4d04587 | 704 | <li>Localization attributes MAY appear anywhere after the |
705 | first line of the PPD file</li> | |
706 | ||
ef416fc2 | 707 | </ol> |
708 | ||
a4d04587 | 709 | <blockquote><b>Note:</b> |
710 | We use a <tt>LanguageEncoding</tt> value of <tt>ISOLatin1</tt> | |
711 | and limit the allowed base translation strings to ASCII to avoid | |
712 | character coding issues that would otherwise occur. In addition, | |
713 | requiring the base translation strings to be in English allows | |
714 | for easier fallback translation when no localization is provided | |
715 | in the PPD file for a given locale.</blockquote> | |
ef416fc2 | 716 | |
a4d04587 | 717 | <p>Examples:</p> |
ef416fc2 | 718 | |
719 | <pre class='command'> | |
720 | *LanguageVersion: English | |
721 | *LanguageEncoding: ISOLatin1 | |
b94498cf | 722 | *cupsLanguages: "de fr_CA" |
ef416fc2 | 723 | *ModelName: "Foobar Laser 9999" |
724 | ||
a4d04587 | 725 | <em>*% Localize ModelName for French and German</em> |
b94498cf | 726 | *fr_CA.Translation ModelName/La Foobar Laser 9999: "" |
727 | *de.Translation ModelName/Foobar LaserDrucken 9999: "" | |
ef416fc2 | 728 | |
4744bd90 | 729 | *cupsIPPReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html" |
b423cd4c | 730 | <em>*% Localize printer-state-reason for French and German</em> |
b94498cf | 731 | *fr_CA.cupsIPPReason com.vendor-error/Une erreur sèrieuse s'est produite: "/help/com.vendor/error.html" |
732 | *de.cupsIPPReason com.vendor-error/Eine ernste Störung trat: "/help/com.vendor/error.html" | |
b423cd4c | 733 | |
ef416fc2 | 734 | ... |
735 | ||
736 | *OpenUI *InputSlot/Paper Source: PickOne | |
737 | *OrderDependency: 10 AnySetup *InputSlot | |
738 | *DefaultInputSlot: Auto | |
a4d04587 | 739 | <em>*% Localize InputSlot for French and German</em> |
b94498cf | 740 | *fr_CA.Translation InputSlot/Papier source: "" |
741 | *de.Translation InputSlot/Papiereinzug: "" | |
ef416fc2 | 742 | *InputSlot Auto/Default: "<</ManualFeed false>>setpagedevice" |
a4d04587 | 743 | <em>*% Localize InputSlot=Auto for French and German</em> |
b94498cf | 744 | *fr_CA.InputSlot Auto/Par Defaut: "" |
745 | *de.InputSlot Auto/Standard: "" | |
ef416fc2 | 746 | *InputSlot Manual/Manual Feed: "<</ManualFeed true>>setpagedevice" |
a4d04587 | 747 | <em>*% Localize InputSlot=Manual for French and German</em> |
b94498cf | 748 | *fr_CA.InputSlot Manual/Manuel mecanisme de alimentation: "" |
749 | *de.InputSlot Manual/Manueller Einzug: "" | |
ef416fc2 | 750 | *CloseUI: *InputSlot |
751 | </pre> | |
752 | ||
753 | ||
b86bc4cf | 754 | <h2 class='title'><a name='RASTERPS'>Writing PostScript Option Commands for Raster Drivers</a></h2> |
755 | ||
756 | <p>PPD files are used for both PostScript and non-PostScript printers. For CUPS raster drivers, you use a subset of the PostScript language to set page device attributes such as page size, resolution, and so forth. For example, the following code sets the page size to A4 size:</p> | |
757 | ||
758 | <pre class='command'> | |
759 | *PageSize A4: "<</PageSize[595 842]>>setpagedevice" | |
760 | </pre> | |
761 | ||
762 | <p>Custom options typically use other operators to organize the values into a key/value dictionary for <tt>setpagedevice</tt>. For example, our previous <tt>CustomWatermarkText</tt> option code uses the <tt>roll</tt> operator to move the custom string value into the dictionary for <tt>setpagedevice</tt>:</p> | |
763 | ||
764 | <pre class='command'> | |
765 | *CustomWatermarkText True: "<</cupsString1 3 -1 roll>>setpagedevice" | |
766 | </pre> | |
767 | ||
768 | <p>For a custom string value of "My Watermark", CUPS will produce the following PostScript code for the option:</p> | |
769 | ||
770 | <pre class='command'> | |
771 | (My Watermark) | |
772 | <</cupsString1 3 -1 roll>>setpagedevice | |
773 | </pre> | |
774 | ||
775 | <p>The code moves the string value ("My Watermark") from the bottom of the stack to the top, creating a dictionary that looks like:</p> | |
776 | ||
777 | <pre class='command'> | |
778 | <</cupsString1(My Watermark)>>setpagedevice | |
779 | </pre> | |
780 | ||
781 | <p>The resulting dictionary sets the page device attributes that are sent to your raster driver in the page header.</p> | |
782 | ||
09a101d6 | 783 | <h3>Custom Page Size Code</h3> |
784 | ||
785 | <p>There are many possible implementations of the <tt>CustomPageSize</tt> code. For CUPS raster drivers, the following code is recommended:</p> | |
786 | ||
787 | <pre class='command'> | |
788 | *ParamCustomPageSize Width: 1 points <i>min-width max-width</i> | |
789 | *ParamCustomPageSize Height: 2 points <i>min-height max-height</i> | |
790 | *ParamCustomPageSize WidthOffset: 3 points 0 0 | |
791 | *ParamCustomPageSize HeightOffset: 4 points 0 0 | |
792 | *ParamCustomPageSize Orientation: 5 int 0 0 | |
793 | *CustomPageSize True: "pop pop pop <</PageSize[5 -2 roll]/ImagingBBox null>>setpagedevice" | |
794 | </pre> | |
795 | ||
b86bc4cf | 796 | <h3>Supported PostScript Operators</h3> |
797 | ||
798 | <p>CUPS supports the following PostScript operators in addition to the usual PostScript number, string (literal and hex-encoded), boolean, null, and name values:</p> | |
799 | ||
800 | <ul> | |
801 | ||
802 | <li><tt><<</tt> - Start a dictionary.</li> | |
803 | ||
804 | <li><tt>>></tt> - End a dictionary.</li> | |
805 | ||
806 | <li><tt>[</tt> - Start an array.</li> | |
807 | ||
808 | <li><tt>]</tt> - End an array.</li> | |
809 | ||
810 | <li><tt>copy</tt> - Copy the top N objects on the stack.</li> | |
811 | ||
812 | <li><tt>dup</tt> - Copy the top object on the stack.</li> | |
813 | ||
814 | <li><tt>index</tt> - Copy the Nth from the top object on the stack.</li> | |
815 | ||
816 | <li><tt>pop</tt> - Pop the top object on the stack.</li> | |
817 | ||
818 | <li><tt>roll</tt> - Shift the top N objects on the stack.</li> | |
819 | ||
820 | <li><tt>setpagedevice</tt> - Set the page header values according to the key/value dictionary on the stack.</li> | |
821 | ||
822 | </ul> | |
823 | ||
09a101d6 | 824 | <blockquote><b>Note:</b> <em>Never<em> use the unsupported <tt>dict</tt> or <tt>put</tt> operators in your option code. These operators are typically used in option code dating back to Level 1 PostScript printers, which did not support the simpler <tt><<</tt> or <tt>>></tt> operators. If you have old option code using <tt>dict</tt> or <tt>put</tt>, you can rewrite it very easily to use the newer <tt><<</tt> and <tt>>></tt> operators instead. For example, the following code to set the page size: |
825 | ||
826 | <style type='text/css'><!-- | |
827 | PRE B { | |
828 | background: #000000; | |
829 | color: #ffffff; | |
830 | padding: 2px 5px; | |
831 | } | |
832 | --></style> | |
833 | ||
834 | <pre class='command'> | |
835 | <b>1 dict dup</b> /PageSize [612 792] <b>put</b> setpagedevice | |
836 | </pre> | |
837 | ||
838 | <p>can be rewritten as:</p> | |
839 | ||
840 | <pre class='command'> | |
841 | <b><<</b> /PageSize [612 792] <b>>></b> setpagedevice | |
842 | </pre> | |
843 | ||
844 | </blockquote> | |
845 | ||
b86bc4cf | 846 | <h3>Supported Page Device Attributes</h3> |
847 | ||
09a101d6 | 848 | <p>Table 2 shows the supported page device attributes along with PostScript code examples.</p> |
b86bc4cf | 849 | |
850 | <div class='table'> | |
851 | <table summary='Supported Page Device Attributes'> | |
09a101d6 | 852 | <caption>Table 2: <a name='TABLE_2'>Supported Page Device Attributes</a></caption> |
b86bc4cf | 853 | <thead> |
854 | <tr> | |
855 | <th>Name(s)</th> | |
856 | <th>Type</th> | |
857 | <th>Description</th> | |
858 | <th>Example(s)</th> | |
859 | </tr> | |
860 | </thead> | |
861 | <tbody> | |
862 | <tr valign='top'> | |
863 | <td><tt>AdvanceDistance</tt></td> | |
864 | <td>Integer</td> | |
865 | <td>Specifies the number of points to advance roll media after printing.</td> | |
866 | <td><tt><</AdvanceDistance 18>>setpagedevice</tt></td> | |
867 | </tr> | |
868 | <tr valign='top'> | |
869 | <td><tt>AdvanceMedia</tt></td> | |
870 | <td>Integer</td> | |
871 | <td>Specifies when to advance the media: 0 = never, 1 = after the file, 2 = after the job, 3 = after the set, and 4 = after the page.</td> | |
872 | <td><tt><</AdvanceMedia 4>>setpagedevice</tt></td> | |
873 | </tr> | |
874 | <tr valign='top'> | |
875 | <td><tt>Collate</tt></td> | |
876 | <td>Boolean</td> | |
877 | <td>Specifies whether collated copies are required.</td> | |
878 | <td><tt><</Collate true>>setpagedevice</tt></td> | |
879 | </tr> | |
880 | <tr valign='top'> | |
881 | <td><tt>CutMedia</tt></td> | |
882 | <td>Integer</td> | |
883 | <td>Specifies when to cut the media: 0 = never, 1 = after the file, 2 = after the job, 3 = after the set, and 4 = after the page.</td> | |
884 | <td><tt><</CutMedia 1>>setpagedevice</tt></td> | |
885 | </tr> | |
886 | <tr valign='top'> | |
887 | <td><tt>Duplex</tt></td> | |
888 | <td>Boolean</td> | |
889 | <td>Specifies whether 2-sided printing is required.</td> | |
890 | <td><tt><</Duplex true>>setpagedevice</tt></td> | |
891 | </tr> | |
892 | <tr valign='top'> | |
893 | <td><tt>HWResolution</tt></td> | |
894 | <td>Integer Array</td> | |
895 | <td>Specifies the resolution of the page image in pixels per inch.</td> | |
896 | <td><tt><</HWResolution[1200 1200]>>setpagedevice</tt></td> | |
897 | </tr> | |
898 | <tr valign='top'> | |
899 | <td><tt>InsertSheet</tt></td> | |
900 | <td>Boolean</td> | |
901 | <td>Specifies whether to insert a blank sheet before the job.</td> | |
902 | <td><tt><</InsertSheet true>>setpagedevice</tt></td> | |
903 | </tr> | |
904 | <tr valign='top'> | |
905 | <td><tt>Jog</tt></td> | |
906 | <td>Integer</td> | |
907 | <td>Specifies when to shift the media in the output bin: 0 = never, 1 = after the file, 2 = after the job, 3 = after the set, and 4 = after the page.</td> | |
908 | <td><tt><</Jog 2>>setpagedevice</tt></td> | |
909 | </tr> | |
910 | <tr valign='top'> | |
911 | <td><tt>LeadingEdge</tt></td> | |
912 | <td>Integer</td> | |
913 | <td>Specifies the leading edge of the media: 0 = top, 1 = right, 2 = bottom, 3 = left.</td> | |
914 | <td><tt><</LeadingEdge 0>>setpagedevice</tt></td> | |
915 | </tr> | |
916 | <tr valign='top'> | |
917 | <td><tt>ManualFeed</tt></td> | |
918 | <td>Boolean</td> | |
919 | <td>Specifies whether media should be drawn from the manual feed tray. Note: The <tt>MediaPosition</tt> attribute is preferred over the <tt>ManualFeed</tt> attribute.</td> | |
920 | <td><tt><</ManualFeed true>>setpagedevice</tt></td> | |
921 | </tr> | |
922 | <tr valign='top'> | |
923 | <td><tt>MediaClass</tt></td> | |
924 | <td>String</td> | |
925 | <td>Specifies a named media.</td> | |
926 | <td><tt><</MediaClass (Invoices)>>setpagedevice</tt></td> | |
927 | </tr> | |
928 | <tr valign='top'> | |
929 | <td><tt>MediaColor</tt></td> | |
930 | <td>String</td> | |
931 | <td>Specifies the color of the media.</td> | |
932 | <td><tt><</MediaColor >>setpagedevice</tt></td> | |
933 | </tr> | |
934 | <tr valign='top'> | |
935 | <td><tt>MediaPosition</tt></td> | |
936 | <td>Integer</td> | |
937 | <td>Specifies the tray or source of the media.</td> | |
938 | <td><tt><</MediaPosition 12>>setpagedevice</tt></td> | |
939 | </tr> | |
940 | <tr valign='top'> | |
941 | <td><tt>MediaType</tt></td> | |
942 | <td>String</td> | |
943 | <td>Specifies the general media type.</td> | |
944 | <td><tt><</MediaType (Glossy)>>setpagedevice</tt></td> | |
945 | </tr> | |
946 | <tr valign='top'> | |
947 | <td><tt>MediaWeight</tt></td> | |
948 | <td>Integer</td> | |
949 | <td>Specifies the media weight in grams per meter<sup>2</sup>.</td> | |
950 | <td><tt><</MediaWeight 100>>setpagedevice</tt></td> | |
951 | </tr> | |
952 | <tr valign='top'> | |
953 | <td><tt>MirrorPrint</tt></td> | |
954 | <td>Boolean</td> | |
955 | <td>Specifies whether to flip the output image horizontally.</td> | |
956 | <td><tt><</MirrorPrint true>>setpagedevice</tt></td> | |
957 | </tr> | |
958 | <tr valign='top'> | |
959 | <td><tt>NegativePrint</tt></td> | |
960 | <td>Boolean</td> | |
961 | <td>Specifies whether to invert the output image.</td> | |
962 | <td><tt><</NegativePrint true>>setpagedevice</tt></td> | |
963 | </tr> | |
964 | <tr valign='top'> | |
965 | <td><tt>NumCopies</tt></td> | |
966 | <td>Integer</td> | |
967 | <td>Specifies the number of copies to produce of each page.</td> | |
968 | <td><tt><</NumCopies 100>>setpagedevice</tt></td> | |
969 | </tr> | |
970 | <tr valign='top'> | |
971 | <td><tt>Orientation</tt></td> | |
972 | <td>Integer</td> | |
973 | <td>Specifies the orientation of the output: 0 = portrait, 1 = landscape rotated counter-clockwise, 2 = upside-down, 3 = landscape rotated clockwise.</td> | |
974 | <td><tt><</Orientation 3>>setpagedevice</tt></td> | |
975 | </tr> | |
976 | <tr valign='top'> | |
977 | <td><tt>OutputFaceUp</tt></td> | |
978 | <td>Boolean</td> | |
979 | <td>Specifies whether to place the media face-up in the output bin/tray.</td> | |
980 | <td><tt><</OutputFaceUp true>>setpagedevice</tt></td> | |
981 | </tr> | |
982 | <tr valign='top'> | |
983 | <td><tt>OutputType</tt></td> | |
984 | <td>String</td> | |
985 | <td>Specifies the output type name.</td> | |
986 | <td><tt><</OutputType (Photo)>>setpagedevice</tt></td> | |
987 | </tr> | |
988 | <tr valign='top'> | |
989 | <td><tt>PageSize</tt></td> | |
990 | <td>Integer/Real Array</td> | |
991 | <td>Specifies the width and length/height of the page in points.</td> | |
992 | <td><tt><</PageSize[595 842]>>setpagedevice</tt></td> | |
993 | </tr> | |
994 | <tr valign='top'> | |
995 | <td><tt>Separations</tt></td> | |
996 | <td>Boolean</td> | |
997 | <td>Specifies whether to produce color separations.</td> | |
998 | <td><tt><</Separations true>>setpagedevice</tt></td> | |
999 | </tr> | |
1000 | <tr valign='top'> | |
1001 | <td><tt>TraySwitch</tt></td> | |
1002 | <td>Boolean</td> | |
1003 | <td>Specifies whether to switch trays automatically.</td> | |
1004 | <td><tt><</TraySwitch true>>setpagedevice</tt></td> | |
1005 | </tr> | |
1006 | <tr valign='top'> | |
1007 | <td><tt>Tumble</tt></td> | |
1008 | <td>Boolean</td> | |
1009 | <td>Specifies whether the back sides of pages are rotated 180 degrees.</td> | |
1010 | <td><tt><</Tumble true>>setpagedevice</tt></td> | |
1011 | </tr> | |
1012 | <tr valign='top'> | |
1013 | <td><tt>cupsBorderlessScalingFactor</tt></td> | |
1014 | <td>Real</td> | |
1015 | <td>Specifies the amount to scale the page image dimensions.</td> | |
1016 | <td><tt><</cupsBorderlessScalingFactor 1.01>>setpagedevice</tt></td> | |
1017 | </tr> | |
1018 | <tr valign='top'> | |
1019 | <td><tt>cupsColorOrder</tt></td> | |
1020 | <td>Integer</td> | |
1021 | <td>Specifies the order of colors: 0 = chunked, 1 = banded, 2 = planar.</td> | |
1022 | <td><tt><</cupsColorOrder 0>>setpagedevice</tt></td> | |
1023 | </tr> | |
1024 | <tr valign='top'> | |
1025 | <td><tt>cupsColorSpace</tt></td> | |
1026 | <td>Integer</td> | |
1027 | <td>Specifies the page image colorspace: 0 = W, 1 = RGB, 2 = RGBA, 3 = K, 4 = CMY, 5 = YMC, 6 = CMYK, 7 = YMCK, 8 = KCMY, 9 = KCMYcm, 10 = GMCK, 11 = GMCS, 12 = White, 13 = Gold, 14 = Silver, 15 = CIE XYZ, 16 = CIE Lab, 17 = RGBW, 32 to 46 = CIE Lab (1 to 15 inks)</td> | |
1028 | <td><tt><</cupsColorSpace >>setpagedevice</tt></td> | |
1029 | </tr> | |
1030 | <tr valign='top'> | |
1031 | <td><tt>cupsCompression</tt></td> | |
1032 | <td>Integer</td> | |
1033 | <td>Specifies a driver compression type/mode.</td> | |
1034 | <td><tt><</cupsCompression 2>>setpagedevice</tt></td> | |
1035 | </tr> | |
1036 | <tr valign='top'> | |
1037 | <td><tt>cupsInteger0<br> | |
1038 | ...<br> | |
1039 | cupsInteger15</tt></td> | |
1040 | <td>Integer</td> | |
1041 | <td>Specifies driver integer values.</td> | |
1042 | <td><tt><</cupsInteger11 1234>>setpagedevice</tt></td> | |
1043 | </tr> | |
1044 | <tr valign='top'> | |
1045 | <td><tt>cupsMarkerType</tt></td> | |
1046 | <td>String</td> | |
1047 | <td>Specifies the type of ink/toner to use.</td> | |
1048 | <td><tt><</cupsMarkerType (Black+Color)>>setpagedevice</tt></td> | |
1049 | </tr> | |
1050 | <tr valign='top'> | |
1051 | <td><tt>cupsMediaType</tt></td> | |
1052 | <td>Integer</td> | |
1053 | <td>Specifies a numeric media type.</td> | |
1054 | <td><tt><</cupsMediaType 999>>setpagedevice</tt></td> | |
1055 | </tr> | |
1056 | <tr valign='top'> | |
1057 | <td><tt>cupsPageSizeName</tt></td> | |
1058 | <td>String</td> | |
1059 | <td>Specifies the name of the page size.</td> | |
1060 | <td><tt><</cupsPageSizeName (A4.Full)>>setpagedevice</tt></td> | |
1061 | </tr> | |
1062 | <tr valign='top'> | |
1063 | <td><tt>cupsPreferredBitsPerColor</tt></td> | |
1064 | <td>Integer</td> | |
1065 | <td>Specifies the preferred number of bits per color, typically 8 or 16.</td> | |
1066 | <td><tt><</cupsPreferredBitsPerColor 16>>setpagedevice</tt></td> | |
1067 | </tr> | |
1068 | <tr valign='top'> | |
1069 | <td><tt>cupsReal0<br> | |
1070 | ...<br> | |
1071 | cupsReal15</tt></td> | |
1072 | <td>Real</td> | |
1073 | <td>Specifies driver real number values.</td> | |
1074 | <td><tt><</cupsReal15 1.234>>setpagedevice</tt></td> | |
1075 | </tr> | |
1076 | <tr valign='top'> | |
1077 | <td><tt>cupsRenderingIntent</tt></td> | |
1078 | <td>String</td> | |
1079 | <td>Specifies the color rendering intent.</td> | |
1080 | <td><tt><</cupsRenderingIntent (AbsoluteColorimetric)>>setpagedevice</tt></td> | |
1081 | </tr> | |
1082 | <tr valign='top'> | |
1083 | <td><tt>cupsRowCount</tt></td> | |
1084 | <td>Integer</td> | |
1085 | <td>Specifies the number of rows of raster data to print on each line for some drivers.</td> | |
1086 | <td><tt><</cupsRowCount 24>>setpagedevice</tt></td> | |
1087 | </tr> | |
1088 | <tr valign='top'> | |
1089 | <td><tt>cupsRowFeed</tt></td> | |
1090 | <td>Integer</td> | |
1091 | <td>Specifies the number of rows to feed between passes for some drivers.</td> | |
1092 | <td><tt><</cupsRowFeed 17>>setpagedevice</tt></td> | |
1093 | </tr> | |
1094 | <tr valign='top'> | |
1095 | <td><tt>cupsRowStep</tt></td> | |
1096 | <td>Integer</td> | |
1097 | <td>Specifies the number of lines between columns/rows on the print head for some drivers.</td> | |
1098 | <td><tt><</cupsRowStep 2>>setpagedevice</tt></td> | |
1099 | </tr> | |
1100 | <tr valign='top'> | |
1101 | <td><tt>cupsString0<br> | |
1102 | ...<br> | |
1103 | cupsString15</tt></td> | |
1104 | <td>String</td> | |
1105 | <td>Specifies driver string values.</td> | |
1106 | <td><tt><</cupsString0(String Value)>>setpagedevice</tt></td> | |
1107 | </tr> | |
1108 | </tbody> | |
1109 | </table></div> | |
1110 | ||
1111 | ||
ef416fc2 | 1112 | <h2 class='title'><a name='HISTORY'>Change History</a></h2> |
1113 | ||
f7deaa1a | 1114 | <h3>Changes in CUPS 1.3</h3> |
1115 | ||
1116 | <ul> | |
1117 | ||
09a101d6 | 1118 | <li>Added <tt>APPrinterPreset</tt>, <tt>cupsIPPFinishings</tt>, and <tt>cupsPreFilter</tt> attributes.</li> |
1119 | ||
1120 | <li>Added discussion of custom option code, sample <tt>CustomPageSize</tt> code, and "do not use dict and put" note.</li> | |
f7deaa1a | 1121 | |
1122 | </ul> | |
1123 | ||
b86bc4cf | 1124 | <h3>Changes in CUPS 1.2.8</h3> |
1125 | ||
1126 | <ul> | |
1127 | ||
1128 | <li>Added section on supported PostScript commands for raster | |
1129 | drivers</li> | |
1130 | ||
1131 | </ul> | |
1132 | ||
ef416fc2 | 1133 | <h3>Changes in CUPS 1.2</h3> |
1134 | ||
1135 | <ul> | |
1136 | ||
ecdc0628 | 1137 | <li>Added globalization support attributes</li> |
ef416fc2 | 1138 | |
1139 | <li>Added custom option values support</li> | |
1140 | ||
4744bd90 | 1141 | <li>Added <tt>APBookFile</tt> attribute</li> |
1142 | ||
a4d04587 | 1143 | <li>Added <tt>APDuplexRequiresFlippedMargin</tt> attribute</li> |
1144 | ||
ef416fc2 | 1145 | <li>Added <tt>cupsICCProfile</tt> attribute</li> |
1146 | ||
4744bd90 | 1147 | <li>Added <tt>cupsIPPReason</tt> attribute</li> |
1148 | ||
a4d04587 | 1149 | <li>Added <tt>cupsLanguages</tt> attribute</li> |
1150 | ||
ef416fc2 | 1151 | <li>Added <tt>cupsPortMonitor</tt> attribute</li> |
1152 | ||
1153 | <li>Removed <tt>cupsProtocol</tt> attribute</li> | |
1154 | ||
1155 | </ul> | |
1156 | ||
1157 | <h3>Changes in CUPS 1.1</h3> | |
1158 | ||
1159 | <ul> | |
1160 | ||
1161 | <li>Added <tt>cupsFlipDuplex</tt> attribute</li> | |
1162 | ||
1163 | <li>Added <tt>cupsProtocol</tt> attribute</li> | |
1164 | ||
1165 | </ul> | |
1166 | ||
1167 | </body> | |
1168 | </html> |