]> git.ipfire.org Git - thirdparty/cups.git/blob - doc/help/spec-ppd.html
Import CUPS 1.4svn r7023 into easysw/current.
[thirdparty/cups.git] / doc / help / spec-ppd.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
2 <html>
3 <!-- SECTION: Specifications -->
4 <head>
5 <title>CUPS PPD Extensions</title>
6 <meta name='keywords' content='Programming, PostScript Printer Description'>
7 <link rel='stylesheet' type='text/css' href='../cups-printable.css'>
8 </head>
9 <body>
10 <!--
11 "$Id: spec-ppd.html 6993 2007-09-28 18:05:28Z mike $"
12
13 CUPS PPD extensions specification for the Common UNIX Printing System (CUPS).
14
15 Copyright 2007 by Apple Inc.
16 Copyright 1997-2007 by Easy Software Products.
17
18 These coded instructions, statements, and computer programs are the
19 property of Apple Inc. and are protected by Federal copyright
20 law. Distribution and use rights are outlined in the file "LICENSE.txt"
21 which should have been included with this file. If this file is
22 file is missing or damaged, see the license at "http://www.cups.org/".
23 -->
24
25 <h2 class='title'><a name='INTRODUCTION'>Introduction</a></h2>
26
27 <p>This specification describes the attributes and extensions
28 that CUPS adds to <a
29 href="http://partners.adobe.com/public/developer/en/ps/5003.PPD_Spec_v4.3.pdf">
30 Adobe TechNote #5003: PostScript Printer Description File Format
31 Specification Version 4.3</a>. PostScript Printer Description
32 ("PPD") files describe the capabilities of each printer and are
33 used by CUPS to support printer-specific features and intelligent
34 filtering.</p>
35
36 <h2 class='title'><a name='SYNTAX'>PPD File Syntax</a></h2>
37
38 <p>The PPD format is text-based and uses lines of up to 255
39 characters terminated by a carriage return, linefeed, or
40 combination of carriage return and line feed. The following ABNF
41 definition [RFC2234] defines the general format of lines in a PPD
42 file:</p>
43
44 <pre class='command'>
45 PPD-FILE = HEADER +(DATA / COMMENT / LINE-END)
46
47 HEADER = "*" 0x50.50.44.2D.41.64.6F.62.65 ":" ; *PPD-Adobe:
48 *WSP DQUOTE "4.3" DQUOTE LINE-END
49
50 COMMENT = "*%" *TCHAR LINE-END
51
52 DATA = "*" 1*KCHAR [ WSP 1*KCHAR [ "/" 1*TCHAR ] ] ":"
53 1*(*WSP VALUE) LINE-END
54
55 VALUE = 1*TCHAR / DQUOTE 1*SCHAR DQUOTE
56
57 KCHAR = ALPHA / DIGIT / "_" / "." / "-"
58
59 SCHAR = LINE-END / WSP / %x21 / %x23-7E / %xA0-FF
60
61 TCHAR = %x20-7E / %xA0-FF
62
63 LINE-END = CR / LF / CR LF
64 </pre>
65
66
67 <h2 class='title'><a name='AUTOCONFIG'>Auto-Configuration</a></h2>
68
69 <p>CUPS supports several methods of auto-configuration via PPD attributes.
70 <em>Currently these methods are only implemented on Mac OS X.</em></p>
71
72 <h3><span class='info'>Mac OS X 10.5</span><a name='APAutoSetupTool'>APAutoSetupTool</a></h3>
73
74 <p class='summary'>*APAutoSetupTool: "/LibraryPrinters/vendor/filename"</p>
75
76 <p>This attribute defines a program that sets the default option choices. It
77 is run when a printer is added from the printer browser instead of the
78 normal PostScript query and SNMP OID attribute lookups.</p>
79
80 <p>The program is provided with two arguments: the printer's device URI and
81 the PPD file to be used for the printer. The program must write an updated
82 PPD file to stdout.</p>
83
84 <p>Examples:</p>
85
86 <pre class='command'>
87 *% Use our setup tool when adding a printer
88 *APAutoSetupTool: "/Library/Printers/vendor/Tools/autosetuptool"
89 </pre>
90
91 <h3><span class='info'>Mac OS X 10.2</span><a name='QUERYKEYWORD'>?MainKeyword</a></h3>
92
93 <p class='summary'>*?<i>MainKeyword</i>: "<br>
94 PostScript query code that writes a message using the = operator...<br>
95 "<br>
96 *End</p>
97
98 <p>The <tt>?<i>MainKeyword</i></tt> attribute defines PostScript code that
99 determines the currently selected/enabled option keyword (choice) for the
100 main keyword (option). It is typically used when communicating with USB,
101 serial, Appletalk, and AppSocket (port 9100) printers.</p>
102
103 <p>The PostScript code typically sends its response back using the <tt>=</tt>
104 operator.</p>
105
106 <p>Example:</p>
107
108 <pre class='command'>
109 *OpenUI OptionDuplex/Duplexer Installed: Boolean
110 *DuplexOptionDuplex: False
111 *OptionDuplex False/Not Installed: ""
112 *OptionDuplex True/Installed: ""
113
114 <em>*% Query the printer for the presence of the duplexer option...</em>
115 *?OptionDuplex: "
116 currentpagedevice /Duplex known
117 {(True)} {(False)} ifelse
118 = flush
119 "
120 *End
121 *CloseUI: OptionDuplex
122 </pre>
123
124 <h3><span class='info'>Mac OS X 10.4</span><a name='OID'>OIDMainKeyword</a></h3>
125
126 <p class='summary'>*?OID<i>MainKeyword</i>: ".n.n.n..."<br>
127 *OID<i>MainKeyword</i> <i>OptionKeyword1</i>: "value"<br>
128 ...<br>
129 *OID<i>MainKeyword</i> <i>OptionKeywordN</i>: "value"</p>
130
131 <p>The <tt>OID<i>MainKeyword</i></tt> attribute is used to define
132 SNMP OIDs that map to installable options. The first (query) line
133 defines the OID to lookup on the network device. The second and
134 subsequent attributes define a mapping from OID value to option
135 keyword. Since SNMP is an IP-based network protocol, this method
136 is typically only used to configure AppSocket, IPP, and LPD network
137 printers.</p>
138
139 <p>Examples:</p>
140
141 <pre class='command'>
142 *% Get the installed memory on the printer...
143 *?OIDInstalledMemory: ".1.3.6.1.2.1.25.2.2.0"
144 *OIDInstalledMemory 16MB: "16384 KBytes"
145 *OIDInstalledMemory 32MB: "32768 KBytes"
146 *OIDInstalledMemory 48MB: "49152 KBytes"
147 *OIDInstalledMemory 72MB: "73728 KBytes"
148 </pre>
149
150
151 <h2 class='title'><a name='PROFILES'>Color Profiles</a></h2>
152
153 <p>CUPS supports three types of color profiles. The first type is
154 based on sRGB and is used by the standard CUPS raster filters and
155 GPL Ghostscript. The second type is based on ICC profiles and is
156 used by the Quartz-based filters on MacOS X. The final type is
157 based on well-known colorspaces such as sRGB and Adobe RGB.</p>
158
159 <blockquote><b>Note:</b>
160
161 <p>At this time, none of the CUPS raster
162 filters support ICC profiles. This will be addressed as time
163 and resources permit.</p>
164
165 </blockquote>
166
167 <h3><a name='cupsColorProfile'>cupsColorProfile</a></h3>
168
169 <p class='summary'>*cupsColorProfile Resolution/MediaType: "density
170 gamma m00 m01 m02 m10 m11 m12 m20 m21 m22"</p>
171
172 <p>This string attribute specifies an sRGB-based color profile
173 consisting of gamma and density controls and a 3x3 CMY color
174 transform matrix.</p>
175
176 <p>The <i>Resolution</i> and <i>MediaType</i> values may be "-"
177 to act as a wildcard. Otherwise they must match one of the
178 <tt>Resolution</tt> or <tt>MediaType</tt> attributes defined in
179 the PPD file.</p>
180
181 <p>The <i>density</i> and <i>gamma</i> values define gamma and
182 density adjustment function such that:</p>
183
184 <pre class='command'>
185 f(x) = density * x <sup style='font-size: 100%'>gamma</sup>
186 </pre>
187
188 <p>The <i>m00</i> through <i>m22</i> values define a 3x3
189 transformation matrix for the CMY color values. The density
190 function is applied <i>after</i> the CMY transformation:</p>
191
192 <pre class='command'>
193 | m00 m01 m02 |
194 | m10 m11 m12 |
195 | m20 m21 m22 |
196 </pre>
197
198 <p>Examples:</p>
199
200 <pre class='command'>
201 <em>*% Specify a profile for printing at 360dpi on all media types</em>
202 *cupsColorProfile 360dpi/-: "1.0 1.5 1.0 0.0 -0.2 -0.4 1.0 0.0 -0.2 0.0 1.0"
203
204 <em>*% Specify a profile for printing at 720dpi on Glossy media</em>
205 *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"
206
207 <em>*% Specify a default profile for printing at all other resolutions and media types</em>
208 *cupsColorProfile -/-: "0.9 2.0 1.0 0.0 -0.2 -0.4 1.0 0.0 -0.2 0.0 1.0"
209 </pre>
210
211 <h3><span class='info'>Mac OS X 10.3/CUPS 1.2</span><a name='cupsICCProfile'>cupsICCProfile</a></h3>
212
213 <p class='summary'>*cupsICCProfile
214 ColorModel.MediaType.Resolution/Description: "filename"</p>
215
216 <p>This attribute specifies an ICC color profile that is
217 used to convert the document colors to the device
218 colorspace. The <tt>ColorModel</tt>, <tt>MediaType</tt>, and
219 <tt>Resolution</tt> keywords specify a selector for color
220 profiles. If omitted, the color profile will match any option
221 keyword for the corresponding main keyword.</p>
222
223 <p>The <tt>Description</tt> specifies human-readable text that
224 is associated with the color profile. The <tt>filename</tt>
225 portion specifies the ICC color profile to use; if the filename
226 is not absolute, it is loaded relative to the
227 <var>/usr/share/cups/profiles</var> directory.</p>
228
229 <p>Examples:</p>
230
231 <pre class='command'>
232 <em>*% Specify a profile for CMYK printing at 360dpi on all media types</em>
233 *cupsICCProfile CMYK..360dpi/360dpi CMYK: "/Library/Printers/vendor/Profiles/foo-360-cmyk.icc"
234
235 <em>*% Specify a profile for RGB printing at 720dpi on Glossy media</em>
236 *cupsColorProfile RGB.Glossy.720dpi/720dpi Glossy: "/Library/Printers/vendor/Profiles/foo-720-glossy-rgb.icc"
237
238 <em>*% Specify a default profile for printing at all other resolutions and media types</em>
239 *cupsICCProfile ../Default: "/Library/Printers/vendor/Profiles/foo-default.icc"
240 </pre>
241
242 <h4>Customizing the Profile Selection Keywords</h4>
243
244 <p>The <tt>MediaType</tt> and <tt>Resolution</tt> keywords can be
245 reassigned to different main keywords, allowing drivers to do
246 color profile selection based on different parameters. The
247 <tt>cupsICCQualifier2</tt> and <tt>cupsICCQualifier3</tt>
248 attributes define the mapping from selector to main keyword:</p>
249
250 <pre class='command'>
251 *cupsICCQualifier2: MainKeyword2
252 *cupsICCQualifier3: MainKeyword3
253 </pre>
254
255 <p>The default mapping is as follows:</p>
256
257 <pre class='command'>
258 *cupsICCQualifier2: MediaType
259 *cupsICCQualifier3: Resolution
260 </pre>
261
262 <h3><span class='info'>Mac OS X 10.4</span><a name='APCustom'>Custom Color Matching Support</a></h3>
263
264 <p class='summary'>*<a href='#APSupportsCustomColorMatching'>APSupportsCustomColorMatching</a>: true<br>
265 *<a href='#APCustomColorMatchingName'>APCustomColorMatchingName</a> name/text: ""<br>
266 *<a href='#APCustomColorMatchingProfile'>APCustomColorMatchingProfile</a>: profile<br>
267 *<a href='#APDefaultCustomColorMatchingProfile'>APDefaultCustomColorMatchingProfile</a>: profile</p>
268
269 <p>These attributes tell the Mac OS X raster filters that the printer
270 driver provides its own custom color matching and that generic color
271 profiles should be used when generating 1-, 3-, and 4-component raster
272 data as requested by the driver. The <tt>APCustomColorMatchingProfile</tt>
273 and <tt>APDefaultColorMatchingProfile</tt> attributes specify alternate
274 color profiles (sRGB or AdobeRGB) to use for 3-color (RGB) raster data.</p>
275
276 <h4><span class='info'>Mac OS X 10.5</span><a name='APCustomColorMatchingName'>APCustomColorMatchingName</a></h4>
277
278 <p class='summary'>*APCustomColorMatchingName name/text: ""</p>
279
280 <p>This attribute defines an alternate name for the color matching
281 provided by a driver in the <var>Color Matching</var> print panel.
282 The default is to use the name "Vendor Matching" or its localized
283 equivalent.</p>
284
285 <p>Examples:</p>
286
287 <pre class='command'>
288 *% Define the names for our color matching...
289 *APCustomColorMatchingName name/AcmeColor(tm): ""
290 *fr.APCustomColorMatchingName name/La AcmeColor(tm): ""
291 </pre>
292
293 <h4><span class='info'>Mac OS X 10.5</span><a name='APCustomColorMatchingProfile'>APCustomColorMatchingProfile</a></h4>
294
295 <p class='summary'>*APCustomColorMatchingProfile: name</p>
296
297 <p>This attribute defines a supported RGB color profile that can be used
298 when doing custom color matching. Currently only <tt>sRGB</tt> and
299 <tt>AdobeRGB</tt> are supported. If not specified, RGB data will use the
300 Generic RGB colorspace.</p>
301
302 <blockquote><b>Note:</b>
303
304 <p>If you provide multiple <tt>APCustomColorMatchingProfile</tt> attributes,
305 you are responsible for providing the necessary user interface controls to
306 select the profile in a <a href='#APDialogExtension'>print dialog pane</a>.
307 Add the named profile to the print settings using the key
308 <tt>kPMCustomColorMatchingProfileKey</tt>.</p>
309
310 </blockquote>
311
312 <p>Examples:</p>
313
314 <pre class='command'>
315 *% Use sRGB for RGB color by default, but support both sRGB and AdobeRGB
316 *APSupportsCustomColorMatching: true
317 *APDefaultCustomColorMatchingProfile: sRGB
318 *APCustomColorMatchingProfile: sRGB
319 *APCustomColorMatchingProfile: AdobeRGB
320 </pre>
321
322 <h4><span class='info'>Mac OS X 10.5</span><a name='APDefaultCustomColorMatchingProfile'>APDefaultCustomColorMatchingProfile</a></h4>
323
324 <p class='summary'>*APDefaultCustomColorMatchingProfile: name</p>
325
326 <p>This attribute defines the default RGB color profile that will be used
327 when doing custom color matching. Currently only <tt>sRGB</tt> and
328 <tt>AdobeRGB</tt> are supported.</p>
329
330 <p>Examples:</p>
331
332 <pre class='command'>
333 *% Use sRGB for RGB color by default
334 *APSupportsCustomColorMatching: true
335 *APDefaultCustomColorMatchingProfile: sRGB
336 </pre>
337
338 <h4><span class='info'>Mac OS X 10.4</span><a name='APSupportsCustomColorMatching'>APSupportsCustomColorMatching</a></h4>
339
340 <p class='summary'>*APSupportsCustomColorMatching: boolean</p>
341
342 <p>This attribute specifies that the driver provides its own custom color
343 matching. When <tt>true</tt>, the default hand-off colorspace will be
344 Generic Gray, Generic RGB, or Generic CMYK depending on the number of
345 components the driver requests. The <a
346 href='#APDefaultCustomColorMatchingProfile'><tt>APDefaultCustomColorMatchingProfile</tt></a>
347 attribute can be used to override the default 3-component (RGB) colorspace.</p>
348
349 <p>The default for <tt>APSupportsCustomColorMatching</tt> is <tt>false</tt>.</p>
350
351 <p>Examples:</p>
352
353 <pre class='command'>
354 *APSupportsCustomColorMatching: true
355 *APDefaultCustomColorMatchingProfile: sRGB
356 </pre>
357
358
359 <h2 class='title'><a name='I18N'>Globalized PPD Support</a></h2>
360
361 <p>CUPS 1.2 and higher adds support for PPD files containing multiple
362 languages by following the following additional rules:</p>
363
364 <ol>
365
366 <li>The <tt>LanguageVersion</tt> MUST be <tt>English</tt></li>
367
368 <li>The <tt>LanguageEncoding</tt> MUST be <tt>ISOLatin1</tt></li>
369
370 <li>The <tt>cupsLanguages</tt> attribute MUST be provided and
371 list each of the supported locales in the PPD file</li>
372
373 <li>Main and option keywords MUST NOT exceed 34 (instead of 40)
374 characters to allow room for the locale prefixes in translation
375 attributes</li>
376
377 <li>The main keyword "Translation" MUST NOT be used</li>
378
379 <li>Translation strings included with the main and option
380 keywords MUST NOT contain characters outside the ASCII
381 subset of ISOLatin1 and UTF-8; developers wishing to use
382 characters outside ASCII MUST provide a separate set of
383 English localization attributes for the affected keywords.</li>
384
385 <li>Localizations are specified using a locale prefix of
386 the form "ll" or "ll_CC." where "ll" is the 2-letter ISO
387 language code and "CC" is the 2-letter ISO country
388 code<ul>
389 <li>A generic language translation ("ll") SHOULD be provided with country-specific differences ("ll_CC") provided only as needed</li>
390 <li>For historical reasons, the "zh" and "zh_CN" locales map to Simplified Chinese while the "zh_TW" locale maps to Traditional Chinese</li>
391 </ul></li>
392
393 <li>Locale-specific translation strings MUST be encoded
394 using UTF-8.</li>
395
396 <li>Main keywords MUST be localized using one of the
397 following forms:
398 <p><tt>*ll.Translation MainKeyword/translation
399 text: ""</tt><br />
400 <tt>*ll_CC.Translation MainKeyword/translation
401 text: ""</tt></p></li>
402
403 <li>Option keywords MUST be localized using one of the
404 following forms:
405 <p><tt>*ll.MainKeyword OptionKeyword/translation
406 text: ""</tt><br />
407 <tt>*ll_CC.MainKeyword OptionKeyword/translation
408 text: ""</tt></p></li>
409
410 <li>Localization attributes MAY appear anywhere after the
411 first line of the PPD file</li>
412
413 </ol>
414
415 <blockquote><b>Note:</b>
416
417 <p>We use a <tt>LanguageEncoding</tt> value of <tt>ISOLatin1</tt>
418 and limit the allowed base translation strings to ASCII to avoid
419 character coding issues that would otherwise occur. In addition,
420 requiring the base translation strings to be in English allows
421 for easier fallback translation when no localization is provided
422 in the PPD file for a given locale.</p>
423
424 </blockquote>
425
426 <p>Examples:</p>
427
428 <pre class='command'>
429 *LanguageVersion: English
430 *LanguageEncoding: ISOLatin1
431 *cupsLanguages: "de fr_CA"
432 *ModelName: "Foobar Laser 9999"
433
434 <em>*% Localize ModelName for French and German</em>
435 *fr_CA.Translation ModelName/La Foobar Laser 9999: ""
436 *de.Translation ModelName/Foobar LaserDrucken 9999: ""
437
438 *cupsIPPReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html"
439 <em>*% Localize printer-state-reason for French and German</em>
440 *fr_CA.cupsIPPReason com.vendor-error/Une erreur s&egrave;rieuse s'est produite: "/help/com.vendor/error.html"
441 *de.cupsIPPReason com.vendor-error/Eine ernste St&ouml;rung trat: "/help/com.vendor/error.html"
442
443 ...
444
445 *OpenUI *InputSlot/Paper Source: PickOne
446 *OrderDependency: 10 AnySetup *InputSlot
447 *DefaultInputSlot: Auto
448 <em>*% Localize InputSlot for French and German</em>
449 *fr_CA.Translation InputSlot/Papier source: ""
450 *de.Translation InputSlot/Papiereinzug: ""
451 *InputSlot Auto/Default: "&lt;&lt;/ManualFeed false&gt;&gt;setpagedevice"
452 <em>*% Localize InputSlot=Auto for French and German</em>
453 *fr_CA.InputSlot Auto/Par Defaut: ""
454 *de.InputSlot Auto/Standard: ""
455 *InputSlot Manual/Manual Feed: "&lt;&lt;/ManualFeed true&gt;&gt;setpagedevice"
456 <em>*% Localize InputSlot=Manual for French and German</em>
457 *fr_CA.InputSlot Manual/Manuel mecanisme de alimentation: ""
458 *de.InputSlot Manual/Manueller Einzug: ""
459 *CloseUI: *InputSlot
460 </pre>
461
462
463 <h2 class='title'><a name='OPTIONS'>Custom Options</a></h2>
464
465 <p>CUPS supports custom options using an extension of the
466 <tt>CustomPageSize</tt> and <tt>ParamCustomPageSize</tt>
467 syntax:</p>
468
469 <pre class='command'>
470 *CustomFoo True: "command"
471 *ParamCustomFoo Name1/Text 1: order type minimum maximum
472 *ParamCustomFoo Name2/Text 2: order type minimum maximum
473 ...
474 *ParamCustomFoo NameN/Text N: order type minimum maximum
475 </pre>
476
477 <p>When the base option is part of the <tt>JCLSetup</tt> section,
478 the "command" string contains JCL commands with "\order"
479 placeholders for each numbered parameter. The CUPS API handles
480 any necessary value quoting for HP-PJL commands. For example, if
481 the JCL command string is "@PJL SET PASSCODE=\1" and the first
482 option value is "1234" then CUPS will output the string
483 "@PJL SET PASSCODE=1234".</p>
484
485 <p>For non-<tt>JCLSetup</tt> options, the "order" value is a
486 number from 1 to N and specifies the order of values as they are
487 placed on the stack before the command. For example, if the
488 PostScript command string is
489 "&lt;&lt;/cupsReal1 2 1 roll&gt;&gt;setpagedevice" and the
490 option value is "2.0" then CUPS will output the string
491 "2.0 &lt;&lt;/cupsReal1 2 1 roll&gt;&gt;setpagedevice".</p>
492
493 <p>The "type" is one of the following keywords:</p>
494
495 <ul>
496
497 <li><tt>curve</tt> - a real value from "minimum" to
498 "maximum" representing a gamma correction curve using the
499 function: f(x) = x <sup>value</sup></li>
500
501 <li><tt>int</tt> - an integer value from "minimum" to
502 "maximum"</li>
503
504 <li><tt>invcurve</tt> - a real value from "minimum" to
505 "maximum" representing a gamma correction curve using the
506 function: f(x) = x <sup>1 / value</sup></li>
507
508 <li><tt>passcode</tt> - a string of numbers value with a
509 minimum of "minimum" numbers and a maximum of "maximum"
510 numbers ("minimum" and "maximum" are numbers and passcode
511 strings are not displayed in the user interface)</li>
512
513 <li><tt>password</tt> - a string value with a minimum of
514 "minimum" characters and a maximum of "maximum"
515 characters ("minimum" and "maximum" are numbers and password
516 strings are not displayed in the user interface)</li>
517
518 <li><tt>points</tt> - a measurement value in points from
519 "minimum" to "maximum"</li>
520
521 <li><tt>real</tt> - a real value from "minimum" to
522 "maximum"</li>
523
524 <li><tt>string</tt> - a string value with a minimum of
525 "minimum" characters and a maximum of "maximum"
526 characters ("minimum" and "maximum" are numbers)</li>
527
528 </ul>
529
530 <blockquote><b>Note:</b>
531
532 <p>Custom options are not directly supported by the Mac OS X Print Dialog
533 nor by the CUPS web interface at this time. Vendors that use custom
534 options on Mac OS X must provide their own user interface via the
535 <a href='#APDialogExtension'><tt>APDialogExtension</tt></a> attribute.</p>
536
537 </blockquote>
538
539 <p>Examples:</p>
540
541 <pre class='command'>
542 <em>*% Base JCL key code option</em>
543 *OpenUI JCLPasscode/Key Code: PickOne
544 *OrderDependency: 10 JCLSetup *JCLPasscode
545 *DefaultJCLPasscode: None
546 *JCLPasscode None/No Code: ""
547 *JCLPasscode 1111: "@PJL SET PASSCODE = 1111&lt;0A&gt;"
548 *JCLPasscode 2222: "@PJL SET PASSCODE = 2222&lt;0A&gt;"
549 *JCLPasscode 3333: "@PJL SET PASSCODE = 3333&lt;0A&gt;"
550 *JCLCloseUI: *JCLPasscode
551
552 <em>*% Custom JCL key code option</em>
553 *CustomJCLPasscode True: "@PJL SET PASSCODE = \1&lt;0A&gt;"
554 *ParamCustomJCLPasscode Code/Key Code: 1 passcode 4 4
555
556
557 <em>*% Base PostScript watermark option</em>
558 *OpenUI WatermarkText/Watermark Text: PickOne
559 *OrderDependency: 10 AnySetup *WatermarkText
560 *DefaultWatermarkText: None
561 *WatermarkText None: ""
562 *WatermarkText Draft: "&lt;&lt;/cupsString1(Draft)&gt;&gt;setpagedevice"
563 *CloseUI: *WatermarkText
564
565 <em>*% Custom PostScript watermark option</em>
566 *CustomWatermarkText True: "&lt;&lt;/cupsString1 3 -1 roll&gt;&gt;setpagedevice"
567 *ParamCustomWatermarkText Text: 1 string 0 32
568
569
570 <em>*% Base PostScript gamma/density option</em>
571 *OpenUI GammaDensity/Gamma and Density: PickOne
572 *OrderDependency: 10 AnySetup *GammaDensity
573 *DefaultGammaDensity: Normal
574 *GammaDensity Normal/Normal: "&lt;&lt;/cupsReal1 1.0/cupsReal2 1.0&gt;&gt;setpagedevice"
575 *GammaDensity Light/Lighter: "&lt;&lt;/cupsReal1 0.9/cupsReal2 0.67&gt;&gt;setpagedevice"
576 *GammaDensity Dark/Darker: "&lt;&lt;/cupsReal1 1.1/cupsReal2 1.5&gt;&gt;setpagedevice"
577 *CloseUI: *GammaDensity
578
579 <em>*% Custom PostScript gamma/density option</em>
580 *CustomGammaDensity True: "&lt;&lt;/cupsReal1 3 -1 roll/cupsReal2 5 -1&gt;&gt;setpagedevice"
581 *ParamCustomGammaDensity Gamma: 1 curve 0.1 10
582 *ParamCustomGammaDensity Density: 2 real 0 2
583 </pre>
584
585
586 <h2 class='title'><a name='RASTERPS'>Writing PostScript Option Commands for Raster Drivers</a></h2>
587
588 <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>
589
590 <pre class='command'>
591 *PageSize A4: "&lt;&lt;/PageSize[595 842]&gt;&gt;setpagedevice"
592 </pre>
593
594 <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>
595
596 <pre class='command'>
597 *CustomWatermarkText True: "&lt;&lt;/cupsString1 3 -1 roll&gt;&gt;setpagedevice"
598 </pre>
599
600 <p>For a custom string value of "My Watermark", CUPS will produce the following PostScript code for the option:</p>
601
602 <pre class='command'>
603 (My Watermark)
604 &lt;&lt;/cupsString1 3 -1 roll&gt;&gt;setpagedevice
605 </pre>
606
607 <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>
608
609 <pre class='command'>
610 &lt;&lt;/cupsString1(My Watermark)&gt;&gt;setpagedevice
611 </pre>
612
613 <p>The resulting dictionary sets the page device attributes that are sent to your raster driver in the page header.</p>
614
615 <h3>Custom Page Size Code</a></h3>
616
617 <p>There are many possible implementations of the <tt>CustomPageSize</tt> code. For CUPS raster drivers, the following code is recommended:</p>
618
619 <pre class='command'>
620 *ParamCustomPageSize Width: 1 points <i>min-width max-width</i>
621 *ParamCustomPageSize Height: 2 points <i>min-height max-height</i>
622 *ParamCustomPageSize WidthOffset: 3 points 0 0
623 *ParamCustomPageSize HeightOffset: 4 points 0 0
624 *ParamCustomPageSize Orientation: 5 int 0 0
625 *CustomPageSize True: "pop pop pop &lt;&lt;/PageSize[5 -2 roll]/ImagingBBox null&gt;&gt;setpagedevice"
626 </pre>
627
628 <h3>Supported PostScript Operators</a></h3>
629
630 <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>
631
632 <ul>
633
634 <li><tt>&lt;&lt;</tt> - Start a dictionary.</li>
635
636 <li><tt>&gt;&gt;</tt> - End a dictionary.</li>
637
638 <li><tt>[</tt> - Start an array.</li>
639
640 <li><tt>]</tt> - End an array.</li>
641
642 <li><tt>copy</tt> - Copy the top N objects on the stack.</li>
643
644 <li><tt>dup</tt> - Copy the top object on the stack.</li>
645
646 <li><tt>index</tt> - Copy the Nth from the top object on the stack.</li>
647
648 <li><tt>pop</tt> - Pop the top object on the stack.</li>
649
650 <li><tt>roll</tt> - Shift the top N objects on the stack.</li>
651
652 <li><tt>setpagedevice</tt> - Set the page header values according to the key/value dictionary on the stack.</li>
653
654 </ul>
655
656 <blockquote><b>Note:</b>
657
658 <p><em>Never</em> use the unsupported <tt>dict</tt> or <tt>put</tt>
659 operators in your option code. These operators are typically used in
660 option code dating back to Level 1 PostScript printers, which did not
661 support the simpler <tt>&lt;&lt;</tt> or <tt>&gt;&gt;</tt> operators.
662 If you have old option code using <tt>dict</tt> or <tt>put</tt>, you can
663 rewrite it very easily to use the newer <tt>&lt;&lt;</tt> and
664 <tt>&gt;&gt;</tt> operators instead. For example, the following code
665 to set the page size:</p>
666
667 <style type='text/css'><!--
668 PRE B {
669 background: #000000;
670 color: #ffffff;
671 padding: 2px 5px;
672 }
673 --></style>
674
675 <pre class='command'>
676 <b>1 dict dup</b> /PageSize [612 792] <b>put</b> setpagedevice
677 </pre>
678
679 <p>can be rewritten as:</p>
680
681 <pre class='command'>
682 <b>&lt;&lt;</b> /PageSize [612 792] <b>&gt;&gt;</b> setpagedevice
683 </pre>
684
685 </blockquote>
686
687 <h3>Supported Page Device Attributes</a></h3>
688
689 <p>Table 2 shows the supported page device attributes along with PostScript code examples.</p>
690
691 <div class='table'>
692 <table summary='Supported Page Device Attributes'>
693 <caption>Table 2: <a name='TABLE_2'>Supported Page Device Attributes</a></caption>
694 <thead>
695 <tr>
696 <th>Name(s)</th>
697 <th>Type</th>
698 <th>Description</th>
699 <th>Example(s)</th>
700 </tr>
701 </thead>
702 <tbody>
703 <tr valign='top'>
704 <td><tt>AdvanceDistance</tt></td>
705 <td>Integer</td>
706 <td>Specifies the number of points to advance roll media after printing.</td>
707 <td><tt>&lt;&lt;/AdvanceDistance 18&gt;&gt;setpagedevice</tt></td>
708 </tr>
709 <tr valign='top'>
710 <td><tt>AdvanceMedia</tt></td>
711 <td>Integer</td>
712 <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>
713 <td><tt>&lt;&lt;/AdvanceMedia 4&gt;&gt;setpagedevice</tt></td>
714 </tr>
715 <tr valign='top'>
716 <td><tt>Collate</tt></td>
717 <td>Boolean</td>
718 <td>Specifies whether collated copies are required.</td>
719 <td><tt>&lt;&lt;/Collate true&gt;&gt;setpagedevice</tt></td>
720 </tr>
721 <tr valign='top'>
722 <td><tt>CutMedia</tt></td>
723 <td>Integer</td>
724 <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>
725 <td><tt>&lt;&lt;/CutMedia 1&gt;&gt;setpagedevice</tt></td>
726 </tr>
727 <tr valign='top'>
728 <td><tt>Duplex</tt></td>
729 <td>Boolean</td>
730 <td>Specifies whether 2-sided printing is required.</td>
731 <td><tt>&lt;&lt;/Duplex true&gt;&gt;setpagedevice</tt></td>
732 </tr>
733 <tr valign='top'>
734 <td><tt>HWResolution</tt></td>
735 <td>Integer Array</td>
736 <td>Specifies the resolution of the page image in pixels per inch.</td>
737 <td><tt>&lt;&lt;/HWResolution[1200 1200]&gt;&gt;setpagedevice</tt></td>
738 </tr>
739 <tr valign='top'>
740 <td><tt>InsertSheet</tt></td>
741 <td>Boolean</td>
742 <td>Specifies whether to insert a blank sheet before the job.</td>
743 <td><tt>&lt;&lt;/InsertSheet true&gt;&gt;setpagedevice</tt></td>
744 </tr>
745 <tr valign='top'>
746 <td><tt>Jog</tt></td>
747 <td>Integer</td>
748 <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>
749 <td><tt>&lt;&lt;/Jog 2&gt;&gt;setpagedevice</tt></td>
750 </tr>
751 <tr valign='top'>
752 <td><tt>LeadingEdge</tt></td>
753 <td>Integer</td>
754 <td>Specifies the leading edge of the media: 0 = top, 1 = right, 2 = bottom, 3 = left.</td>
755 <td><tt>&lt;&lt;/LeadingEdge 0&gt;&gt;setpagedevice</tt></td>
756 </tr>
757 <tr valign='top'>
758 <td><tt>ManualFeed</tt></td>
759 <td>Boolean</td>
760 <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>
761 <td><tt>&lt;&lt;/ManualFeed true&gt;&gt;setpagedevice</tt></td>
762 </tr>
763 <tr valign='top'>
764 <td><tt>MediaClass</tt></td>
765 <td>String</td>
766 <td>Specifies a named media.</td>
767 <td><tt>&lt;&lt;/MediaClass (Invoices)&gt;&gt;setpagedevice</tt></td>
768 </tr>
769 <tr valign='top'>
770 <td><tt>MediaColor</tt></td>
771 <td>String</td>
772 <td>Specifies the color of the media.</td>
773 <td><tt>&lt;&lt;/MediaColor &gt;&gt;setpagedevice</tt></td>
774 </tr>
775 <tr valign='top'>
776 <td><tt>MediaPosition</tt></td>
777 <td>Integer</td>
778 <td>Specifies the tray or source of the media.</td>
779 <td><tt>&lt;&lt;/MediaPosition 12&gt;&gt;setpagedevice</tt></td>
780 </tr>
781 <tr valign='top'>
782 <td><tt>MediaType</tt></td>
783 <td>String</td>
784 <td>Specifies the general media type.</td>
785 <td><tt>&lt;&lt;/MediaType (Glossy)&gt;&gt;setpagedevice</tt></td>
786 </tr>
787 <tr valign='top'>
788 <td><tt>MediaWeight</tt></td>
789 <td>Integer</td>
790 <td>Specifies the media weight in grams per meter<sup>2</sup>.</td>
791 <td><tt>&lt;&lt;/MediaWeight 100&gt;&gt;setpagedevice</tt></td>
792 </tr>
793 <tr valign='top'>
794 <td><tt>MirrorPrint</tt></td>
795 <td>Boolean</td>
796 <td>Specifies whether to flip the output image horizontally.</td>
797 <td><tt>&lt;&lt;/MirrorPrint true&gt;&gt;setpagedevice</tt></td>
798 </tr>
799 <tr valign='top'>
800 <td><tt>NegativePrint</tt></td>
801 <td>Boolean</td>
802 <td>Specifies whether to invert the output image.</td>
803 <td><tt>&lt;&lt;/NegativePrint true&gt;&gt;setpagedevice</tt></td>
804 </tr>
805 <tr valign='top'>
806 <td><tt>NumCopies</tt></td>
807 <td>Integer</td>
808 <td>Specifies the number of copies to produce of each page.</td>
809 <td><tt>&lt;&lt;/NumCopies 100&gt;&gt;setpagedevice</tt></td>
810 </tr>
811 <tr valign='top'>
812 <td><tt>Orientation</tt></td>
813 <td>Integer</td>
814 <td>Specifies the orientation of the output: 0 = portrait, 1 = landscape rotated counter-clockwise, 2 = upside-down, 3 = landscape rotated clockwise.</td>
815 <td><tt>&lt;&lt;/Orientation 3&gt;&gt;setpagedevice</tt></td>
816 </tr>
817 <tr valign='top'>
818 <td><tt>OutputFaceUp</tt></td>
819 <td>Boolean</td>
820 <td>Specifies whether to place the media face-up in the output bin/tray.</td>
821 <td><tt>&lt;&lt;/OutputFaceUp true&gt;&gt;setpagedevice</tt></td>
822 </tr>
823 <tr valign='top'>
824 <td><tt>OutputType</tt></td>
825 <td>String</td>
826 <td>Specifies the output type name.</td>
827 <td><tt>&lt;&lt;/OutputType (Photo)&gt;&gt;setpagedevice</tt></td>
828 </tr>
829 <tr valign='top'>
830 <td><tt>PageSize</tt></td>
831 <td>Integer/Real Array</td>
832 <td>Specifies the width and length/height of the page in points.</td>
833 <td><tt>&lt;&lt;/PageSize[595 842]&gt;&gt;setpagedevice</tt></td>
834 </tr>
835 <tr valign='top'>
836 <td><tt>Separations</tt></td>
837 <td>Boolean</td>
838 <td>Specifies whether to produce color separations.</td>
839 <td><tt>&lt;&lt;/Separations true&gt;&gt;setpagedevice</tt></td>
840 </tr>
841 <tr valign='top'>
842 <td><tt>TraySwitch</tt></td>
843 <td>Boolean</td>
844 <td>Specifies whether to switch trays automatically.</td>
845 <td><tt>&lt;&lt;/TraySwitch true&gt;&gt;setpagedevice</tt></td>
846 </tr>
847 <tr valign='top'>
848 <td><tt>Tumble</tt></td>
849 <td>Boolean</td>
850 <td>Specifies whether the back sides of pages are rotated 180 degrees.</td>
851 <td><tt>&lt;&lt;/Tumble true&gt;&gt;setpagedevice</tt></td>
852 </tr>
853 <tr valign='top'>
854 <td><tt>cupsBorderlessScalingFactor</tt></td>
855 <td>Real</td>
856 <td>Specifies the amount to scale the page image dimensions.</td>
857 <td><tt>&lt;&lt;/cupsBorderlessScalingFactor 1.01&gt;&gt;setpagedevice</tt></td>
858 </tr>
859 <tr valign='top'>
860 <td><tt>cupsColorOrder</tt></td>
861 <td>Integer</td>
862 <td>Specifies the order of colors: 0 = chunked, 1 = banded, 2 = planar.</td>
863 <td><tt>&lt;&lt;/cupsColorOrder 0&gt;&gt;setpagedevice</tt></td>
864 </tr>
865 <tr valign='top'>
866 <td><tt>cupsColorSpace</tt></td>
867 <td>Integer</td>
868 <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>
869 <td><tt>&lt;&lt;/cupsColorSpace 1 &gt;&gt;setpagedevice</tt></td>
870 </tr>
871 <tr valign='top'>
872 <td><tt>cupsCompression</tt></td>
873 <td>Integer</td>
874 <td>Specifies a driver compression type/mode.</td>
875 <td><tt>&lt;&lt;/cupsCompression 2&gt;&gt;setpagedevice</tt></td>
876 </tr>
877 <tr valign='top'>
878 <td><tt>cupsInteger0<br>
879 ...<br>
880 cupsInteger15</tt></td>
881 <td>Integer</td>
882 <td>Specifies driver integer values.</td>
883 <td><tt>&lt;&lt;/cupsInteger11 1234&gt;&gt;setpagedevice</tt></td>
884 </tr>
885 <tr valign='top'>
886 <td><tt>cupsMarkerType</tt></td>
887 <td>String</td>
888 <td>Specifies the type of ink/toner to use.</td>
889 <td><tt>&lt;&lt;/cupsMarkerType (Black+Color)&gt;&gt;setpagedevice</tt></td>
890 </tr>
891 <tr valign='top'>
892 <td><tt>cupsMediaType</tt></td>
893 <td>Integer</td>
894 <td>Specifies a numeric media type.</td>
895 <td><tt>&lt;&lt;/cupsMediaType 999&gt;&gt;setpagedevice</tt></td>
896 </tr>
897 <tr valign='top'>
898 <td><tt>cupsPageSizeName</tt></td>
899 <td>String</td>
900 <td>Specifies the name of the page size.</td>
901 <td><tt>&lt;&lt;/cupsPageSizeName (A4.Full)&gt;&gt;setpagedevice</tt></td>
902 </tr>
903 <tr valign='top'>
904 <td><tt>cupsPreferredBitsPerColor</tt></td>
905 <td>Integer</td>
906 <td>Specifies the preferred number of bits per color, typically 8 or 16.</td>
907 <td><tt>&lt;&lt;/cupsPreferredBitsPerColor 16&gt;&gt;setpagedevice</tt></td>
908 </tr>
909 <tr valign='top'>
910 <td><tt>cupsReal0<br>
911 ...<br>
912 cupsReal15</tt></td>
913 <td>Real</td>
914 <td>Specifies driver real number values.</td>
915 <td><tt>&lt;&lt;/cupsReal15 1.234&gt;&gt;setpagedevice</tt></td>
916 </tr>
917 <tr valign='top'>
918 <td><tt>cupsRenderingIntent</tt></td>
919 <td>String</td>
920 <td>Specifies the color rendering intent.</td>
921 <td><tt>&lt;&lt;/cupsRenderingIntent (AbsoluteColorimetric)&gt;&gt;setpagedevice</tt></td>
922 </tr>
923 <tr valign='top'>
924 <td><tt>cupsRowCount</tt></td>
925 <td>Integer</td>
926 <td>Specifies the number of rows of raster data to print on each line for some drivers.</td>
927 <td><tt>&lt;&lt;/cupsRowCount 24&gt;&gt;setpagedevice</tt></td>
928 </tr>
929 <tr valign='top'>
930 <td><tt>cupsRowFeed</tt></td>
931 <td>Integer</td>
932 <td>Specifies the number of rows to feed between passes for some drivers.</td>
933 <td><tt>&lt;&lt;/cupsRowFeed 17&gt;&gt;setpagedevice</tt></td>
934 </tr>
935 <tr valign='top'>
936 <td><tt>cupsRowStep</tt></td>
937 <td>Integer</td>
938 <td>Specifies the number of lines between columns/rows on the print head for some drivers.</td>
939 <td><tt>&lt;&lt;/cupsRowStep 2&gt;&gt;setpagedevice</tt></td>
940 </tr>
941 <tr valign='top'>
942 <td><tt>cupsString0<br>
943 ...<br>
944 cupsString15</tt></td>
945 <td>String</td>
946 <td>Specifies driver string values.</td>
947 <td><tt>&lt;&lt;/cupsString0(String Value)&gt;&gt;setpagedevice</tt></td>
948 </tr>
949 </tbody>
950 </table></div>
951
952
953 <h2 class='title'><a name='ATTRIBUTES'>General Attributes</a></h2>
954
955 <h3><span class='info'>CUPS 1.3</span><a name='cupsBackSide'>cupsBackSide</a></h3>
956
957 <p class='summary'>*cupsBackSide: keyword</p>
958
959 <p>This attribute requests special handling of the back side of pages
960 when doing duplexed (2-sided) output. <a href='#TABLE_1'>Table 1</a>
961 shows the supported keyword values for this attribute and their effect
962 on the raster data sent to your driver. For example, when <tt>cupsBackSide</tt>
963 is <code>Rotated</code> and <tt>Tumble</tt> is <tt>false</tt>, your driver
964 will receive print data starting at the bottom right corner of the page, with
965 each line going right-to-left instead of left-to-right. The default value is
966 <code>Normal</code>.</p>
967
968 <blockquote><b>Note:</b>
969
970 <p><tt>cupsBackSide</tt> replaces the older <tt>cupsFlipDuplex</tt>
971 attribute - if <tt>cupsBackSide</tt> is specified, <tt>cupsFlipDuplex</tt>
972 will be ignored.</p>
973
974 </blockquote>
975
976 <div class='table'>
977 <table width='80%' summary='Back Side Raster Coordinate System'>
978 <caption>Table 1: <a name='TABLE_1'>Back Side Raster Coordinate System</a></caption>
979 <thead>
980 <tr>
981 <th>cupsBackSide</th>
982 <th>Tumble Value</th>
983 <th>Image Presentation</th>
984 </tr>
985 </thead>
986 <tbody>
987 <tr>
988 <td><code>Normal</code></td>
989 <td><code>false</code></td>
990 <td>Left-to-right, top-to-bottom</td>
991 </tr>
992 <tr>
993 <td><code>Normal</code></td>
994 <td><code>true</code></td>
995 <td>Left-to-right, top-to-bottom</td>
996 </tr>
997 <tr>
998 <td><code>ManualTumble</code></td>
999 <td><code>false</code></td>
1000 <td>Left-to-right, top-to-bottom</td>
1001 </tr>
1002 <tr>
1003 <td><code>ManualTumble</code></td>
1004 <td><code>true</code></td>
1005 <td>Right-to-left, bottom-to-top</td>
1006 </tr>
1007 <tr>
1008 <td><code>Rotated</code></td>
1009 <td><code>false</code></td>
1010 <td>Right-to-left, bottom-to-top</td>
1011 </tr>
1012 <tr>
1013 <td><code>Rotated</code></td>
1014 <td><code>true</code></td>
1015 <td>Right-to-left, top-to-bottom</td>
1016 </tr>
1017 <tr>
1018 <td><code>Flipped</code> *</td>
1019 <td><code>false</code></td>
1020 <td>Left-to-right, bottom-to-top</td>
1021 </tr>
1022 <tr>
1023 <td><code>Flipped</code> *</td>
1024 <td><code>true</code></td>
1025 <td>Right-to-left, top-to-bottom</td>
1026 </tr>
1027 </tbody>
1028 </table>
1029 </div>
1030
1031 <p><em>* - Not supported in Mac OS X 10.5.x and earlier</em></p>
1032
1033 <div class='figure'><table summary='Back side images'>
1034 <caption>Figure 1: Back side images</caption>
1035 <tr><td><img src='../images/raster.png' width='624' height='448' alt='Back side images'></td></tr>
1036 </table></div>
1037
1038 <p>Examples:</p>
1039
1040 <pre class='command'>
1041 <em>*% Flip the page image for the back side of duplexed output</em>
1042 *cupsBackSide: Flipped
1043
1044 <em>*% Rotate the page image for the back side of duplexed output</em>
1045 *cupsBackSide: Rotated
1046 </pre>
1047
1048 <p>Also see the related <a href='#APDuplexRequiresFlippedMargin'><tt>APDuplexRequiresFlippedMargin</tt></a>
1049 attribute.</p>
1050
1051 <h3><span class='info'>CUPS 1.3</span><a name='cupsEvenDuplex'>cupsEvenDuplex</a></h3>
1052
1053 <p class='summary'>*cupsEvenDuplex: boolean</p>
1054
1055 <p>This boolean attribute notifies the RIP filters that the
1056 destination printer requires an even number of pages when 2-sided
1057 printing is selected. The default value is <code>false</code>.</p>
1058
1059 <p>Example:</p>
1060
1061 <pre class='command'>
1062 <em>*% Always send an even number of pages when duplexing</em>
1063 *cupsEvenDuplex: true
1064 </pre>
1065
1066 <h3><a name='cupsFax'>cupsFax</a></h3>
1067
1068 <p class='summary'>*cupsFax: boolean</p>
1069
1070 <p>This boolean attribute specifies whether the PPD defines a facsimile device. The default is <tt>false</tt>.</p>
1071
1072 <p>Examples:</p>
1073
1074 <pre class='command'>
1075 *cupsFax: true
1076 </pre>
1077
1078 <h3><a name='cupsFilter'>cupsFilter</a></h3>
1079
1080 <p class='summary'>*cupsFilter: "source/type cost program"</p>
1081
1082 <p>This string attribute provides a conversion rule from the
1083 given source type to the printer's native format using the
1084 filter "program". If a printer supports the source type directly,
1085 the special filter program "-" may be specified.</p>
1086
1087 <p>Examples:</p>
1088
1089 <pre class='command'>
1090 <em>*% Standard raster printer driver filter</em>
1091 *cupsFilter: "application/vnd.cups-raster 100 rastertofoo"
1092
1093 <em>*% Plain text filter</em>
1094 *cupsFilter: "text/plain 10 texttofoo"
1095
1096 <em>*% Pass-through filter for PostScript printers</em>
1097 *cupsFilter: "application/vnd.cups-postscript 0 -"
1098 </pre>
1099
1100 <h3><span class='info'>Deprecated</span><a name='cupsFlipDuplex'>cupsFlipDuplex</a></h3>
1101
1102 <p class='summary'>*cupsFlipDuplex: boolean</p>
1103
1104 <p>Due to implementation differences between Mac OS X and Ghostscript,
1105 the <tt>cupsFlipDuplex</tt> attribute is deprecated. Instead, use
1106 the <a href='#cupsBackSide'><tt>cupsBackSide</tt></a> attribute to specify
1107 the coordinate system (pixel layout) of the page data on the back side of
1108 duplex pages.</p>
1109
1110 <p>The value <code>true</code> maps to a <tt>cupsBackSide</tt> value
1111 of <code>Rotated</code> on Mac OS X and <code>Flipped</code> with
1112 Ghostscript.</p>
1113
1114 <p>The default value is <code>false</code>.</p>
1115
1116 <blockquote><b>Note:</b>
1117
1118 <p>Mac OS X drivers that previously used
1119 <tt>cupsFlipDuplex</tt> may wish to provide both the old and
1120 new attributes for maximum compatibility, for example:</p>
1121
1122 <pre class='command'>
1123 *cupsBackSide: Rotated
1124 *cupsFlipDuplex: true
1125 </pre>
1126
1127 <p>Similarly, drivers written for other operating systems using
1128 Ghostscript can use:</p>
1129
1130 <pre class='command'>
1131 *cupsBackSide: Flipped
1132 *cupsFlipDuplex: true
1133 </pre></blockquote>
1134
1135 <h3><span class='info'>CUPS 1.3</span><a name='cupsIPPFinishings'>cupsIPPFinishings</a></h3>
1136
1137 <p class='summary'>*cupsIPPFinishings number/text: "*Option Choice ..."</p>
1138
1139 <p>This attribute defines a mapping from IPP <code>finishings</code>
1140 values to PPD options and choices.</p>
1141
1142 <p>Examples:</p>
1143
1144 <pre class='command'>
1145 *cupsIPPFinishings 4/staple: "*StapleLocation SinglePortrait"
1146 *cupsIPPFinishings 5/punch: "*PunchMedia Yes *PunchLocation LeftSide"
1147 *cupsIPPFinishings 20/staple-top-left: "*StapleLocation SinglePortrait"
1148 *cupsIPPFinishings 21/staple-bottom-left: "*StapleLocation SingleLandscape"
1149 </pre>
1150
1151 <h3><span class='info'>CUPS 1.3</span><a name='cupsIPPReason'>cupsIPPReason</a></h3>
1152
1153 <p class='summary'>*cupsIPPReason reason/Reason Text: "optional URIs"</p>
1154
1155 <p>This optional attribute maps custom
1156 <code>printer-state-reasons</code> keywords that are generated by
1157 the driver to human readable text. The optional URIs string
1158 contains zero or more URIs separated by a newline. Each URI can
1159 be a CUPS server absolute path to a help file under the
1160 scheduler's <code>DocumentRoot</code> directory, a full HTTP URL
1161 ("http://www.domain.com/path/to/help/page.html"), or any other
1162 valid URI which directs the user at additional information
1163 concerning the condition that is being reported.</p>
1164
1165 <p>Since the reason text is limited to 80 characters by the PPD specification,
1166 longer text strings can be included by URI-encoding the text with the "text"
1167 scheme, for example "text:some%20text". Multiple <code>text</code> URIs are
1168 combined (with spaces between each URI) by the <tt>ppdLocalizeIPPReason</tt>
1169 into a single string that can be displayed to the user.</p>
1170
1171 <p>Examples:</p>
1172
1173 <pre class='command'>
1174 <em>*% Map com.vendor-error to text but no page</em>
1175 *cupsIPPReason com.vendor-error/A serious error occurred: ""
1176
1177 <em>*% Map com.vendor-error to more than 80 characters of text but no page</em>
1178 *cupsIPPReason com.vendor-error/A serious error occurred: "text:Now%20is%20the%20time
1179 text:for%20all%20good%20men%20to%20come%20to%20the%20aid%20of%20their%20country."
1180
1181 <em>*% Map com.vendor-error to text and a local page</em>
1182 *cupsIPPReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html"
1183
1184 <em>*% Map com.vendor-error to text and a remote page</em>
1185 *cupsIPPReason com.vendor-error/A serious error occurred: "http://www.vendor.com/help"
1186
1187 <em>*% Map com.vendor-error to text and a local, Apple help book, and remote page</em>
1188 *APHelpBook: "file:///Library/Printers/vendor/Help/filename"
1189 *cupsIPPReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html
1190 help:anchor='com.vendor-error'%20bookID=Vendor%20Help
1191 http://www.vendor.com/help"
1192 *End
1193 </pre>
1194
1195 <h3><span class='info'>CUPS 1.2</span><a name='cupsLanguages'>cupsLanguages</a></h3>
1196
1197 <p class='summary'>*cupsLanguages: "locale list"</p>
1198
1199 <p>This attribute describes which language localizations are
1200 included in the PPD. The "locale list" string is a space-delimited
1201 list of locale names ("en", "en_US", "fr_CA", etc.)</p>
1202
1203 <p>Example:</p>
1204
1205 <pre class='command'>
1206 <em>*% Specify Canadian, UK, and US English, and Candian and French French</em>
1207 *cupsLanguages: "en_CA en_UK en_US fr_CA fr_CA"
1208 </pre>
1209
1210 <h3><a name='cupsManualCopies'>cupsManualCopies</a></h3>
1211
1212 <p class='summary'>*cupsManualCopies: boolean</p>
1213
1214 <p>This boolean attribute notifies the RIP filters that the
1215 destination printer does not support copy generation in
1216 hardware. The default value is <code>false</code>.</p>
1217
1218 <p>Example:</p>
1219
1220 <pre class='command'>
1221 <em>*% Tell the RIP filters to generate the copies for us</em>
1222 *cupsManualCopies: true
1223 </pre>
1224
1225 <h3><a name='cupsModelNumber'>cupsModelNumber</a></h3>
1226
1227 <p class='summary'>*cupsModelNumber: number</p>
1228
1229 <p>This integer attribute specifies a printer-specific model
1230 number. This number can be used by a filter program to adjust
1231 the output for a specific model of printer.</p>
1232
1233 <p>Example:</p>
1234
1235 <pre class='command'>
1236 <em>*% Specify an integer for a driver-specific model number</em>
1237 *cupsModelNumber: 1234
1238 </pre>
1239
1240
1241 <h3><span class='info'>CUPS 1.3</span><a name='cupsPJLCharset'>cupsPJLCharset</a></h3>
1242
1243 <p class='summary'>*cupsPJLCharset: "ISO character set name"</p>
1244
1245 <p>This string attribute specifies the character set that is used
1246 for strings in PJL commands. If not specified, US-ASCII is
1247 assumed.</p>
1248
1249 <p>Example:</p>
1250
1251 <pre class='command'>
1252 <em>*% Specify UTF-8 is used in PJL strings</em>
1253 *cupsPJLCharset: "UTF-8"
1254 </pre>
1255
1256
1257 <h3><span class='info'>CUPS 1.2</span><a name='cupsPortMonitor'>cupsPortMonitor</a></h3>
1258
1259 <p class='summary'>*cupsPortMonitor urischeme/Descriptive Text: "port monitor"</p>
1260
1261 <p>This string attribute specifies printer-specific "port
1262 monitor" filters that may be used with the printer. The CUPS
1263 scheduler also looks for the <tt>Protocols</tt> attribute to see
1264 if the <tt>BCP</tt> or <tt>TBCP</tt> protocols are supported. If
1265 so, the corresponding port monitor ("bcp" and "tbcp",
1266 respectively) is listed in the printer's
1267 <tt>port-monitor-supported</tt> attribute.</p>
1268
1269 <p>The "urischeme" portion of the attribute specifies the URI scheme
1270 that this port monitor should be used for. Typically this is used to
1271 pre-select a particular port monitor for each type of connection that
1272 is supported by the printer. The "port monitor" string can be "none"
1273 to disable the port monitor for the given URI scheme.</p>
1274
1275 <p>Examples:</p>
1276
1277 <pre class='command'>
1278 <em>*% Specify a PostScript printer that supports the TBCP protocol</em>
1279 *Protocols: TBCP PJL
1280
1281 <em>*% Specify that TBCP should be used for socket connections but not USB</em>
1282 *cupsPortMonitor socket/AppSocket Printing: "tbcp"
1283 *cupsPortMonitor usb/USB Printing: "none"
1284
1285 <em>*% Specify a printer-specific port monitor for an Epson USB printer</em>
1286 *cupsPortMonitor usb/USB Status Monitor: "epson-usb"
1287 </pre>
1288
1289 <h3><span class='info'>CUPS 1.3</span><a name='cupsPreFilter'>cupsPreFilter</a></h3>
1290
1291 <p class='summary'>*cupsPreFilter: "source/type cost program"</p>
1292
1293 <p>This string attribute provides a pre-filter rule. The pre-filter
1294 program will be inserted in the conversion chain immediately
1295 before the filter that accepts the given MIME type.</p>
1296
1297 <p>Examples:</p>
1298
1299 <pre class='command'>
1300 <em>*% PDF pre-filter</em>
1301 *cupsPreFilter: "application/pdf 100 mypdfprefilter"
1302
1303 <em>*% PNG pre-filter</em>
1304 *cupsPreFilter: "image/png 0 mypngprefilter"
1305 </pre>
1306
1307 <h3><a name='cupsVersion'>cupsVersion</a></h3>
1308
1309 <p class='summary'>*cupsVersion: major.minor</p>
1310
1311 <p>This required attribute describes which version of the CUPS
1312 PPD file extensions was used. Currently it must be the string
1313 "1.0", "1.1", "1.2", or "1.3".</p>
1314
1315 <p>Example:</p>
1316
1317 <pre class='command'>
1318 <em>*% Specify a CUPS 1.2 driver</em>
1319 *cupsVersion: "1.2"
1320 </pre>
1321
1322
1323 <h2 class='title'><a name='MACOSX'>Mac OS X Attributes</a></h2>
1324
1325 <h3><a name='APBookFile'>APBookFile</a></h3>
1326
1327 <p class='summary'>*APBookFile: "file URL"</p>
1328
1329 <p>This string attribute specifies the Apple help book file to use when
1330 looking up IPP reason codes for this printer driver. The
1331 <a href='#cupsIPPReason'><tt>cupsIPPReason</tt></a> attribute maps
1332 "help" URIs to this file.</p>
1333
1334 <p>Example:</p>
1335
1336 <pre class='command'>
1337 *APBookFile: "file:///Library/Printers/vendor/Help/filename"
1338 </pre>
1339
1340 <h3><span class='info'>Mac OS X 10.3</span><a name='APDialogExtension'>APDialogExtension</a></h3>
1341
1342 <p class='summary'>*APDialogExtension: "/Library/Printers/vendor/filename.plugin"</p>
1343
1344 <p>This attribute defines additional option panes that are displayed in the
1345 print dialog. Each attribute adds one or more option panes. See the "OutputBinsPDE"
1346 example and <a href='http://developer.apple.com/qa/qa2004/qa1352.html'>Apple
1347 Technical Q&amp;A QA1352</a> for information on writing your own print dialog
1348 plug-ins.</p>
1349
1350 <blockquote><b>Note:</b>
1351
1352 <p>Starting with Mac OS X 10.5, each plug-in must be compiled "4-way fat"
1353 (32-bit and 64-bit for both PowerPC and Intel) with garbage collection enabled
1354 in order to be usable with all applications.</p>
1355
1356 </blockquote>
1357
1358 <p>Examples:</p>
1359
1360 <pre class='command'>
1361 *% Add two panes for finishing and driver options
1362 *APDialogExtension: "/Library/Printers/vendor/finishing.plugin"
1363 *APDialogExtension: "/Library/Printers/vendor/options.plugin"
1364 </pre>
1365
1366 <h3><span class='info'>Mac OS X 10.4</span><a name='APDuplexRequiresFlippedMargin'>APDuplexRequiresFlippedMargin</a></h3>
1367
1368 <p class='summary'>*APDuplexRequiresFlippedMargin: boolean</p>
1369
1370 <p>This boolean attribute notifies the RIP filters that the
1371 destination printer requires the top and bottom margins of the
1372 <tt>ImageableArea</tt> to be swapped for the back page. The
1373 default is <tt>true</tt> when <tt>cupsBackSide</tt> is <tt>Flipped</tt>
1374 and <tt>false</tt> otherwise. <a href='#TABLE_2'>Table 2</a> shows how
1375 <tt>APDuplexRequiresFlippedMargin</tt> interacts with <tt>cupsBackSide</tt>
1376 and the <tt>Tumble</tt> page attribute.</p>
1377
1378 <div class='table'>
1379 <table width='80%' summary='Margin Flipping Modes'>
1380 <caption>Table 2: <a name='TABLE_2'>Margin Flipping Modes</a></caption>
1381 <thead>
1382 <tr>
1383 <th>APDuplexRequiresFlippedMargin</th>
1384 <th>cupsBackSide</th>
1385 <th>Tumble Value</th>
1386 <th>Margins</th>
1387 </tr>
1388 </thead>
1389 <tbody>
1390 <tr>
1391 <td>false</td>
1392 <td>any</td>
1393 <td>any</td>
1394 <td>Normal</td>
1395 </tr>
1396 <tr>
1397 <td>any</td>
1398 <td>Normal</td>
1399 <td>any</td>
1400 <td>Normal</td>
1401 </tr>
1402 <tr>
1403 <td>true</td>
1404 <td>ManualDuplex</td>
1405 <td>false</td>
1406 <td>Normal</td>
1407 </tr>
1408 <tr>
1409 <td>true</td>
1410 <td>ManualDuplex</td>
1411 <td>true</td>
1412 <td>Flipped</td>
1413 </tr>
1414 <tr>
1415 <td>true</td>
1416 <td>Rotated</td>
1417 <td>false</td>
1418 <td>Flipped</td>
1419 </tr>
1420 <tr>
1421 <td>true</td>
1422 <td>Rotated</td>
1423 <td>true</td>
1424 <td>Normal</td>
1425 </tr>
1426 <tr>
1427 <td>true or unspecified</td>
1428 <td>Flipped</td>
1429 <td>any</td>
1430 <td>Flipped</td>
1431 </tr>
1432 </tbody>
1433 </table></div>
1434
1435 <p>Example:</p>
1436
1437 <pre class='command'>
1438 <em>*% Rotate the back side images</em>
1439 *cupsBackSide: Rotated
1440
1441 <em>*% Don't swap the top and bottom margins for the back side</em>
1442 *APDuplexRequiresFlippedMargin: false
1443 </pre>
1444
1445 <p>Also see the related <a href='#cupsBackSide'><tt>cupsBackSide</tt></a>
1446 attribute.</p>
1447
1448 <h3><span class='info'>Mac OS X 10.3</span><a name='APPrinterIconPath'>APPrinterIconPath</a></h3>
1449
1450 <p class='summary'>*APPrinterIconPath: "/Library/Printers/vendor/filename"</p>
1451
1452 <p>This attribute defines the location of a printer icon file to use when
1453 displaying the printer.</p>
1454
1455 <p>Examples:</p>
1456
1457 <pre class='command'>
1458 *% Apple icon file
1459 *APPrinterIconPath: "/Library/Printers/vendor/Icons/filename.icns"
1460
1461 *% TIFF icon file
1462 *APPrinterIconPath: "/Library/Printers/vendor/Icons/filename.tiff"
1463
1464 *% PNG icon file
1465 *APPrinterIconPath: "/Library/Printers/vendor/Icons/filename.png"
1466
1467 *% JPEG icon file
1468 *APPrinterIconPath: "/Library/Printers/vendor/Icons/filename.jpg"
1469 </pre>
1470
1471 <h3><span class='info'>Mac OS X 10.4</span><a name='APPrinterLowInkTool'>APPrinterLowInkTool</a></h3>
1472
1473 <p class='summary'>*APPrinterLowInkTool: "/Library/Printers/vendor/program"</p>
1474
1475 <p>This attribute defines an program that checks the ink/toner/marker levels
1476 on a printer, returning an XML document with those levels. See the "InkTool"
1477 example and
1478 <a href='http://developer.apple.com/technotes/tn2005/tn2144.html'>Apple
1479 Technical Note TN2144</a> for more information.</p>
1480
1481 <p>Examples:</p>
1482
1483 <pre class='command'>
1484 *% Use a vendor monitoring program
1485 *APPrinterLowInkTool: "/Library/Printers/vendor/Tools/lowinktool"
1486 </pre>
1487
1488 <h3><span class='info'>Mac OS X 10.5</span><a name='APPrinterPreset'>APPrinterPreset</a></h3>
1489
1490 <p class='summary'>*APPrinterPreset name/text: "*Option Choice ..."</p>
1491
1492 <p>This attribute defines presets for multiple options that show up
1493 in the print dialog of applications (such as iPhoto) that set the job
1494 style hint to <tt>NSPrintPhotoJobStyleHint</tt>. Each preset maps to one or
1495 more pairs of PPD options and choices as well as providing key/value data for
1496 the application. The following preset names are currently defined:</p>
1497
1498 <ul>
1499
1500 <li><code>Photo_with_Paper_Auto-Detect</code>; Photo printing
1501 with paper auto-detect</li>
1502
1503 <li><code>Photo_with_Paper_Auto-Detect_-_Fine</code>; Photo printing
1504 with paper auto-detect - fine</li>
1505
1506 <li><code>Photo_on_Plain_Paper</code>; Photo printing on plain paper</li>
1507
1508 <li><code>Photo_on_Plain_Paper_-_Fine</code>; Photo printing on plain
1509 paper - fine</li>
1510
1511 <li><code>Photo_on_Photo_Paper</code>; Photo printing on photo paper</li>
1512
1513 <li><code>Photo_on_Photo_Paper_-_Fine</code>; Photo printing on photo
1514 paper - fine</li>
1515
1516 <li><code>Photo_on_Matte_Paper</code>; Photo printing on matte paper</li>
1517
1518 <li><code>Photo_on_Matte_Paper_-_Fine</code>; Photo printing on matte
1519 paper - fine</li>
1520
1521 </ul>
1522
1523 <p>The value string consists of pairs of keywords, either an option name and
1524 choice (*MainKeyword OptionKeyword) or a preset identifier and value
1525 (com.apple.print.preset.foo value). Preset identifiers and their supported
1526 values are documented in "<a
1527 href='http://developer.apple.com/documentation/Printing/Conceptual/PresetDraft/presets_intro/chapter_1_section_2.html'
1528 >Creating Printing Presets for iPhoto: Printing Presets File Format</a>".</p>
1529
1530 <p>Presets, like options, can also be localized in multiple languages.</p>
1531
1532 <p>Examples:</p>
1533
1534 <pre class='command'>
1535 *APPrinterPreset Photo_on_Photo_Paper/Photo on Photo Paper: "
1536 *MediaType Glossy
1537 *ColorModel RGB
1538 *Resolution 300dpi
1539 com.apple.print.preset.graphicsType Photo
1540 com.apple.print.preset.quality mid
1541 com.apple.print.preset.media-front-coating glossy"
1542 *End
1543 *fr.APPrinterPreset Photo_on_Photo_Paper/Photo sur papier photographique: ""
1544 </pre>
1545
1546 <h3><span class='info'>Mac OS X 10.3</span><a name='APPrinterUtilityPath'>APPrinterUtilityPath</a></h3>
1547
1548 <p class='summary'>*APPrinterPrinterUtilityPath: "/Library/Printers/vendor/filename.app"</p>
1549
1550 <p>This attribute defines a GUI application that can be used to do printer
1551 maintenance functions such as cleaning the print head(s). See ... for more
1552 information.</p>
1553
1554 <p>Examples:</p>
1555
1556 <pre class='command'>
1557 *% Define the printer utility application
1558 *APPrinterPrinterUtilityPath: "/Library/Printers/vendor/Tools/utility.app"
1559 </pre>
1560
1561 <h3><span class='info'>Mac OS X 10.3</span><a name='APScanAppBundleID'>APScanAppBundleID</a></h3>
1562
1563 <p class='summary'>*APScanAppBundleID: "bundle ID"</p>
1564
1565 <p>This attribute defines the application to use when scanning pages from
1566 the device.</p>
1567
1568 <p>Examples:</p>
1569
1570 <pre class='command'>
1571 *APScanAppBundleID: "com.apple.ImageCaptureApp"
1572 </pre>
1573
1574
1575 <h2 class='title'><a name='HISTORY'>Change History</a></h2>
1576
1577 <h3>Changes in CUPS 1.3.1</a></h3>
1578
1579 <ul>
1580
1581 <li>Added missing Mac OS X <tt>AP</tt> attributes.</li>
1582
1583 <li>Added section on auto-configuration including the
1584 <tt>OID<i>MainKeyword</i></tt> and <tt>?<i>MainKeyword</i></tt>
1585 attributes.</li>
1586
1587 <li>Minor reorganization.</li>
1588
1589 </ul>
1590
1591
1592 <h3>Changes in CUPS 1.3</a></h3>
1593
1594 <ul>
1595
1596 <li>Added <tt>cupsBackSide</tt> and deprecated <tt>cupsFlipDuplex</tt>.</li>
1597
1598 <li>Added text URI information to <tt>cupsIPPReason</tt> documentation.</li>
1599
1600 <li>Added <tt>APPrinterPreset</tt>, <tt>cupsIPPFinishings</tt>, and <tt>cupsPreFilter</tt> attributes.</li>
1601
1602 <li>Added discussion of custom option code, sample <tt>CustomPageSize</tt> code, and "do not use dict and put" note.</li>
1603
1604 </ul>
1605
1606 <h3>Changes in CUPS 1.2.8</a></h3>
1607
1608 <ul>
1609
1610 <li>Added section on supported PostScript commands for raster
1611 drivers</li>
1612
1613 </ul>
1614
1615 <h3>Changes in CUPS 1.2</a></h3>
1616
1617 <ul>
1618
1619 <li>Added globalization support attributes</li>
1620
1621 <li>Added custom option values support</li>
1622
1623 <li>Added <tt>APBookFile</tt> attribute</li>
1624
1625 <li>Added <tt>APDuplexRequiresFlippedMargin</tt> attribute</li>
1626
1627 <li>Added <tt>cupsICCProfile</tt> attribute</li>
1628
1629 <li>Added <tt>cupsIPPReason</tt> attribute</li>
1630
1631 <li>Added <tt>cupsLanguages</tt> attribute</li>
1632
1633 <li>Added <tt>cupsPortMonitor</tt> attribute</li>
1634
1635 <li>Removed <tt>cupsProtocol</tt> attribute</li>
1636
1637 </ul>
1638
1639 <h3>Changes in CUPS 1.1</a></h3>
1640
1641 <ul>
1642
1643 <li>Added <tt>cupsFlipDuplex</tt> attribute</li>
1644
1645 <li>Added <tt>cupsProtocol</tt> attribute</li>
1646
1647 </ul>
1648
1649 </body>
1650 </html>