]> git.ipfire.org Git - thirdparty/cups.git/blame - doc/help/spec-ppd.html
projects / thirdparty / cups.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge changes from CUPS 1.5svn-r9525
[thirdparty/cups.git] / doc / help / spec-ppd.html
CommitLineData
745129be 1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
ef416fc2 2<html>
4744bd90 3<!-- SECTION: Specifications -->
ef416fc2 4<head>
0268488e
MS		 5 <title>CUPS PPD Extensions </title>
6 <meta name="keywords" content="Specifications">
7 <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
8 <meta name="creator" content="Mini-XML v2.7">
10d09e33
MS		 9<style type="text/css"><!--
10BODY {
11 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
12}
13
14H1, H2, H3, H4, H5, H6, P, TD, TH {
15 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
16}
17
18KBD {
19 font-family: monaco, courier, monospace;
20 font-weight: bold;
21}
22
23PRE {
24 font-family: monaco, courier, monospace;
25}
26
27PRE.command {
28 border: dotted thin #7f7f7f;
29 margin-left: 36pt;
30 padding: 10px;
31}
32
33P.compact {
34 margin: 0;
35}
36
37P.example {
38 font-style: italic;
39 margin-left: 36pt;
40}
41
42PRE.example {
43 background: #eeeeee;
44 border: dotted thin #999999;
45 margin-left: 36pt;
46 padding: 10pt;
47}
48
49PRE.command EM, PRE.example EM {
50 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
51}
52
53P.command {
54 font-family: monaco, courier, monospace;
55 margin-left: 36pt;
56}
57
58P.formula {
59 font-style: italic;
60 margin-left: 36pt;
61}
62
63BLOCKQUOTE {
64 background: #eeeeee;
65 border: solid thin #999999;
66 padding: 10pt;
67}
68
69A IMG {
70 border: none;
71}
72
73A:link:hover IMG {
74 background: #f0f0f0;
75 border-radius: 10px;
76 -moz-border-radius: 10px;
77}
78
79A:link, A:visited {
80 font-weight: normal;
81 text-decoration: none;
82}
83
84A:link:hover, A:visited:hover, A:active {
85 text-decoration: underline;
86}
87
88SUB, SUP {
89 font-size: 50%;
90}
91
92TR.data, TD.data, TR.data TD {
93 margin-top: 10pt;
94 padding: 5pt;
95 border-bottom: solid 1pt #999999;
96}
97
98TR.data TH {
99 border-bottom: solid 1pt #999999;
100 padding-top: 10pt;
101 padding-left: 5pt;
102 text-align: left;
103}
104
105DIV.table TABLE {
106 border: solid thin #999999;
107 border-collapse: collapse;
108 border-spacing: 0;
109 margin-left: auto;
110 margin-right: auto;
111}
112
113DIV.table CAPTION {
114 caption-side: top;
115 font-size: 120%;
116 font-style: italic;
117 font-weight: bold;
118 margin-left: auto;
119 margin-right: auto;
120}
121
122DIV.table TABLE TD {
123 border: solid thin #cccccc;
124 padding-top: 5pt;
125}
126
127DIV.table TABLE TH {
128 background: #cccccc;
129 border: none;
130 border-bottom: solid thin #999999;
131}
132
133DIV.figure TABLE {
134 margin-left: auto;
135 margin-right: auto;
136}
137
138DIV.figure CAPTION {
139 caption-side: bottom;
140 font-size: 120%;
141 font-style: italic;
142 font-weight: bold;
143 margin-left: auto;
144 margin-right: auto;
145}
146
147TH.label {
148 text-align: right;
149 vertical-align: top;
150}
151
152TH.sublabel {
153 text-align: right;
154 font-weight: normal;
155}
156
157HR {
158 border: solid thin;
159}
160
161SPAN.info {
162 background: black;
163 border: thin solid black;
164 color: white;
165 font-size: 80%;
166 font-style: italic;
167 font-weight: bold;
168 white-space: nowrap;
169}
170
171H2 SPAN.info, H3 SPAN.info, H4 SPAN.info {
172 float: right;
173 font-size: 100%;
174}
175
176H1.title {
177}
178
179H2.title, H3.title {
180 border-bottom: solid 2pt #000000;
181}
182
183DIV.indent, TABLE.indent {
184 margin-top: 2em;
185 margin-left: auto;
186 margin-right: auto;
187 width: 90%;
188}
189
190TABLE.indent {
191 border-collapse: collapse;
192}
193
194TABLE.indent TD, TABLE.indent TH {
195 padding: 0;
196}
197
198TABLE.list {
199 border-collapse: collapse;
200 margin-left: auto;
201 margin-right: auto;
202 width: 90%;
203}
204
205TABLE.list TH {
206 background: white;
207 border-bottom: solid thin #cccccc;
208 color: #444444;
209 padding-top: 10pt;
210 padding-left: 5pt;
211 text-align: left;
212 vertical-align: bottom;
213 white-space: nowrap;
214}
215
216TABLE.list TH A {
217 color: #4444cc;
218}
219
220TABLE.list TD {
221 border-bottom: solid thin #eeeeee;
222 padding-top: 5pt;
223 padding-left: 5pt;
224}
225
226TABLE.list TR:nth-child(even) {
227 background: #f8f8f8;
228}
229
230TABLE.list TR:nth-child(odd) {
231 background: #f4f4f4;
232}
233
234DT {
235 margin-left: 36pt;
236 margin-top: 12pt;
237}
238
239DD {
240 margin-left: 54pt;
241}
242
243DL.category DT {
244 font-weight: bold;
245}
246
247P.summary {
248 margin-left: 36pt;
249 font-family: monaco, courier, monospace;
250}
251
252DIV.summary TABLE {
253 border: solid thin #999999;
254 border-collapse: collapse;
255 border-spacing: 0;
256 margin: 10px;
257}
258
259DIV.summary TABLE TD, DIV.summary TABLE TH {
260 border: solid thin #999999;
261 padding: 5px;
262 text-align: left;
263 vertical-align: top;
264}
265
266DIV.summary TABLE THEAD TH {
267 background: #eeeeee;
268}
269
270/* API documentation styles... */
271div.body h1 {
272 margin: 0;
273}
274div.body h2 {
275 margin-top: 1.5em;
276}
277div.body h3, div.body h4, div.body h5 {
278 margin-bottom: 0.5em;
279 margin-top: 1.5em;
280}
281.class, .enumeration, .function, .struct, .typedef, .union {
282 border-bottom: solid thin #999999;
283 margin-bottom: 0;
284 margin-top: 2em;
285}
286.description {
287 margin-top: 0.5em;
288}
289code, p.code, pre, ul.code li {
290 font-family: monaco, courier, monospace;
291 font-size: 90%;
292}
293ul.code, ul.contents, ul.subcontents {
294 list-style-type: none;
295 margin: 0;
296 padding-left: 0;
297}
298ul.code li {
299 margin: 0;
300}
301ul.contents > li {
302 margin-top: 1em;
303}
304ul.contents li ul.code, ul.contents li ul.subcontents {
305 padding-left: 2em;
306}
307div.body dl {
308 margin-left: 0;
309 margin-top: 0;
310}
311div.body dt {
312 font-style: italic;
313 margin-left: 0;
314 margin-top: 0;
315}
316div.body dd {
317 margin-bottom: 0.5em;
318}
319
320/* This is just for the HTML files generated with the framedhelp target */
321div.contents {
322 background: #e8e8e8;
323 border: solid thin black;
324 padding: 10px;
325}
326div.contents h1 {
327 font-size: 110%;
328}
329div.contents h2 {
330 font-size: 100%;
331}
332div.contents ul.contents {
333 font-size: 80%;
334}
335div.contents ul.subcontents li {
336 margin-left: 1em;
337 text-indent: -1em;
338}
339--></style>
ef416fc2 340</head>
341<body>
10d09e33 342<div class='body'>
ef416fc2 343<!--
10d09e33 344 "$Id: spec-ppd.html 9345 2010-10-26 23:46:51Z mike $"
ef416fc2 345
10d09e33 346 PPD extension documentation for CUPS.
ef416fc2 347
c7017ecc 348 Copyright 2007-2010 by Apple Inc.
f7deaa1a 349 Copyright 1997-2007 by Easy Software Products.
ef416fc2 350
351 These coded instructions, statements, and computer programs are the
db1f069b
MS		 352 property of Apple Inc. and are protected by Federal copyright
353 law. Distribution and use rights are outlined in the file "LICENSE.txt"
354 which should have been included with this file. If this file is
355 file is missing or damaged, see the license at "http://www.cups.org/".
ef416fc2 356-->
357
178cb736
MS		 358<H1 CLASS="title">CUPS PPD Extensions</H1>
359
10d09e33 360<p>This specification describes the attributes and extensions that CUPS adds to <a href="http://partners.adobe.com/public/developer/en/ps/5003.PPD_Spec_v4.3.pdf" target="_blank">Adobe TechNote #5003: PostScript Printer Description File Format Specification Version 4.3</a>. PostScript Printer Description ("PPD") files describe the capabilities of each printer and are used by CUPS to support printer-specific features and intelligent filtering.</p>
ef416fc2 361
10d09e33
MS		 362<div class='summary'><table summary='General Information'>
363<tbody>
364<tr>
365 <th>See Also</th>
366 <td>Programming: <a href='postscript-driver.html'>Developing PostScript Printer Drivers</a><br>
367 Programming: <a href='raster-driver.html'>Developing Raster Printer Drivers</a><br>
368 Programming: <a href='api-filter.html'>Filter and Backend Programming</a><br>
369 Programming: <a href='ppd-compiler.html'>Introduction to the PPD Compiler</a><br>
370 Programming: <a href='api-raster.html'>Raster API</a><br>
371 References: <a href='ref-ppdcfile.html'>PPD Compiler Driver Information File Reference</a></td>
372</tr>
373</tbody>
374</table></div>
375<h2 class="title">Contents</h2>
376<ul class="contents">
10d09e33
MS		 377<li><a href="#SYNTAX">PPD File Syntax</a></li>
378<li><a href="#AUTOCONFIG">Auto-Configuration</a><ul class="subcontents">
0268488e
MS		 379 <li><a href="#APAutoSetupTool">APAutoSetupTool</a></li>
380 <li><a href="#QUERYKEYWORD">?MainKeyword</a></li>
381 <li><a href="#OID">OIDMainKeyword</a></li>
10d09e33
MS		 382</ul></li>
383<li><a href="#PROFILES">Color Profiles</a><ul class="subcontents">
0268488e
MS		 384 <li><a href="#cupsColorProfile">cupsColorProfile</a></li>
385 <li><a href="#cupsICCProfile">cupsICCProfile</a></li>
386 <li><a href="#APCustom">Custom Color Matching Support</a></li>
10d09e33
MS		 387</ul></li>
388<li><a href="#CONSTRAINTS">Constraints</a><ul class="subcontents">
0268488e
MS		 389 <li><a href="#cupsUIConstraints">cupsUIConstraints</a></li>
390 <li><a href="#cupsUIResolver">cupsUIResolver</a></li>
10d09e33
MS		 391</ul></li>
392<li><a href="#I18N">Globalized PPD Support</a></li>
393<li><a href="#OPTIONS">CUPS 1.3/Mac OS X 10.6Custom Options</a></li>
394<li><a href="#RASTERPS">Writing PostScript Option Commands for Raster Drivers</a></li>
395<li><a href="#MEDIA">Media Keywords</a><ul class="subcontents">
0268488e
MS		 396 <li><a href="#cupsMediaQualifier2">cupsMediaQualifier2</a></li>
397 <li><a href="#cupsMediaQualifier3">cupsMediaQualifier3</a></li>
398 <li><a href="#cupsMinSize">cupsMinSize</a></li>
399 <li><a href="#cupsMaxSize">cupsMaxSize</a></li>
10d09e33
MS		 400</ul></li>
401<li><a href="#ATTRIBUTES">General Attributes</a><ul class="subcontents">
0268488e
MS		 402 <li><a href="#cupsBackSide">cupsBackSide</a></li>
403 <li><a href="#cupsCommands">cupsCommands</a></li>
404 <li><a href="#cupsEvenDuplex">cupsEvenDuplex</a></li>
405 <li><a href="#cupsFax">cupsFax</a></li>
406 <li><a href="#cupsFilter">cupsFilter</a></li>
407 <li><a href="#cupsFlipDuplex">cupsFlipDuplex</a></li>
408 <li><a href="#cupsIPPFinishings">cupsIPPFinishings</a></li>
409 <li><a href="#cupsIPPReason">cupsIPPReason</a></li>
410 <li><a href="#cupsLanguages">cupsLanguages</a></li>
411 <li><a href="#cupsManualCopies">cupsManualCopies</a></li>
412 <li><a href="#cupsMarkerName">cupsMarkerName</a></li>
413 <li><a href="#cupsMarkerNotice">cupsMarkerNotice</a></li>
414 <li><a href="#cupsModelNumber">cupsModelNumber</a></li>
415 <li><a href="#cupsPJLCharset">cupsPJLCharset</a></li>
416 <li><a href="#cupsPJLDisplay">cupsPJLDisplay</a></li>
417 <li><a href="#cupsPortMonitor">cupsPortMonitor</a></li>
418 <li><a href="#cupsPreFilter">cupsPreFilter</a></li>
419 <li><a href="#cupsPrintQuality">cupsPrintQuality</a></li>
420 <li><a href="#cupsSNMPSupplies">cupsSNMPSupplies</a></li>
421 <li><a href="#cupsVersion">cupsVersion</a></li>
10d09e33
MS		 422</ul></li>
423<li><a href="#MACOSX">Mac OS X Attributes</a><ul class="subcontents">
0268488e
MS		 424 <li><a href="#APDialogExtension">APDialogExtension</a></li>
425 <li><a href="#APDuplexRequiresFlippedMargin">APDuplexRequiresFlippedMargin</a></li>
426 <li><a href="#APHelpBook">APHelpBook</a></li>
427 <li><a href="#APICADriver">APICADriver</a></li>
428 <li><a href="#APPrinterIconPath">APPrinterIconPath</a></li>
429 <li><a href="#APPrinterLowInkTool">APPrinterLowInkTool</a></li>
430 <li><a href="#APPrinterPreset">APPrinterPreset</a></li>
431 <li><a href="#APPrinterUtilityPath">APPrinterUtilityPath</a></li>
432 <li><a href="#APScannerOnly">APScannerOnly</a></li>
433 <li><a href="#APScanAppBundleID">APScanAppBundleID</a></li>
10d09e33
MS		 434</ul></li>
435<li><a href="#HISTORY">Change History</a></li>
0268488e 436</ul>
ef416fc2 437<h2 class='title'><a name='SYNTAX'>PPD File Syntax</a></h2>
438
10d09e33 439<p>The PPD format is text-based and uses lines of up to 255 characters terminated by a carriage return, linefeed, or combination of carriage return and line feed. The following ABNF definition [<a href="http://tools.ietf.org/html/rfc5234" target="_blank">RFC5234</a>] defines the general format of lines in a PPD file:</p>
ef416fc2 440
441<pre class='command'>
442PPD-FILE = HEADER +(DATA / COMMENT / LINE-END)
443
dd1abb6b
MS		 444HEADER = "*PPD-Adobe:" *WSP DQUOTE VERSION DQUOTE LINE-END
445
446VERSION = "4.0" / "4.1" / "4.2" / "4.3"
ef416fc2 447
448COMMENT = "*%" *TCHAR LINE-END
449
450DATA = "*" 1*KCHAR [ WSP 1*KCHAR [ "/" 1*TCHAR ] ] ":"
451 1*(*WSP VALUE) LINE-END
452
453VALUE = 1*TCHAR / DQUOTE 1*SCHAR DQUOTE
454
455KCHAR = ALPHA / DIGIT / "_" / "." / "-"
456
b19ccc9e 457SCHAR = LINE-END / WSP / %x21.23-7E.A0-FF
ef416fc2 458
b19ccc9e 459TCHAR = %x20-7E.A0-FF
ef416fc2 460
461LINE-END = CR / LF / CR LF
462</pre>
463
464
db1f069b 465<h2 class='title'><a name='AUTOCONFIG'>Auto-Configuration</a></h2>
ef416fc2 466
10d09e33 467<p>CUPS supports several methods of auto-configuration via PPD keywords.</p>
4744bd90 468
10d09e33 469<h3><span class='info'>Deprecated</span><a name='APAutoSetupTool'>APAutoSetupTool</a></h3>
4744bd90 470
db1f069b 471<p class='summary'>*APAutoSetupTool: "/LibraryPrinters/vendor/filename"</p>
4744bd90 472
10d09e33 473<p>This deprecated keyword defines a program that sets the default option choices. It is run when a printer is added from the <var>Add Printer</var> window or the <var>Nearby Printers</var> list in the <var>Print</var> dialog.</p>
db1f069b 474
10d09e33
MS		 475<p>The program is provided with two arguments: the printer's device URI and the PPD file to be used for the printer. The program must write an updated PPD file to stdout.</p>
476
477<blockquote><b>Note:</b>
db1f069b 478
10d09e33
MS		 479<p>This keyword is deprecated. New printer drivers SHOULD provide a CUPS command filter and support the "AutoConfigure" command. Alternately, drivers MAY use the <a href="#OID">SNMP OID</a> keywords to configure network printers or <a href="#QUERYKEYWORD">PostScript query keywords</a> to configure PostScript printers.</p>
480
481</blockquote>
db1f069b 482<p>Examples:</p>
4744bd90 483
484<pre class='command'>
db1f069b
MS		 485*% Use our setup tool when adding a printer
486*APAutoSetupTool: "/Library/Printers/vendor/Tools/autosetuptool"
4744bd90 487</pre>
488
10d09e33 489<h3><span class='info'>Mac OS X 10.2/CUPS 1.4</span><a name='QUERYKEYWORD'>?MainKeyword</a></h3>
a4d04587 490
db1f069b
MS		 491<p class='summary'>*?<i>MainKeyword</i>: "<br>
492 PostScript query code that writes a message using the = operator...<br>
493"<br>
494*End</p>
a4d04587 495
10d09e33 496<p>The <tt>?<i>MainKeyword</i></tt> keyword defines PostScript code that determines the currently selected/enabled option keyword (choice) for the main keyword (option). It is typically used when communicating with USB, serial, Appletalk, and AppSocket (port 9100) printers.</p>
db1f069b 497
10d09e33 498<p>The PostScript code typically sends its response back using the <tt>=</tt> operator.</p>
ef416fc2 499
a4d04587 500<p>Example:</p>
ef416fc2 501
502<pre class='command'>
db1f069b
MS		 503*OpenUI OptionDuplex/Duplexer Installed: Boolean
504*DuplexOptionDuplex: False
505*OptionDuplex False/Not Installed: ""
506*OptionDuplex True/Installed: ""
507
508<em>*% Query the printer for the presence of the duplexer option...</em>
509*?OptionDuplex: "
510 currentpagedevice /Duplex known
511 {(True)} {(False)} ifelse
512 = flush
513"
514*End
515*CloseUI: OptionDuplex
ef416fc2 516</pre>
517
10d09e33 518<h3><span class='info'>Mac OS X 10.4/CUPS 1.5</span><a name='OID'>OIDMainKeyword</a></h3>
a4d04587 519
db1f069b
MS		 520<p class='summary'>*?OID<i>MainKeyword</i>: ".n.n.n..."<br>
521*OID<i>MainKeyword</i> <i>OptionKeyword1</i>: "value"<br>
522...<br>
523*OID<i>MainKeyword</i> <i>OptionKeywordN</i>: "value"</p>
09a101d6 524
10d09e33 525<p>The <tt>OID<i>MainKeyword</i></tt> keyword is used to define SNMP OIDs that map to installable options. The first (query) line defines the OID to lookup on the network device. The second and subsequent keywords define a mapping from OID value to option keyword. Since SNMP is an IP-based network protocol, this method is typically only used to configure AppSocket, IPP, and LPD network printers.</p>
09a101d6 526
527<p>Examples:</p>
528
529<pre class='command'>
db1f069b
MS		 530*% Get the installed memory on the printer...
531*?OIDInstalledMemory: ".1.3.6.1.2.1.25.2.2.0"
532*OIDInstalledMemory 16MB: "16384 KBytes"
533*OIDInstalledMemory 32MB: "32768 KBytes"
534*OIDInstalledMemory 48MB: "49152 KBytes"
535*OIDInstalledMemory 72MB: "73728 KBytes"
09a101d6 536</pre>
537
3d8365b8 538
db1f069b 539<h2 class='title'><a name='PROFILES'>Color Profiles</a></h2>
3d8365b8 540
10d09e33 541<p>CUPS supports three types of color profiles. The first type is based on sRGB and is used by the standard CUPS raster filters and GPL Ghostscript. The second type is based on ICC profiles and is used by the Quartz-based filters on MacOS X. The final type is based on well-known colorspaces such as sRGB and Adobe RGB.</p>
3d8365b8 542
db1f069b 543<blockquote><b>Note:</b>
3d8365b8 544
10d09e33 545<p>At this time, none of the CUPS raster filters support ICC profiles. This will be addressed as time and resources permit.</p>
bc44d920 546
db1f069b 547</blockquote>
bc44d920 548
01ce6322 549<h3><span class='info'>Deprecated</span><a name='cupsColorProfile'>cupsColorProfile</a></h3>
bc44d920 550
10d09e33 551<p class='summary'>*cupsColorProfile Resolution/MediaType: "density gamma m00 m01 m02 m10 m11 m12 m20 m21 m22"</p>
bc44d920 552
10d09e33 553<p>This string keyword specifies an sRGB-based color profile consisting of gamma and density controls and a 3x3 CMY color transform matrix. <em>This keyword is not supported on Mac OS X.</em></p>
bc44d920 554
10d09e33 555<p>The <i>Resolution</i> and <i>MediaType</i> values may be "-" to act as a wildcard. Otherwise they must match one of the <tt>Resolution</tt> or <tt>MediaType</tt> option keywords defined in the PPD file.</p>
bc44d920 556
db1f069b
MS		 557<p>The <i>density</i> and <i>gamma</i> values define gamma and
558density adjustment function such that:</p>
bc44d920 559
560<pre class='command'>
db1f069b 561f(x) = density * x <sup style='font-size: 100%'>gamma</sup>
bc44d920 562</pre>
563
10d09e33 564<p>The <i>m00</i> through <i>m22</i> values define a 3x3 transformation matrix for the CMY color values. The density function is applied <i>after</i> the CMY transformation:</p>
bc44d920 565
db1f069b
MS		 566<pre class='command'>
567| m00 m01 m02 |
568| m10 m11 m12 |
569| m20 m21 m22 |
570</pre>
2abf387c 571
db1f069b 572<p>Examples:</p>
2abf387c 573
db1f069b
MS		 574<pre class='command'>
575<em>*% Specify a profile for printing at 360dpi on all media types</em>
576*cupsColorProfile 360dpi/-: "1.0 1.5 1.0 0.0 -0.2 -0.4 1.0 0.0 -0.2 0.0 1.0"
2abf387c 577
db1f069b
MS		 578<em>*% Specify a profile for printing at 720dpi on Glossy media</em>
579*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"
2abf387c 580
db1f069b
MS		 581<em>*% Specify a default profile for printing at all other resolutions and media types</em>
582*cupsColorProfile -/-: "0.9 2.0 1.0 0.0 -0.2 -0.4 1.0 0.0 -0.2 0.0 1.0"
2abf387c 583</pre>
584
01ce6322 585
10d09e33 586<h3><span class='info'>Mac OS X 10.3/CUPS 1.2</span><a name='cupsICCProfile'>cupsICCProfile</a></h3>
3d8365b8 587
10d09e33 588<p class='summary'>*cupsICCProfile ColorModel.MediaType.Resolution/Description: "filename"</p>
3d8365b8 589
10d09e33 590<p>This keyword specifies an ICC color profile that is used to convert the document colors to the device colorspace. The <tt>ColorModel</tt>, <tt>MediaType</tt>, and <tt>Resolution</tt> option keywords specify a selector for color profiles. If omitted, the color profile will match any option keyword for the corresponding main keyword.</p>
db1f069b 591
10d09e33 592<p>The <tt>Description</tt> specifies human-readable text that is associated with the color profile. The <tt>filename</tt> portion specifies the ICC color profile to use; if the filename is not absolute, it is loaded relative to the <var>/usr/share/cups/profiles</var> directory.</p>
3d8365b8 593
594<p>Examples:</p>
595
596<pre class='command'>
db1f069b
MS		 597<em>*% Specify a profile for CMYK printing at 360dpi on all media types</em>
598*cupsICCProfile CMYK..360dpi/360dpi CMYK: "/Library/Printers/vendor/Profiles/foo-360-cmyk.icc"
3d8365b8 599
db1f069b
MS		 600<em>*% Specify a profile for RGB printing at 720dpi on Glossy media</em>
601*cupsColorProfile RGB.Glossy.720dpi/720dpi Glossy: "/Library/Printers/vendor/Profiles/foo-720-glossy-rgb.icc"
a4d04587 602
db1f069b
MS		 603<em>*% Specify a default profile for printing at all other resolutions and media types</em>
604*cupsICCProfile ../Default: "/Library/Printers/vendor/Profiles/foo-default.icc"
605</pre>
a4d04587 606
db1f069b 607<h4>Customizing the Profile Selection Keywords</h4>
ef416fc2 608
10d09e33 609<p>The <tt>MediaType</tt> and <tt>Resolution</tt> main keywords can be reassigned to different main keywords, allowing drivers to do color profile selection based on different parameters. The <tt>cupsICCQualifier2</tt> and <tt>cupsICCQualifier3</tt> keywords define the mapping from selector to main keyword:</p>
ef416fc2 610
611<pre class='command'>
db1f069b
MS		 612*cupsICCQualifier2: MainKeyword2
613*cupsICCQualifier3: MainKeyword3
614</pre>
ef416fc2 615
db1f069b 616<p>The default mapping is as follows:</p>
ef416fc2 617
db1f069b
MS		 618<pre class='command'>
619*cupsICCQualifier2: MediaType
620*cupsICCQualifier3: Resolution
ef416fc2 621</pre>
622
db1f069b 623<h3><span class='info'>Mac OS X 10.4</span><a name='APCustom'>Custom Color Matching Support</a></h3>
ef416fc2 624
db1f069b
MS		 625<p class='summary'>*<a href='#APSupportsCustomColorMatching'>APSupportsCustomColorMatching</a>: true<br>
626*<a href='#APCustomColorMatchingName'>APCustomColorMatchingName</a> name/text: ""<br>
627*<a href='#APCustomColorMatchingProfile'>APCustomColorMatchingProfile</a>: profile<br>
628*<a href='#APDefaultCustomColorMatchingProfile'>APDefaultCustomColorMatchingProfile</a>: profile</p>
a4d04587 629
10d09e33 630<p>These keywords tell the Mac OS X raster filters that the printer driver provides its own custom color matching and that generic color profiles should be used when generating 1-, 3-, and 4-component raster data as requested by the driver. The <tt>APCustomColorMatchingProfile</tt> and <tt>APDefaultColorMatchingProfile</tt> keywords specify alternate color profiles (sRGB or AdobeRGB) to use for 3-color (RGB) raster data.</p>
09a101d6 631
5a662dc0
MS		 632<blockquote><b>Note:</b>
633
10d09e33 634<p>Prior to Mac OS X 10.6, the default RGB color space was Apple's "GenericRGB". The new default in Mac OS X 10.6 and later is "sRGB". For more information, see <a href="http://support.apple.com/kb/HT3712">"Mac OS X v10.6: About gamma 2.2"</a> on Apple's support site.</p>
5a662dc0
MS		 635
636</blockquote>
637
db1f069b 638<h4><span class='info'>Mac OS X 10.5</span><a name='APCustomColorMatchingName'>APCustomColorMatchingName</a></h4>
09a101d6 639
db1f069b 640<p class='summary'>*APCustomColorMatchingName name/text: ""</p>
ef416fc2 641
10d09e33 642<p>This keyword defines an alternate name for the color matching provided by a driver in the <var>Color Matching</var> print panel. The default is to use the name "Vendor Matching" or its localized equivalent.</p>
db1f069b
MS		 643
644<p>Examples:</p>
ef416fc2 645
646<pre class='command'>
db1f069b
MS		 647*% Define the names for our color matching...
648*APCustomColorMatchingName name/AcmeColor(tm): ""
649*fr.APCustomColorMatchingName name/La AcmeColor(tm): ""
ef416fc2 650</pre>
651
db1f069b 652<h4><span class='info'>Mac OS X 10.5</span><a name='APCustomColorMatchingProfile'>APCustomColorMatchingProfile</a></h4>
bc44d920 653
db1f069b 654<p class='summary'>*APCustomColorMatchingProfile: name</p>
a4d04587 655
10d09e33 656<p>This keyword defines a supported RGB color profile that can be used when doing custom color matching. Currently only <tt>sRGB</tt>, <tt>AdobeRGB</tt>, and <tt>GenericRGB</tt> are supported. If not specified, RGB data will use the GenericRGB colorspace.</p>
09a101d6 657
db1f069b 658<blockquote><b>Note:</b>
09a101d6 659
10d09e33 660<p>If you provide multiple <tt>APCustomColorMatchingProfile</tt> keywords, you are responsible for providing the necessary user interface controls to select the profile in a <a href='#APDialogExtension'>print dialog pane</a>. Add the named profile to the print settings using the key <tt>kPMCustomColorMatchingProfileKey</tt>.</p>
db1f069b
MS		 661
662</blockquote>
09a101d6 663
664<p>Examples:</p>
665
666<pre class='command'>
db1f069b
MS		 667*% Use sRGB for RGB color by default, but support both sRGB and AdobeRGB
668*APSupportsCustomColorMatching: true
669*APDefaultCustomColorMatchingProfile: sRGB
670*APCustomColorMatchingProfile: sRGB
671*APCustomColorMatchingProfile: AdobeRGB
09a101d6 672</pre>
673
db1f069b 674<h4><span class='info'>Mac OS X 10.5</span><a name='APDefaultCustomColorMatchingProfile'>APDefaultCustomColorMatchingProfile</a></h4>
4744bd90 675
db1f069b 676<p class='summary'>*APDefaultCustomColorMatchingProfile: name</p>
4744bd90 677
10d09e33 678<p>This keyword defines the default RGB color profile that will be used when doing custom color matching. Currently only <tt>sRGB</tt>, <tt>AdobeRGB</tt>, and <tt>GenericRGB</tt> are supported.</p>
bc44d920 679
4744bd90 680<p>Examples:</p>
681
682<pre class='command'>
db1f069b
MS		 683*% Use sRGB for RGB color by default
684*APSupportsCustomColorMatching: true
685*APDefaultCustomColorMatchingProfile: sRGB
4744bd90 686</pre>
687
db1f069b 688<h4><span class='info'>Mac OS X 10.4</span><a name='APSupportsCustomColorMatching'>APSupportsCustomColorMatching</a></h4>
a4d04587 689
db1f069b 690<p class='summary'>*APSupportsCustomColorMatching: boolean</p>
a4d04587 691
10d09e33 692<p>This keyword specifies that the driver provides its own custom color matching. When <tt>true</tt>, the default hand-off colorspace will be GenericGray, GenericRGB, or GenericCMYK depending on the number of components the driver requests. The <a href='#APDefaultCustomColorMatchingProfile'><tt>APDefaultCustomColorMatchingProfile</tt></a> keyword can be used to override the default 3-component (RGB) colorspace.</p>
a4d04587 693
db1f069b
MS		 694<p>The default for <tt>APSupportsCustomColorMatching</tt> is <tt>false</tt>.</p>
695
696<p>Examples:</p>
a4d04587 697
698<pre class='command'>
db1f069b
MS		 699*APSupportsCustomColorMatching: true
700*APDefaultCustomColorMatchingProfile: sRGB
a4d04587 701</pre>
702
ef416fc2 703
66ab9486
MS		 704<h2 class='title'><a name='CONSTRAINTS'>Constraints</a></h2>
705
10d09e33 706<p>Constraints are option choices that are not allowed by the driver or device, for example printing 2-sided transparencies. All versions of CUPS support constraints defined by the legacy Adobe <tt>UIConstraints</tt> and <tt>NonUIConstraints</tt> keywords which support conflicts between any two option choices, for example:</p>
66ab9486
MS		 707
708<pre class='command'>
709*% Do not allow 2-sided printing on transparency media
710*UIConstraints: "*Duplex *MediaType Transparency"
711*UIConstraints: "*MediaType Transparency *Duplex"
712</pre>
713
10d09e33 714<p>While nearly all constraints can be expressed using these keywords, there are valid scenarios requiring constraints between more than two option choices. In addition, resolution of constraints is problematic since users and software have to guess how a particular constraint is best resolved.</p>
66ab9486 715
10d09e33 716<p>CUPS 1.4 and higher define two new keywords for constraints, <tt>cupsUIConstraints</tt> and <tt>cupsUIResolver</tt>. Each <tt>cupsUIConstraints</tt> keyword points to a <tt>cupsUIResolver</tt> keyword which specifies alternate options that resolve the conflict condition. The same <tt>cupsUIResolver</tt> can be used by multiple <tt>cupsUIConstraints</tt>.</p>
1340db2d
MS		 717
718<blockquote><b>Note:</b>
719
10d09e33 720<p>When developing PPD files that contain constraints, it is very important to use the <a href="man-cupstestppd.html">cupstestppd(1)</a> program to verify that your constraints are accurate and cannot result in unresolvable option selections.</p>
1340db2d
MS		 721
722</blockquote>
66ab9486 723
b0f6947b 724<h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsUIConstraints'>cupsUIConstraints</a></h3>
66ab9486
MS		 725
726<p class='summary'>*cupsUIConstraints resolver: "*Keyword1 *Keyword2 ..."<br>
727*cupsUIConstraints resolver: "*Keyword1 OptionKeyword1 *Keyword2 ..."<br>
728*cupsUIConstraints resolver: "*Keyword1 *Keyword2 OptionKeyword2 ..."<br>
729*cupsUIConstraints resolver: "*Keyword1 OptionKeyword1 *Keyword2 OptionKeyword2 ..."<br>
730*cupsUIConstraints: "*InstallableKeyword1 OptionKeyword1 *Keyword2 OptionKeyword2 ..."</p>
731
10d09e33 732<p>Lists two or more options which conflict. The "resolver" string is a (possibly unique) keyword which specifies which options to change when the constraint exists. When no resolver is provided, CUPS first tries the default choice followed by testing each option choice to resolve the conflict.</p>
66ab9486
MS		 733
734<p>Examples:</p>
735
736<pre class='command'>
737<em>*% Specify that 2-sided printing cannot happen on transparencies</em>
738*cupsUIConstraints transparency: "*Duplex *MediaType Transparency"
739
1340db2d
MS		 740<em>*% Specify that envelope printing cannot happen from the paper trays</em>
741*cupsUIConstraints envelope: "*PageSize Env10 *InputSlot Tray1"
742*cupsUIConstraints envelope: "*PageSize Env10 *InputSlot Tray1"
743*cupsUIConstraints envelope: "*PageSize EnvDL *InputSlot Tray2"
744*cupsUIConstraints envelope: "*PageSize EnvDL *InputSlot Tray2"
745
746<em>*% Specify an installable option constraint for the envelope feeder</em>
747*cupsUIConstraints: "*InputSlot EnvFeeder *InstalledEnvFeeder"
748
66ab9486
MS		 749<em>*% Specify that photo printing cannot happen on plain paper or transparencies at 1200dpi</em>
750*cupsUIConstraints photo: "*OutputMode Photo *MediaType Plain *Resolution 1200dpi"
751*cupsUIConstraints photo: "*OutputMode Photo *MediaType Transparency *Resolution 1200dpi"
752</pre>
753
b0f6947b 754<h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsUIResolver'>cupsUIResolver</a></h3>
66ab9486 755
c779abb0 756<p class='summary'>*cupsUIResolver resolver: "*Keyword1 OptionKeyword1 *Keyword2 OptionKeyword2 ..."</p>
66ab9486 757
10d09e33 758<p>Specifies two or more options to mark/select to resolve a constraint. The "resolver" string identifies a particular action to take for one or more <a href='#cupsUIConstraints'><tt>cupsUIConstraints</tt></a>. The same action can be used for multiple constraints. The option keyword pairs are treated as an ordered list of option selections to try - only the first N selections will be used, where N is the minimum number of selections required. Because <a href="api-ppd.html#cupsResolveConflicts"><code>cupsResolveConflicts()</code></a> will not change the most recent option selection passed to it, at least two options from the constraints must be listed to avoid situations where conflicts cannot be resolved.</p>
66ab9486
MS		 759
760<p>Examples:</p>
761
762<pre class='command'>
1340db2d
MS		 763<em>*% Specify the options to change for the 2-sided transparency constraint</em>
764*cupsUIResolver transparency: "*Duplex None *MediaType Plain"
765
766<em>*% Specify the options to change for the envelope printing constraints. Notice
767*% that we try to change the InputSlot to either the envelope feeder or the
768*% manual feed first, then we change the page size...</em>
769*cupsUIResolver envelope: "*InputSlot EnvFeeder *InputSlot ManualFeed *PageSize Letter"
66ab9486
MS		 770
771<em>*% Specify the options to change for the photo printing constraints</em>
772*cupsUIResolver photo: "*OutputMode Best *Resolution 600dpi"
773</pre>
774
775
db1f069b 776<h2 class='title'><a name='I18N'>Globalized PPD Support</a></h2>
a4d04587 777
10d09e33 778<p>CUPS 1.2 and higher adds support for PPD files containing multiple languages by following the following additional rules:</p>
ef416fc2 779
db1f069b 780<ol>
ef416fc2 781
db1f069b 782 <li>The <tt>LanguageVersion</tt> MUST be <tt>English</tt></li>
a4d04587 783
db1f069b 784 <li>The <tt>LanguageEncoding</tt> MUST be <tt>ISOLatin1</tt></li>
ef416fc2 785
10d09e33 786 <li>The <tt>cupsLanguages</tt> keyword MUST be provided and list each of the supported locales in the PPD file</li>
ef416fc2 787
10d09e33 788 <li>Main and option keywords MUST NOT exceed 34 (instead of 40) characters to allow room for the locale prefixes in translation keywords</li>
ef416fc2 789
db1f069b 790 <li>The main keyword "Translation" MUST NOT be used</li>
f7deaa1a 791
10d09e33 792 <li>Translation strings included with the main and option keywords MUST NOT contain characters outside the ASCII subset of ISOLatin1 and UTF-8; developers wishing to use characters outside ASCII MUST provide a separate set of English localization keywords for the affected keywords.</li>
f7deaa1a 793
10d09e33 794 <li>Localizations are specified using a locale prefix of the form "ll" or "ll_CC." where "ll" is the 2-letter ISO language code and "CC" is the 2-letter ISO country code<ul>
db1f069b
MS		 795 <li>A generic language translation ("ll") SHOULD be provided with country-specific differences ("ll_CC") provided only as needed</li>
796 <li>For historical reasons, the "zh" and "zh_CN" locales map to Simplified Chinese while the "zh_TW" locale maps to Traditional Chinese</li>
797 </ul></li>
f7deaa1a 798
10d09e33 799 <li>Locale-specific translation strings MUST be encoded using UTF-8.</li>
f7deaa1a 800
10d09e33
MS		 801 <li>Main keywords MUST be localized using one of the following forms:
802 <p><tt>*ll.Translation MainKeyword/translation text: ""</tt><br />
803 <tt>*ll_CC.Translation MainKeyword/translation text: ""</tt></p></li>
f7deaa1a 804
10d09e33
MS		 805 <li>Option keywords MUST be localized using one of the following forms:
806 <p><tt>*ll.MainKeyword OptionKeyword/translation text: ""</tt><br>
807 <tt>*ll_CC.MainKeyword OptionKeyword/translation text: ""</tt></p></li>
f7deaa1a 808
10d09e33 809 <li>Localization keywords MAY appear anywhere after the first line of the PPD file</li>
f7deaa1a 810
db1f069b 811</ol>
ef416fc2 812
db1f069b 813<blockquote><b>Note:</b>
a4d04587 814
10d09e33 815<p>We use a <tt>LanguageEncoding</tt> value of <tt>ISOLatin1</tt> and limit the allowed base translation strings to ASCII to avoid character coding issues that would otherwise occur. In addition, requiring the base translation strings to be in English allows for easier fallback translation when no localization is provided in the PPD file for a given locale.</p>
ef416fc2 816
db1f069b 817</blockquote>
a4d04587 818
ef416fc2 819<p>Examples:</p>
820
821<pre class='command'>
db1f069b
MS		 822*LanguageVersion: English
823*LanguageEncoding: ISOLatin1
824*cupsLanguages: "de fr_CA"
825*ModelName: "Foobar Laser 9999"
f7deaa1a 826
db1f069b
MS		 827<em>*% Localize ModelName for French and German</em>
828*fr_CA.Translation ModelName/La Foobar Laser 9999: ""
829*de.Translation ModelName/Foobar LaserDrucken 9999: ""
f7deaa1a 830
db1f069b
MS		 831*cupsIPPReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html"
832<em>*% Localize printer-state-reason for French and German</em>
833*fr_CA.cupsIPPReason com.vendor-error/Une erreur s&egrave;rieuse s'est produite: "/help/com.vendor/error.html"
834*de.cupsIPPReason com.vendor-error/Eine ernste St&ouml;rung trat: "/help/com.vendor/error.html"
f7deaa1a 835
db1f069b 836...
f7deaa1a 837
db1f069b
MS		 838*OpenUI *InputSlot/Paper Source: PickOne
839*OrderDependency: 10 AnySetup *InputSlot
840*DefaultInputSlot: Auto
841<em>*% Localize InputSlot for French and German</em>
842*fr_CA.Translation InputSlot/Papier source: ""
843*de.Translation InputSlot/Papiereinzug: ""
844*InputSlot Auto/Default: "&lt;&lt;/ManualFeed false&gt;&gt;setpagedevice"
845<em>*% Localize InputSlot=Auto for French and German</em>
846*fr_CA.InputSlot Auto/Par Defaut: ""
847*de.InputSlot Auto/Standard: ""
848*InputSlot Manual/Manual Feed: "&lt;&lt;/ManualFeed true&gt;&gt;setpagedevice"
849<em>*% Localize InputSlot=Manual for French and German</em>
850*fr_CA.InputSlot Manual/Manuel mecanisme de alimentation: ""
851*de.InputSlot Manual/Manueller Einzug: ""
852*CloseUI: *InputSlot
f7deaa1a 853</pre>
854
ef416fc2 855
10d09e33 856<h2 class='title'><a name='OPTIONS'><span class="info">CUPS 1.3/Mac OS X 10.6</span>Custom Options</a></h2>
ef416fc2 857
10d09e33 858<p>CUPS supports custom options using an extension of the <tt>CustomPageSize</tt> and <tt>ParamCustomPageSize</tt> syntax:</p>
ef416fc2 859
860<pre class='command'>
861*CustomFoo True: "command"
862*ParamCustomFoo Name1/Text 1: order type minimum maximum
863*ParamCustomFoo Name2/Text 2: order type minimum maximum
864...
865*ParamCustomFoo NameN/Text N: order type minimum maximum
866</pre>
867
10d09e33
MS		 868<p>When the base option is part of the <tt>JCLSetup</tt> section, the "command" string contains JCL commands with "\order" placeholders for each numbered parameter. The CUPS API handles any necessary value quoting for HP-PJL commands. For example, if the JCL command string is "@PJL SET PASSCODE=\1" and the first
869option value is "1234" then CUPS will output the string "@PJL SET PASSCODE=1234".</p>
870
871<p>For non-<tt>JCLSetup</tt> options, the "order" value is a number from 1 to N and specifies the order of values as they are placed on the stack before the command. For example, if the PostScript command string is "&lt;&lt;/cupsReal1 2 1 roll&gt;&gt;setpagedevice" and the option value is "2.0" then CUPS will output the string "2.0 &lt;&lt;/cupsReal1 2 1 roll&gt;&gt;setpagedevice".</p>
ef416fc2 872
873<p>The "type" is one of the following keywords:</p>
874
875<ul>
876
10d09e33 877 <li><tt>curve</tt> - a real value from "minimum" to "maximum" representing a gamma correction curve using the function: f(x) = x <sup>value</sup></li>
ef416fc2 878
10d09e33 879 <li><tt>int</tt> - an integer value from "minimum" to "maximum"</li>
ef416fc2 880
10d09e33 881 <li><tt>invcurve</tt> - a real value from "minimum" to "maximum" representing a gamma correction curve using the function: f(x) = x <sup>1 / value</sup></li>
ef416fc2 882
10d09e33 883 <li><tt>passcode</tt> - a string of numbers value with a minimum of "minimum" numbers and a maximum of "maximum" numbers ("minimum" and "maximum" are numbers and passcode strings are not displayed in the user interface)</li>
ef416fc2 884
10d09e33 885 <li><tt>password</tt> - a string value with a minimum of "minimum" characters and a maximum of "maximum" characters ("minimum" and "maximum" are numbers and password strings are not displayed in the user interface)</li>
ef416fc2 886
10d09e33 887 <li><tt>points</tt> - a measurement value in points from "minimum" to "maximum"</li>
ef416fc2 888
10d09e33 889 <li><tt>real</tt> - a real value from "minimum" to "maximum"</li>
ef416fc2 890
10d09e33 891 <li><tt>string</tt> - a string value with a minimum of "minimum" characters and a maximum of "maximum" characters ("minimum" and "maximum" are numbers)</li>
ef416fc2 892
893</ul>
894
895<p>Examples:</p>
896
897<pre class='command'>
898<em>*% Base JCL key code option</em>
a41f09e2 899*JCLOpenUI JCLPasscode/Key Code: PickOne
ef416fc2 900*OrderDependency: 10 JCLSetup *JCLPasscode
901*DefaultJCLPasscode: None
902*JCLPasscode None/No Code: ""
903*JCLPasscode 1111: "@PJL SET PASSCODE = 1111&lt;0A&gt;"
904*JCLPasscode 2222: "@PJL SET PASSCODE = 2222&lt;0A&gt;"
905*JCLPasscode 3333: "@PJL SET PASSCODE = 3333&lt;0A&gt;"
906*JCLCloseUI: *JCLPasscode
907
908<em>*% Custom JCL key code option</em>
909*CustomJCLPasscode True: "@PJL SET PASSCODE = \1&lt;0A&gt;"
910*ParamCustomJCLPasscode Code/Key Code: 1 passcode 4 4
911
912
a4d04587 913<em>*% Base PostScript watermark option</em>
914*OpenUI WatermarkText/Watermark Text: PickOne
915*OrderDependency: 10 AnySetup *WatermarkText
916*DefaultWatermarkText: None
917*WatermarkText None: ""
918*WatermarkText Draft: "&lt;&lt;/cupsString1(Draft)&gt;&gt;setpagedevice"
919*CloseUI: *WatermarkText
920
921<em>*% Custom PostScript watermark option</em>
b86bc4cf 922*CustomWatermarkText True: "&lt;&lt;/cupsString1 3 -1 roll&gt;&gt;setpagedevice"
a4d04587 923*ParamCustomWatermarkText Text: 1 string 0 32
924
925
ef416fc2 926<em>*% Base PostScript gamma/density option</em>
927*OpenUI GammaDensity/Gamma and Density: PickOne
928*OrderDependency: 10 AnySetup *GammaDensity
929*DefaultGammaDensity: Normal
930*GammaDensity Normal/Normal: "&lt;&lt;/cupsReal1 1.0/cupsReal2 1.0&gt;&gt;setpagedevice"
931*GammaDensity Light/Lighter: "&lt;&lt;/cupsReal1 0.9/cupsReal2 0.67&gt;&gt;setpagedevice"
932*GammaDensity Dark/Darker: "&lt;&lt;/cupsReal1 1.1/cupsReal2 1.5&gt;&gt;setpagedevice"
a4d04587 933*CloseUI: *GammaDensity
ef416fc2 934
935<em>*% Custom PostScript gamma/density option</em>
b86bc4cf 936*CustomGammaDensity True: "&lt;&lt;/cupsReal1 3 -1 roll/cupsReal2 5 -1&gt;&gt;setpagedevice"
ef416fc2 937*ParamCustomGammaDensity Gamma: 1 curve 0.1 10
938*ParamCustomGammaDensity Density: 2 real 0 2
939</pre>
940
941
db1f069b 942<h2 class='title'><a name='RASTERPS'>Writing PostScript Option Commands for Raster Drivers</a></h2>
a4d04587 943
10d09e33 944<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 keywords such as page size, resolution, and so forth. For example, the following code sets the page size to A4 size:</p>
ef416fc2 945
db1f069b
MS		 946<pre class='command'>
947*PageSize A4: "&lt;&lt;/PageSize[595 842]&gt;&gt;setpagedevice"
948</pre>
ef416fc2 949
db1f069b 950<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>
ef416fc2 951
db1f069b
MS		 952<pre class='command'>
953*CustomWatermarkText True: "&lt;&lt;/cupsString1 3 -1 roll&gt;&gt;setpagedevice"
954</pre>
ef416fc2 955
db1f069b 956<p>For a custom string value of "My Watermark", CUPS will produce the following PostScript code for the option:</p>
ef416fc2 957
958<pre class='command'>
db1f069b
MS		 959(My Watermark)
960&lt;&lt;/cupsString1 3 -1 roll&gt;&gt;setpagedevice
ef416fc2 961</pre>
962
db1f069b 963<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>
ef416fc2 964
965<pre class='command'>
db1f069b 966&lt;&lt;/cupsString1(My Watermark)&gt;&gt;setpagedevice
ef416fc2 967</pre>
968
db1f069b 969<p>The resulting dictionary sets the page device attributes that are sent to your raster driver in the page header.</p>
ef416fc2 970
db1f069b 971<h3>Custom Page Size Code</a></h3>
ef416fc2 972
db1f069b 973<p>There are many possible implementations of the <tt>CustomPageSize</tt> code. For CUPS raster drivers, the following code is recommended:</p>
ef416fc2 974
db1f069b
MS		 975<pre class='command'>
976*ParamCustomPageSize Width: 1 points <i>min-width max-width</i>
977*ParamCustomPageSize Height: 2 points <i>min-height max-height</i>
978*ParamCustomPageSize WidthOffset: 3 points 0 0
979*ParamCustomPageSize HeightOffset: 4 points 0 0
980*ParamCustomPageSize Orientation: 5 int 0 0
981*CustomPageSize True: "pop pop pop &lt;&lt;/PageSize[5 -2 roll]/ImagingBBox null&gt;&gt;setpagedevice"
ef416fc2 982</pre>
983
db1f069b 984<h3>Supported PostScript Operators</a></h3>
ef416fc2 985
db1f069b 986<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>
ef416fc2 987
db1f069b 988<ul>
ef416fc2 989
db1f069b 990 <li><tt>&lt;&lt;</tt> - Start a dictionary.</li>
ef416fc2 991
db1f069b 992 <li><tt>&gt;&gt;</tt> - End a dictionary.</li>
ef416fc2 993
db1f069b 994 <li><tt>[</tt> - Start an array.</li>
ef416fc2 995
db1f069b 996 <li><tt>]</tt> - End an array.</li>
ef416fc2 997
db1f069b 998 <li><tt>copy</tt> - Copy the top N objects on the stack.</li>
ef416fc2 999
db1f069b 1000 <li><tt>dup</tt> - Copy the top object on the stack.</li>
ef416fc2 1001
db1f069b 1002 <li><tt>index</tt> - Copy the Nth from the top object on the stack.</li>
ef416fc2 1003
db1f069b 1004 <li><tt>pop</tt> - Pop the top object on the stack.</li>
ef416fc2 1005
db1f069b 1006 <li><tt>roll</tt> - Shift the top N objects on the stack.</li>
ef416fc2 1007
db1f069b 1008 <li><tt>setpagedevice</tt> - Set the page header values according to the key/value dictionary on the stack.</li>
ef416fc2 1009
db1f069b 1010</ul>
ef416fc2 1011
db1f069b 1012<blockquote><b>Note:</b>
ef416fc2 1013
db1f069b
MS		 1014<p><em>Never</em> use the unsupported <tt>dict</tt> or <tt>put</tt>
1015operators in your option code. These operators are typically used in
1016option code dating back to Level 1 PostScript printers, which did not
1017support the simpler <tt>&lt;&lt;</tt> or <tt>&gt;&gt;</tt> operators.
1018If you have old option code using <tt>dict</tt> or <tt>put</tt>, you can
1019rewrite it very easily to use the newer <tt>&lt;&lt;</tt> and
1020<tt>&gt;&gt;</tt> operators instead. For example, the following code
1021to set the page size:</p>
09a101d6 1022
1023<style type='text/css'><!--
1024PRE B {
1025 background: #000000;
1026 color: #ffffff;
1027 padding: 2px 5px;
1028}
1029--></style>
1030
1031<pre class='command'>
1032<b>1 dict dup</b> /PageSize [612 792] <b>put</b> setpagedevice
1033</pre>
1034
1035<p>can be rewritten as:</p>
1036
1037<pre class='command'>
1038<b>&lt;&lt;</b> /PageSize [612 792] <b>&gt;&gt;</b> setpagedevice
1039</pre>
1040
1041</blockquote>
1042
db1f069b 1043<h3>Supported Page Device Attributes</a></h3>
b86bc4cf 1044
09a101d6 1045<p>Table 2 shows the supported page device attributes along with PostScript code examples.</p>
b86bc4cf 1046
1047<div class='table'>
1048<table summary='Supported Page Device Attributes'>
09a101d6 1049<caption>Table 2: <a name='TABLE_2'>Supported Page Device Attributes</a></caption>
b86bc4cf 1050<thead>
1051<tr>
1052 <th>Name(s)</th>
1053 <th>Type</th>
1054 <th>Description</th>
1055 <th>Example(s)</th>
1056</tr>
1057</thead>
1058<tbody>
1059<tr valign='top'>
1060 <td><tt>AdvanceDistance</tt></td>
1061 <td>Integer</td>
1062 <td>Specifies the number of points to advance roll media after printing.</td>
1063 <td><tt>&lt;&lt;/AdvanceDistance 18&gt;&gt;setpagedevice</tt></td>
1064</tr>
1065<tr valign='top'>
1066 <td><tt>AdvanceMedia</tt></td>
1067 <td>Integer</td>
1068 <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>
1069 <td><tt>&lt;&lt;/AdvanceMedia 4&gt;&gt;setpagedevice</tt></td>
1070</tr>
1071<tr valign='top'>
1072 <td><tt>Collate</tt></td>
1073 <td>Boolean</td>
1074 <td>Specifies whether collated copies are required.</td>
1075 <td><tt>&lt;&lt;/Collate true&gt;&gt;setpagedevice</tt></td>
1076</tr>
1077<tr valign='top'>
1078 <td><tt>CutMedia</tt></td>
1079 <td>Integer</td>
1080 <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>
1081 <td><tt>&lt;&lt;/CutMedia 1&gt;&gt;setpagedevice</tt></td>
1082</tr>
1083<tr valign='top'>
1084 <td><tt>Duplex</tt></td>
1085 <td>Boolean</td>
1086 <td>Specifies whether 2-sided printing is required.</td>
1087 <td><tt>&lt;&lt;/Duplex true&gt;&gt;setpagedevice</tt></td>
1088</tr>
1089<tr valign='top'>
1090 <td><tt>HWResolution</tt></td>
1091 <td>Integer Array</td>
1092 <td>Specifies the resolution of the page image in pixels per inch.</td>
1093 <td><tt>&lt;&lt;/HWResolution[1200 1200]&gt;&gt;setpagedevice</tt></td>
1094</tr>
1095<tr valign='top'>
1096 <td><tt>InsertSheet</tt></td>
1097 <td>Boolean</td>
1098 <td>Specifies whether to insert a blank sheet before the job.</td>
1099 <td><tt>&lt;&lt;/InsertSheet true&gt;&gt;setpagedevice</tt></td>
1100</tr>
1101<tr valign='top'>
1102 <td><tt>Jog</tt></td>
1103 <td>Integer</td>
1104 <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>
1105 <td><tt>&lt;&lt;/Jog 2&gt;&gt;setpagedevice</tt></td>
1106</tr>
1107<tr valign='top'>
1108 <td><tt>LeadingEdge</tt></td>
1109 <td>Integer</td>
1110 <td>Specifies the leading edge of the media: 0 = top, 1 = right, 2 = bottom, 3 = left.</td>
1111 <td><tt>&lt;&lt;/LeadingEdge 0&gt;&gt;setpagedevice</tt></td>
1112</tr>
1113<tr valign='top'>
1114 <td><tt>ManualFeed</tt></td>
1115 <td>Boolean</td>
1116 <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>
1117 <td><tt>&lt;&lt;/ManualFeed true&gt;&gt;setpagedevice</tt></td>
1118</tr>
1119<tr valign='top'>
1120 <td><tt>MediaClass</tt></td>
1121 <td>String</td>
1122 <td>Specifies a named media.</td>
1123 <td><tt>&lt;&lt;/MediaClass (Invoices)&gt;&gt;setpagedevice</tt></td>
1124</tr>
1125<tr valign='top'>
1126 <td><tt>MediaColor</tt></td>
1127 <td>String</td>
1128 <td>Specifies the color of the media.</td>
1129 <td><tt>&lt;&lt;/MediaColor &gt;&gt;setpagedevice</tt></td>
1130</tr>
1131<tr valign='top'>
1132 <td><tt>MediaPosition</tt></td>
1133 <td>Integer</td>
1134 <td>Specifies the tray or source of the media.</td>
1135 <td><tt>&lt;&lt;/MediaPosition 12&gt;&gt;setpagedevice</tt></td>
1136</tr>
1137<tr valign='top'>
1138 <td><tt>MediaType</tt></td>
1139 <td>String</td>
1140 <td>Specifies the general media type.</td>
1141 <td><tt>&lt;&lt;/MediaType (Glossy)&gt;&gt;setpagedevice</tt></td>
1142</tr>
1143<tr valign='top'>
1144 <td><tt>MediaWeight</tt></td>
1145 <td>Integer</td>
1146 <td>Specifies the media weight in grams per meter<sup>2</sup>.</td>
1147 <td><tt>&lt;&lt;/MediaWeight 100&gt;&gt;setpagedevice</tt></td>
1148</tr>
1149<tr valign='top'>
1150 <td><tt>MirrorPrint</tt></td>
1151 <td>Boolean</td>
1152 <td>Specifies whether to flip the output image horizontally.</td>
1153 <td><tt>&lt;&lt;/MirrorPrint true&gt;&gt;setpagedevice</tt></td>
1154</tr>
1155<tr valign='top'>
1156 <td><tt>NegativePrint</tt></td>
1157 <td>Boolean</td>
1158 <td>Specifies whether to invert the output image.</td>
1159 <td><tt>&lt;&lt;/NegativePrint true&gt;&gt;setpagedevice</tt></td>
1160</tr>
1161<tr valign='top'>
1162 <td><tt>NumCopies</tt></td>
1163 <td>Integer</td>
1164 <td>Specifies the number of copies to produce of each page.</td>
1165 <td><tt>&lt;&lt;/NumCopies 100&gt;&gt;setpagedevice</tt></td>
1166</tr>
1167<tr valign='top'>
1168 <td><tt>Orientation</tt></td>
1169 <td>Integer</td>
1170 <td>Specifies the orientation of the output: 0 = portrait, 1 = landscape rotated counter-clockwise, 2 = upside-down, 3 = landscape rotated clockwise.</td>
1171 <td><tt>&lt;&lt;/Orientation 3&gt;&gt;setpagedevice</tt></td>
1172</tr>
1173<tr valign='top'>
1174 <td><tt>OutputFaceUp</tt></td>
1175 <td>Boolean</td>
1176 <td>Specifies whether to place the media face-up in the output bin/tray.</td>
1177 <td><tt>&lt;&lt;/OutputFaceUp true&gt;&gt;setpagedevice</tt></td>
1178</tr>
1179<tr valign='top'>
1180 <td><tt>OutputType</tt></td>
1181 <td>String</td>
1182 <td>Specifies the output type name.</td>
1183 <td><tt>&lt;&lt;/OutputType (Photo)&gt;&gt;setpagedevice</tt></td>
1184</tr>
1185<tr valign='top'>
1186 <td><tt>PageSize</tt></td>
1187 <td>Integer/Real Array</td>
1188 <td>Specifies the width and length/height of the page in points.</td>
1189 <td><tt>&lt;&lt;/PageSize[595 842]&gt;&gt;setpagedevice</tt></td>
1190</tr>
1191<tr valign='top'>
1192 <td><tt>Separations</tt></td>
1193 <td>Boolean</td>
1194 <td>Specifies whether to produce color separations.</td>
1195 <td><tt>&lt;&lt;/Separations true&gt;&gt;setpagedevice</tt></td>
1196</tr>
1197<tr valign='top'>
1198 <td><tt>TraySwitch</tt></td>
1199 <td>Boolean</td>
1200 <td>Specifies whether to switch trays automatically.</td>
1201 <td><tt>&lt;&lt;/TraySwitch true&gt;&gt;setpagedevice</tt></td>
1202</tr>
1203<tr valign='top'>
1204 <td><tt>Tumble</tt></td>
1205 <td>Boolean</td>
1206 <td>Specifies whether the back sides of pages are rotated 180 degrees.</td>
1207 <td><tt>&lt;&lt;/Tumble true&gt;&gt;setpagedevice</tt></td>
1208</tr>
1209<tr valign='top'>
1210 <td><tt>cupsBorderlessScalingFactor</tt></td>
1211 <td>Real</td>
1212 <td>Specifies the amount to scale the page image dimensions.</td>
1213 <td><tt>&lt;&lt;/cupsBorderlessScalingFactor 1.01&gt;&gt;setpagedevice</tt></td>
1214</tr>
1215<tr valign='top'>
1216 <td><tt>cupsColorOrder</tt></td>
1217 <td>Integer</td>
1218 <td>Specifies the order of colors: 0 = chunked, 1 = banded, 2 = planar.</td>
1219 <td><tt>&lt;&lt;/cupsColorOrder 0&gt;&gt;setpagedevice</tt></td>
1220</tr>
1221<tr valign='top'>
1222 <td><tt>cupsColorSpace</tt></td>
1223 <td>Integer</td>
1224 <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>
7dfedb92 1225 <td><tt>&lt;&lt;/cupsColorSpace 1 &gt;&gt;setpagedevice</tt></td>
b86bc4cf 1226</tr>
1227<tr valign='top'>
1228 <td><tt>cupsCompression</tt></td>
1229 <td>Integer</td>
1230 <td>Specifies a driver compression type/mode.</td>
1231 <td><tt>&lt;&lt;/cupsCompression 2&gt;&gt;setpagedevice</tt></td>
1232</tr>
1233<tr valign='top'>
1234 <td><tt>cupsInteger0<br>
1235 ...<br>
1236 cupsInteger15</tt></td>
1237 <td>Integer</td>
1238 <td>Specifies driver integer values.</td>
1239 <td><tt>&lt;&lt;/cupsInteger11 1234&gt;&gt;setpagedevice</tt></td>
1240</tr>
1241<tr valign='top'>
1242 <td><tt>cupsMarkerType</tt></td>
1243 <td>String</td>
1244 <td>Specifies the type of ink/toner to use.</td>
1245 <td><tt>&lt;&lt;/cupsMarkerType (Black+Color)&gt;&gt;setpagedevice</tt></td>
1246</tr>
1247<tr valign='top'>
1248 <td><tt>cupsMediaType</tt></td>
1249 <td>Integer</td>
1250 <td>Specifies a numeric media type.</td>
1251 <td><tt>&lt;&lt;/cupsMediaType 999&gt;&gt;setpagedevice</tt></td>
1252</tr>
1253<tr valign='top'>
1254 <td><tt>cupsPageSizeName</tt></td>
1255 <td>String</td>
1256 <td>Specifies the name of the page size.</td>
1257 <td><tt>&lt;&lt;/cupsPageSizeName (A4.Full)&gt;&gt;setpagedevice</tt></td>
1258</tr>
1259<tr valign='top'>
1260 <td><tt>cupsPreferredBitsPerColor</tt></td>
1261 <td>Integer</td>
1262 <td>Specifies the preferred number of bits per color, typically 8 or 16.</td>
1263 <td><tt>&lt;&lt;/cupsPreferredBitsPerColor 16&gt;&gt;setpagedevice</tt></td>
1264</tr>
1265<tr valign='top'>
1266 <td><tt>cupsReal0<br>
1267 ...<br>
1268 cupsReal15</tt></td>
1269 <td>Real</td>
1270 <td>Specifies driver real number values.</td>
1271 <td><tt>&lt;&lt;/cupsReal15 1.234&gt;&gt;setpagedevice</tt></td>
1272</tr>
1273<tr valign='top'>
1274 <td><tt>cupsRenderingIntent</tt></td>
1275 <td>String</td>
1276 <td>Specifies the color rendering intent.</td>
1277 <td><tt>&lt;&lt;/cupsRenderingIntent (AbsoluteColorimetric)&gt;&gt;setpagedevice</tt></td>
1278</tr>
1279<tr valign='top'>
1280 <td><tt>cupsRowCount</tt></td>
1281 <td>Integer</td>
1282 <td>Specifies the number of rows of raster data to print on each line for some drivers.</td>
1283 <td><tt>&lt;&lt;/cupsRowCount 24&gt;&gt;setpagedevice</tt></td>
1284</tr>
1285<tr valign='top'>
1286 <td><tt>cupsRowFeed</tt></td>
1287 <td>Integer</td>
1288 <td>Specifies the number of rows to feed between passes for some drivers.</td>
1289 <td><tt>&lt;&lt;/cupsRowFeed 17&gt;&gt;setpagedevice</tt></td>
1290</tr>
1291<tr valign='top'>
1292 <td><tt>cupsRowStep</tt></td>
1293 <td>Integer</td>
1294 <td>Specifies the number of lines between columns/rows on the print head for some drivers.</td>
1295 <td><tt>&lt;&lt;/cupsRowStep 2&gt;&gt;setpagedevice</tt></td>
1296</tr>
1297<tr valign='top'>
1298 <td><tt>cupsString0<br>
1299 ...<br>
1300 cupsString15</tt></td>
1301 <td>String</td>
1302 <td>Specifies driver string values.</td>
1303 <td><tt>&lt;&lt;/cupsString0(String Value)&gt;&gt;setpagedevice</tt></td>
1304</tr>
1305</tbody>
1306</table></div>
1307
1308
10d09e33 1309<h2 class='title'><a name='MEDIA'>Media Keywords</a></h2>
749b1e90 1310
10d09e33 1311<p>The CUPS media keywords allow drivers to specify alternate custom page
749b1e90
MS		 1312size limits based on up to two options.</p>
1313
b0f6947b 1314<h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMediaQualifier2'>cupsMediaQualifier2</a></h3>
749b1e90
MS		 1315
1316<p class='summary'>*cupsMediaQualifier2: MainKeyword</p>
1317
10d09e33 1318<p>This keyword specifies the second option to use for overriding the
749b1e90
MS		 1319custom page size limits.</p>
1320
1321<p>Example:</p>
1322
1323<pre class='command'>
1324<em>*% Specify alternate custom page size limits based on InputSlot and Quality</em>
1325*cupsMediaQualifier2: InputSlot
1326*cupsMediaQualifier3: Quality
1327*cupsMaxSize .Manual.: "1000 1000"
1328*cupsMinSize .Manual.: "100 100"
1329*cupsMinSize .Manual.Photo: "200 200"
1330*cupsMinSize ..Photo: "300 300"
1331</pre>
1332
b0f6947b 1333<h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMediaQualifier3'>cupsMediaQualifier3</a></h3>
749b1e90
MS		 1334
1335<p class='summary'>*cupsMediaQualifier3: MainKeyword</p>
1336
10d09e33 1337<p>This keyword specifies the third option to use for overriding the
749b1e90
MS		 1338custom page size limits.</p>
1339
1340<p>Example:</p>
1341
1342<pre class='command'>
1343<em>*% Specify alternate custom page size limits based on InputSlot and Quality</em>
1344*cupsMediaQualifier2: InputSlot
1345*cupsMediaQualifier3: Quality
1346*cupsMaxSize .Manual.: "1000 1000"
1347*cupsMinSize .Manual.: "100 100"
1348*cupsMinSize .Manual.Photo: "200 200"
1349*cupsMinSize ..Photo: "300 300"
1350</pre>
1351
b0f6947b 1352<h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMinSize'>cupsMinSize</a></h3>
749b1e90
MS		 1353
1354<p class='summary'>*cupsMinSize .Qualifier2.Qualifier3: "width length"<br>
1355*cupsMinSize .Qualifier2.: "width length"<br>
1356*cupsMinSize ..Qualifier3: "width length"</p>
1357
10d09e33 1358<p>This keyword specifies alternate minimum custom page sizes in points.
749b1e90 1359The <a href='#cupsMediaQualifier2'><tt>cupsMediaQualifier2</tt></a> and
10d09e33 1360<a href='#cupsMediaQualifier3'><tt>cupsMediaQualifier3</tt></a> keywords
749b1e90
MS		 1361are used to identify options to use for matching.</p>
1362
1363<p>Example:</p>
1364
1365<pre class='command'>
1366<em>*% Specify alternate custom page size limits based on InputSlot and Quality</em>
1367*cupsMediaQualifier2: InputSlot
1368*cupsMediaQualifier3: Quality
1369*cupsMaxSize .Manual.: "1000 1000"
1370*cupsMinSize .Manual.: "100 100"
1371*cupsMinSize .Manual.Photo: "200 200"
1372*cupsMinSize ..Photo: "300 300"
1373</pre>
1374
b0f6947b 1375<h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMaxSize'>cupsMaxSize</a></h3>
749b1e90
MS		 1376
1377<p class='summary'>*cupsMaxSize .Qualifier2.Qualifier3: "width length"<br>
1378*cupsMaxSize .Qualifier2.: "width length"<br>
1379*cupsMaxSize ..Qualifier3: "width length"</p>
1380
10d09e33 1381<p>This keyword specifies alternate maximum custom page sizes in points.
749b1e90 1382The <a href='#cupsMediaQualifier2'><tt>cupsMediaQualifier2</tt></a> and
10d09e33 1383<a href='#cupsMediaQualifier3'><tt>cupsMediaQualifier3</tt></a> keywords
749b1e90
MS		 1384are used to identify options to use for matching.</p>
1385
1386<p>Example:</p>
1387
1388<pre class='command'>
1389<em>*% Specify alternate custom page size limits based on InputSlot and Quality</em>
1390*cupsMediaQualifier2: InputSlot
1391*cupsMediaQualifier3: Quality
1392*cupsMaxSize .Manual.: "1000 1000"
1393*cupsMinSize .Manual.: "100 100"
1394*cupsMinSize .Manual.Photo: "200 200"
1395*cupsMinSize ..Photo: "300 300"
1396</pre>
1397
1398
db1f069b
MS		 1399<h2 class='title'><a name='ATTRIBUTES'>General Attributes</a></h2>
1400
b0f6947b 1401<h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsBackSide'>cupsBackSide</a></h3>
db1f069b
MS		 1402
1403<p class='summary'>*cupsBackSide: keyword</p>
1404
10d09e33 1405<p>This keyword requests special handling of the back side of pages
db1f069b 1406when doing duplexed (2-sided) output. <a href='#TABLE_1'>Table 1</a>
10d09e33 1407shows the supported keyword values for this keyword and their effect
db1f069b
MS		 1408on the raster data sent to your driver. For example, when <tt>cupsBackSide</tt>
1409is <code>Rotated</code> and <tt>Tumble</tt> is <tt>false</tt>, your driver
1410will receive print data starting at the bottom right corner of the page, with
1411each line going right-to-left instead of left-to-right. The default value is
1412<code>Normal</code>.</p>
1413
1414<blockquote><b>Note:</b>
1415
1416<p><tt>cupsBackSide</tt> replaces the older <tt>cupsFlipDuplex</tt>
10d09e33 1417keyword - if <tt>cupsBackSide</tt> is specified, <tt>cupsFlipDuplex</tt>
db1f069b
MS		 1418will be ignored.</p>
1419
1420</blockquote>
1421
1422<div class='table'>
1423<table width='80%' summary='Back Side Raster Coordinate System'>
1424<caption>Table 1: <a name='TABLE_1'>Back Side Raster Coordinate System</a></caption>
1425<thead>
1426<tr>
1427 <th>cupsBackSide</th>
1428 <th>Tumble Value</th>
1429 <th>Image Presentation</th>
1430</tr>
1431</thead>
1432<tbody>
1433<tr>
1434 <td><code>Normal</code></td>
1435 <td><code>false</code></td>
1436 <td>Left-to-right, top-to-bottom</td>
1437</tr>
1438<tr>
1439 <td><code>Normal</code></td>
1440 <td><code>true</code></td>
1441 <td>Left-to-right, top-to-bottom</td>
1442</tr>
1443<tr>
1444 <td><code>ManualTumble</code></td>
1445 <td><code>false</code></td>
1446 <td>Left-to-right, top-to-bottom</td>
1447</tr>
1448<tr>
1449 <td><code>ManualTumble</code></td>
1450 <td><code>true</code></td>
1451 <td>Right-to-left, bottom-to-top</td>
1452</tr>
1453<tr>
1454 <td><code>Rotated</code></td>
1455 <td><code>false</code></td>
1456 <td>Right-to-left, bottom-to-top</td>
1457</tr>
1458<tr>
1459 <td><code>Rotated</code></td>
1460 <td><code>true</code></td>
1461 <td>Right-to-left, top-to-bottom</td>
1462</tr>
1463<tr>
1464 <td><code>Flipped</code> *</td>
1465 <td><code>false</code></td>
1466 <td>Left-to-right, bottom-to-top</td>
1467</tr>
1468<tr>
1469 <td><code>Flipped</code> *</td>
1470 <td><code>true</code></td>
1471 <td>Right-to-left, top-to-bottom</td>
1472</tr>
1473</tbody>
1474</table>
1475</div>
1476
1477<p><em>* - Not supported in Mac OS X 10.5.x and earlier</em></p>
1478
1479<div class='figure'><table summary='Back side images'>
1480<caption>Figure 1: Back side images</caption>
1481<tr><td><img src='../images/raster.png' width='624' height='448' alt='Back side images'></td></tr>
1482</table></div>
1483
1484<p>Examples:</p>
1485
1486<pre class='command'>
1487<em>*% Flip the page image for the back side of duplexed output</em>
1488*cupsBackSide: Flipped
1489
1490<em>*% Rotate the page image for the back side of duplexed output</em>
1491*cupsBackSide: Rotated
1492</pre>
1493
1494<p>Also see the related <a href='#APDuplexRequiresFlippedMargin'><tt>APDuplexRequiresFlippedMargin</tt></a>
10d09e33 1495keyword.</p>
db1f069b 1496
b0f6947b 1497<h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsCommands'>cupsCommands</a></h3>
01ce6322
MS		 1498
1499<p class='summary'>*cupsCommands: "name name2 ... nameN"</p>
1500
10d09e33 1501<p>This string keyword specifies the commands that are supported by the
01ce6322
MS		 1502CUPS command file filter for this device. The command names are separated
1503by whitespace.</p>
1504
1505<p>Example:</p>
1506
1507<pre class='command'>
1508<em>*% Specify the list of commands we support</em>
1509*cupsCommands: "AutoConfigure Clean PrintSelfTestPage ReportLevels com.vendor.foo"
1510</pre>
1511
1512
b0f6947b 1513<h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsEvenDuplex'>cupsEvenDuplex</a></h3>
db1f069b
MS		 1514
1515<p class='summary'>*cupsEvenDuplex: boolean</p>
1516
10d09e33 1517<p>This boolean keyword notifies the RIP filters that the
db1f069b
MS		 1518destination printer requires an even number of pages when 2-sided
1519printing is selected. The default value is <code>false</code>.</p>
1520
1521<p>Example:</p>
1522
1523<pre class='command'>
1524<em>*% Always send an even number of pages when duplexing</em>
1525*cupsEvenDuplex: true
1526</pre>
1527
1528<h3><a name='cupsFax'>cupsFax</a></h3>
1529
1530<p class='summary'>*cupsFax: boolean</p>
1531
10d09e33 1532<p>This boolean keyword specifies whether the PPD defines a facsimile device. The default is <tt>false</tt>.</p>
db1f069b
MS		 1533
1534<p>Examples:</p>
1535
1536<pre class='command'>
1537*cupsFax: true
1538</pre>
1539
1540<h3><a name='cupsFilter'>cupsFilter</a></h3>
1541
1542<p class='summary'>*cupsFilter: "source/type cost program"</p>
1543
10d09e33 1544<p>This string keyword provides a conversion rule from the
db1f069b
MS		 1545given source type to the printer's native format using the
1546filter "program". If a printer supports the source type directly,
1547the special filter program "-" may be specified.</p>
1548
1549<p>Examples:</p>
1550
1551<pre class='command'>
1552<em>*% Standard raster printer driver filter</em>
1553*cupsFilter: "application/vnd.cups-raster 100 rastertofoo"
1554
1555<em>*% Plain text filter</em>
1556*cupsFilter: "text/plain 10 texttofoo"
1557
1558<em>*% Pass-through filter for PostScript printers</em>
1559*cupsFilter: "application/vnd.cups-postscript 0 -"
1560</pre>
1561
1562<h3><span class='info'>Deprecated</span><a name='cupsFlipDuplex'>cupsFlipDuplex</a></h3>
1563
1564<p class='summary'>*cupsFlipDuplex: boolean</p>
1565
1566<p>Due to implementation differences between Mac OS X and Ghostscript,
10d09e33
MS		 1567the <tt>cupsFlipDuplex</tt> keyword is deprecated. Instead, use
1568the <a href='#cupsBackSide'><tt>cupsBackSide</tt></a> keyword to specify
db1f069b
MS		 1569the coordinate system (pixel layout) of the page data on the back side of
1570duplex pages.</p>
1571
1572<p>The value <code>true</code> maps to a <tt>cupsBackSide</tt> value
1573of <code>Rotated</code> on Mac OS X and <code>Flipped</code> with
1574Ghostscript.</p>
1575
1576<p>The default value is <code>false</code>.</p>
1577
1578<blockquote><b>Note:</b>
1579
1580<p>Mac OS X drivers that previously used
1581<tt>cupsFlipDuplex</tt> may wish to provide both the old and
10d09e33 1582new keywords for maximum compatibility, for example:</p>
db1f069b
MS		 1583
1584<pre class='command'>
1585*cupsBackSide: Rotated
1586*cupsFlipDuplex: true
1587</pre>
1588
1589<p>Similarly, drivers written for other operating systems using
1590Ghostscript can use:</p>
1591
1592<pre class='command'>
1593*cupsBackSide: Flipped
1594*cupsFlipDuplex: true
1595</pre></blockquote>
1596
b0f6947b 1597<h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsIPPFinishings'>cupsIPPFinishings</a></h3>
db1f069b
MS		 1598
1599<p class='summary'>*cupsIPPFinishings number/text: "*Option Choice ..."</p>
1600
10d09e33 1601<p>This keyword defines a mapping from IPP <code>finishings</code>
db1f069b
MS		 1602values to PPD options and choices.</p>
1603
1604<p>Examples:</p>
1605
1606<pre class='command'>
1607*cupsIPPFinishings 4/staple: "*StapleLocation SinglePortrait"
1608*cupsIPPFinishings 5/punch: "*PunchMedia Yes *PunchLocation LeftSide"
1609*cupsIPPFinishings 20/staple-top-left: "*StapleLocation SinglePortrait"
1610*cupsIPPFinishings 21/staple-bottom-left: "*StapleLocation SingleLandscape"
1611</pre>
1612
b0f6947b 1613<h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsIPPReason'>cupsIPPReason</a></h3>
db1f069b
MS		 1614
1615<p class='summary'>*cupsIPPReason reason/Reason Text: "optional URIs"</p>
1616
10d09e33 1617<p>This optional keyword maps custom
db1f069b
MS		 1618<code>printer-state-reasons</code> keywords that are generated by
1619the driver to human readable text. The optional URIs string
1620contains zero or more URIs separated by a newline. Each URI can
1621be a CUPS server absolute path to a help file under the
1622scheduler's <code>DocumentRoot</code> directory, a full HTTP URL
1623("http://www.domain.com/path/to/help/page.html"), or any other
1624valid URI which directs the user at additional information
1625concerning the condition that is being reported.</p>
1626
1627<p>Since the reason text is limited to 80 characters by the PPD specification,
1628longer text strings can be included by URI-encoding the text with the "text"
1629scheme, for example "text:some%20text". Multiple <code>text</code> URIs are
1630combined (with spaces between each URI) by the <tt>ppdLocalizeIPPReason</tt>
1631into a single string that can be displayed to the user.</p>
1632
1633<p>Examples:</p>
1634
1635<pre class='command'>
1636<em>*% Map com.vendor-error to text but no page</em>
1637*cupsIPPReason com.vendor-error/A serious error occurred: ""
1638
1639<em>*% Map com.vendor-error to more than 80 characters of text but no page</em>
1640*cupsIPPReason com.vendor-error/A serious error occurred: "text:Now%20is%20the%20time
1641text:for%20all%20good%20men%20to%20come%20to%20the%20aid%20of%20their%20country."
1642
1643<em>*% Map com.vendor-error to text and a local page</em>
1644*cupsIPPReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html"
1645
1646<em>*% Map com.vendor-error to text and a remote page</em>
1647*cupsIPPReason com.vendor-error/A serious error occurred: "http://www.vendor.com/help"
1648
1649<em>*% Map com.vendor-error to text and a local, Apple help book, and remote page</em>
839a51c8 1650*APHelpBook: "file:///Library/Printers/vendor/Help.bundle"
db1f069b
MS		 1651*cupsIPPReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html
1652help:anchor='com.vendor-error'%20bookID=Vendor%20Help
1653http://www.vendor.com/help"
1654*End
1655</pre>
1656
b0f6947b 1657<h3><span class='info'>CUPS 1.2/Mac OS X 10.5</span><a name='cupsLanguages'>cupsLanguages</a></h3>
db1f069b
MS		 1658
1659<p class='summary'>*cupsLanguages: "locale list"</p>
1660
10d09e33 1661<p>This keyword describes which language localizations are
db1f069b
MS		 1662included in the PPD. The "locale list" string is a space-delimited
1663list of locale names ("en", "en_US", "fr_CA", etc.)</p>
1664
1665<p>Example:</p>
1666
1667<pre class='command'>
1668<em>*% Specify Canadian, UK, and US English, and Candian and French French</em>
5a738aea 1669*cupsLanguages: "en_CA en_UK en_US fr_CA fr_FR"
db1f069b
MS		 1670</pre>
1671
1672<h3><a name='cupsManualCopies'>cupsManualCopies</a></h3>
1673
1674<p class='summary'>*cupsManualCopies: boolean</p>
1675
10d09e33 1676<p>This boolean keyword notifies the RIP filters that the
db1f069b
MS		 1677destination printer does not support copy generation in
1678hardware. The default value is <code>false</code>.</p>
1679
1680<p>Example:</p>
1681
1682<pre class='command'>
1683<em>*% Tell the RIP filters to generate the copies for us</em>
1684*cupsManualCopies: true
1685</pre>
1686
b0f6947b 1687<h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMarkerName'>cupsMarkerName</a></h3>
634763e8
MS		 1688
1689<p class='summary'>*cupsMarkerName/Name Text: ""</p>
1690
10d09e33 1691<p>This optional keyword maps <code>marker-names</code> strings that are
634763e8
MS		 1692generated by the driver to human readable text.</p>
1693
1694<p>Examples:</p>
1695
1696<pre class='command'>
1697<em>*% Map cyanToner to "Cyan Toner"</em>
1698*cupsMarkerName cyanToner/Cyan Toner: ""
1699</pre>
1700
b0f6947b 1701<h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMarkerNotice'>cupsMarkerNotice</a></h3>
75bd9771
MS		 1702
1703<p class='summary'>*cupsMarkerNotice: "disclaimer text"</p>
1704
10d09e33 1705<p>This optional keyword provides disclaimer text for the supply level
75bd9771
MS		 1706information provided by the driver, typically something like "supply levels
1707are approximate".</p>
1708
1709<p>Examples:</p>
1710
1711<pre class='command'>
1712*cupsMarkerNotice: "Supply levels are approximate."
1713</pre>
1714
db1f069b
MS		 1715<h3><a name='cupsModelNumber'>cupsModelNumber</a></h3>
1716
1717<p class='summary'>*cupsModelNumber: number</p>
1718
10d09e33 1719<p>This integer keyword specifies a printer-specific model
db1f069b
MS		 1720number. This number can be used by a filter program to adjust
1721the output for a specific model of printer.</p>
1722
1723<p>Example:</p>
1724
1725<pre class='command'>
1726<em>*% Specify an integer for a driver-specific model number</em>
1727*cupsModelNumber: 1234
1728</pre>
1729
b0f6947b 1730<h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsPJLCharset'>cupsPJLCharset</a></h3>
db1f069b
MS		 1731
1732<p class='summary'>*cupsPJLCharset: "ISO character set name"</p>
1733
10d09e33 1734<p>This string keyword specifies the character set that is used
db1f069b
MS		 1735for strings in PJL commands. If not specified, US-ASCII is
1736assumed.</p>
1737
1738<p>Example:</p>
1739
1740<pre class='command'>
1741<em>*% Specify UTF-8 is used in PJL strings</em>
1742*cupsPJLCharset: "UTF-8"
1743</pre>
1744
b0f6947b 1745<h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsPJLDisplay'>cupsPJLDisplay</a></h3>
634763e8
MS		 1746
1747<p class='summary'>*cupsPJLDisplay: "what"</p>
1748
10d09e33 1749<p>This optional keyword specifies which command is used to display the
634763e8
MS		 1750job ID, name, and user on the printer's control panel. "What" is either "none"
1751to disable this functionality, "job" to use "@PJL JOB DISPLAY", or "rdymsg"
1752to use "@PJL RDYMSG DISPLAY". The default is "job".</p>
1753
1754<p>Examples:</p>
1755
1756<pre class='command'>
1757<em>*% Display job information using @PJL SET RDYMSG DISPLAY="foo"</em>
1758*cupsPJLDisplay: "rdymsg"
1759
1760<em>*% Display job information display</em>
1761*cupsPJLDisplay: "none"
1762</pre>
db1f069b 1763
b0f6947b 1764<h3><span class='info'>CUPS 1.2/Mac OS X 10.5</span><a name='cupsPortMonitor'>cupsPortMonitor</a></h3>
db1f069b
MS		 1765
1766<p class='summary'>*cupsPortMonitor urischeme/Descriptive Text: "port monitor"</p>
1767
10d09e33 1768<p>This string keyword specifies printer-specific "port
db1f069b 1769monitor" filters that may be used with the printer. The CUPS
10d09e33 1770scheduler also looks for the <tt>Protocols</tt> keyword to see
db1f069b
MS		 1771if the <tt>BCP</tt> or <tt>TBCP</tt> protocols are supported. If
1772so, the corresponding port monitor ("bcp" and "tbcp",
1773respectively) is listed in the printer's
10d09e33 1774<tt>port-monitor-supported</tt> keyword.</p>
db1f069b 1775
10d09e33 1776<p>The "urischeme" portion of the keyword specifies the URI scheme
db1f069b
MS		 1777that this port monitor should be used for. Typically this is used to
1778pre-select a particular port monitor for each type of connection that
1779is supported by the printer. The "port monitor" string can be "none"
1780to disable the port monitor for the given URI scheme.</p>
1781
1782<p>Examples:</p>
1783
1784<pre class='command'>
1785<em>*% Specify a PostScript printer that supports the TBCP protocol</em>
1786*Protocols: TBCP PJL
1787
1788<em>*% Specify that TBCP should be used for socket connections but not USB</em>
1789*cupsPortMonitor socket/AppSocket Printing: "tbcp"
1790*cupsPortMonitor usb/USB Printing: "none"
1791
1792<em>*% Specify a printer-specific port monitor for an Epson USB printer</em>
1793*cupsPortMonitor usb/USB Status Monitor: "epson-usb"
1794</pre>
1795
b0f6947b 1796<h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsPreFilter'>cupsPreFilter</a></h3>
db1f069b
MS		 1797
1798<p class='summary'>*cupsPreFilter: "source/type cost program"</p>
1799
10d09e33 1800<p>This string keyword provides a pre-filter rule. The pre-filter
db1f069b
MS		 1801program will be inserted in the conversion chain immediately
1802before the filter that accepts the given MIME type.</p>
1803
1804<p>Examples:</p>
1805
1806<pre class='command'>
1807<em>*% PDF pre-filter</em>
1808*cupsPreFilter: "application/pdf 100 mypdfprefilter"
1809
1810<em>*% PNG pre-filter</em>
1811*cupsPreFilter: "image/png 0 mypngprefilter"
1812</pre>
1813
c7017ecc
MS		 1814
1815<h3><span class='info'>CUPS 1.5</span><a name='cupsPrintQuality'>cupsPrintQuality</a></h3>
1816
1817<p class='summary'>*cupsPrintQuality keyword/text: "code"</p>
1818
10d09e33 1819<p>This UI keyword defines standard print qualities that directly map from the IPP "print-quality" job template keyword. Standard keyword values are "Draft", "Normal", and "High" which are mapped from the IPP "print-quality" values 3, 4, and 5 respectively. Each <code>cupsPrintQuality</code> option typically sets output mode and resolution parameters in the page device dictionary, eliminating the need for separate (and sometimes confusing) output mode and resolution options.</p>
c7017ecc
MS		 1820
1821<blockquote><b>Note:</b>
1822
1823<p>Unlike all of the other keywords defined in this document, <code>cupsPrintQuality</code> is a UI keyword that MUST be enclosed inside the PPD <code>OpenUI</code> and <code>CloseUI</code> keywords.</p>
1824
1825</blockquote>
1826
1827<p>Examples:</p>
1828
1829<pre class='command'>
1830*OpenUI *cupsPrintQuality/Print Quality: PickOne
1831*OrderDependency: 10 AnySetup *cupsPrintQuality
1832*DefaultcupsPrintQuality: Normal
1833*cupsPrintQuality Draft/Draft: "code"
1834*cupsPrintQuality Normal/Normal: "code"
1835*cupsPrintQuality High/Photo: "code"
1836*CloseUI: *cupsPrintQuality
1837</pre>
1838
b0f6947b 1839<h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsSNMPSupplies'>cupsSNMPSupplies</a></h3>
58dc1933
MS		 1840
1841<p class='summary'>*cupsSNMPSupplies: boolean</p>
1842
10d09e33 1843<p>This keyword tells the standard network backends whether they should query
58dc1933
MS		 1844the standard SNMP Printer MIB OIDs for supply levels. The default value is
1845<code>True</code>.
1846
1847<p>Example:</p>
1848
1849<pre class='command'>
1850<em>*% Do not use SNMP queries to report supply levels</em>
1851*cupsSNMPSupplies: False
1852</pre>
1853
db1f069b
MS		 1854<h3><a name='cupsVersion'>cupsVersion</a></h3>
1855
1856<p class='summary'>*cupsVersion: major.minor</p>
1857
10d09e33 1858<p>This required keyword describes which version of the CUPS
db1f069b
MS		 1859PPD file extensions was used. Currently it must be the string
1860"1.0", "1.1", "1.2", or "1.3".</p>
1861
1862<p>Example:</p>
1863
1864<pre class='command'>
1865<em>*% Specify a CUPS 1.2 driver</em>
1866*cupsVersion: "1.2"
1867</pre>
1868
1869
1870<h2 class='title'><a name='MACOSX'>Mac OS X Attributes</a></h2>
1871
db1f069b
MS		 1872<h3><span class='info'>Mac OS X 10.3</span><a name='APDialogExtension'>APDialogExtension</a></h3>
1873
1874<p class='summary'>*APDialogExtension: "/Library/Printers/vendor/filename.plugin"</p>
1875
10d09e33
MS		 1876<p>This keyword defines additional option panes that are displayed in the
1877print dialog. Each keyword adds one or more option panes. See the "OutputBinsPDE"
db1f069b
MS		 1878example and <a href='http://developer.apple.com/qa/qa2004/qa1352.html'>Apple
1879Technical Q&amp;A QA1352</a> for information on writing your own print dialog
1880plug-ins.</p>
1881
1882<blockquote><b>Note:</b>
1883
1884<p>Starting with Mac OS X 10.5, each plug-in must be compiled "4-way fat"
1885(32-bit and 64-bit for both PowerPC and Intel) with garbage collection enabled
1886in order to be usable with all applications.</p>
1887
1888</blockquote>
1889
1890<p>Examples:</p>
1891
1892<pre class='command'>
1893*% Add two panes for finishing and driver options
1894*APDialogExtension: "/Library/Printers/vendor/finishing.plugin"
1895*APDialogExtension: "/Library/Printers/vendor/options.plugin"
1896</pre>
1897
1898<h3><span class='info'>Mac OS X 10.4</span><a name='APDuplexRequiresFlippedMargin'>APDuplexRequiresFlippedMargin</a></h3>
1899
1900<p class='summary'>*APDuplexRequiresFlippedMargin: boolean</p>
1901
10d09e33 1902<p>This boolean keyword notifies the RIP filters that the
db1f069b
MS		 1903destination printer requires the top and bottom margins of the
1904<tt>ImageableArea</tt> to be swapped for the back page. The
1905default is <tt>true</tt> when <tt>cupsBackSide</tt> is <tt>Flipped</tt>
1906and <tt>false</tt> otherwise. <a href='#TABLE_2'>Table 2</a> shows how
1907<tt>APDuplexRequiresFlippedMargin</tt> interacts with <tt>cupsBackSide</tt>
1908and the <tt>Tumble</tt> page attribute.</p>
1909
1910<div class='table'>
1911<table width='80%' summary='Margin Flipping Modes'>
1912<caption>Table 2: <a name='TABLE_2'>Margin Flipping Modes</a></caption>
1913<thead>
1914<tr>
1915 <th>APDuplexRequiresFlippedMargin</th>
1916 <th>cupsBackSide</th>
1917 <th>Tumble Value</th>
1918 <th>Margins</th>
1919</tr>
1920</thead>
1921<tbody>
1922<tr>
1923 <td>false</td>
1924 <td>any</td>
1925 <td>any</td>
1926 <td>Normal</td>
1927</tr>
1928<tr>
1929 <td>any</td>
1930 <td>Normal</td>
1931 <td>any</td>
1932 <td>Normal</td>
1933</tr>
1934<tr>
1935 <td>true</td>
1936 <td>ManualDuplex</td>
1937 <td>false</td>
1938 <td>Normal</td>
1939</tr>
1940<tr>
1941 <td>true</td>
1942 <td>ManualDuplex</td>
1943 <td>true</td>
1944 <td>Flipped</td>
1945</tr>
1946<tr>
1947 <td>true</td>
1948 <td>Rotated</td>
1949 <td>false</td>
1950 <td>Flipped</td>
1951</tr>
1952<tr>
1953 <td>true</td>
1954 <td>Rotated</td>
1955 <td>true</td>
1956 <td>Normal</td>
1957</tr>
1958<tr>
1959 <td>true or unspecified</td>
1960 <td>Flipped</td>
1961 <td>any</td>
1962 <td>Flipped</td>
1963</tr>
1964</tbody>
1965</table></div>
1966
1967<p>Example:</p>
1968
1969<pre class='command'>
1970<em>*% Rotate the back side images</em>
1971*cupsBackSide: Rotated
1972
1973<em>*% Don't swap the top and bottom margins for the back side</em>
1974*APDuplexRequiresFlippedMargin: false
1975</pre>
1976
1977<p>Also see the related <a href='#cupsBackSide'><tt>cupsBackSide</tt></a>
10d09e33 1978keyword.</p>
db1f069b 1979
64a69576
MS		 1980<h3><a name='APHelpBook'>APHelpBook</a></h3>
1981
839a51c8 1982<p class='summary'>*APHelpBook: "bundle URL"</p>
64a69576 1983
10d09e33 1984<p>This string keyword specifies the Apple help book bundle to use when
64a69576 1985looking up IPP reason codes for this printer driver. The
10d09e33 1986<a href='#cupsIPPReason'><tt>cupsIPPReason</tt></a> keyword maps
64a69576
MS		 1987"help" URIs to this file.</p>
1988
1989<p>Example:</p>
1990
1991<pre class='command'>
839a51c8 1992*APHelpBook: "file:///Library/Printers/vendor/Help.bundle"
64a69576
MS		 1993</pre>
1994
c5571a1d
MS		 1995<h3><span class='info'>Mac OS X 10.6</span><a name='APICADriver'>APICADriver</a></h3>
1996
1997<p class='summary'>*APICADriver: boolean</p>
1998
10d09e33 1999<p>This keyword specifies whether the device has a matching Image Capture
c5571a1d
MS		 2000Architecture (ICA) driver for scanning. The default is <tt>False</tt>.</p>
2001
2002<p>Examples:</p>
2003
2004<pre class='command'>
2005*APICADriver: True
2006*APScanAppBundleID: "com.apple.ImageCaptureApp"
2007</pre>
2008
db1f069b
MS		 2009<h3><span class='info'>Mac OS X 10.3</span><a name='APPrinterIconPath'>APPrinterIconPath</a></h3>
2010
e4572d57 2011<p class='summary'>*APPrinterIconPath: "/Library/Printers/vendor/filename.icns"</p>
db1f069b 2012
10d09e33 2013<p>This keyword defines the location of a printer icon file to use when
e4572d57 2014displaying the printer. The file must be in the Apple icon format.</p>
db1f069b
MS		 2015
2016<p>Examples:</p>
2017
2018<pre class='command'>
2019*% Apple icon file
2020*APPrinterIconPath: "/Library/Printers/vendor/Icons/filename.icns"
db1f069b
MS		 2021</pre>
2022
2023<h3><span class='info'>Mac OS X 10.4</span><a name='APPrinterLowInkTool'>APPrinterLowInkTool</a></h3>
2024
2025<p class='summary'>*APPrinterLowInkTool: "/Library/Printers/vendor/program"</p>
2026
10d09e33 2027<p>This keyword defines an program that checks the ink/toner/marker levels
db1f069b
MS		 2028on a printer, returning an XML document with those levels. See the "InkTool"
2029example and
2030<a href='http://developer.apple.com/technotes/tn2005/tn2144.html'>Apple
2031Technical Note TN2144</a> for more information.</p>
2032
2033<p>Examples:</p>
2034
2035<pre class='command'>
2036*% Use a vendor monitoring program
2037*APPrinterLowInkTool: "/Library/Printers/vendor/Tools/lowinktool"
2038</pre>
2039
2040<h3><span class='info'>Mac OS X 10.5</span><a name='APPrinterPreset'>APPrinterPreset</a></h3>
2041
2042<p class='summary'>*APPrinterPreset name/text: "*Option Choice ..."</p>
2043
10d09e33 2044<p>This keyword defines presets for multiple options that show up
db1f069b
MS		 2045in the print dialog of applications (such as iPhoto) that set the job
2046style hint to <tt>NSPrintPhotoJobStyleHint</tt>. Each preset maps to one or
2047more pairs of PPD options and choices as well as providing key/value data for
c7017ecc 2048the application. The following standard preset names are currently defined:</p>
db1f069b
MS		 2049
2050<ul>
2051
c7017ecc
MS		 2052 <li><code>General_with_Paper_Auto-Detect</code>; Normal quality general printing with auto-detected media.</li>
2053
2054 <li><code>General_with_Paper_Auto-Detect_-_Draft</code>; Draft quality general printing with auto-detected media.</li>
2055
2056 <li><code>General_on_Plain_Paper</code>; Normal quality general printing on plain paper.</li>
2057
2058 <li><code>General_on_Plain_Paper_-_Draft</code>; Draft quality general printing on plain paper.</li>
db1f069b 2059
c7017ecc 2060 <li><code>Photo_with_Paper_Auto-Detect</code>; Normal quality photo printing with auto-detected media.</li>
db1f069b 2061
c7017ecc 2062 <li><code>Photo_with_Paper_Auto-Detect_-_Fine</code>; High quality photo printing with auto-detected media.</li>
db1f069b 2063
c7017ecc 2064 <li><code>Photo_on_Plain_Paper</code>; Normal quality photo printing on plain paper.</li>
db1f069b 2065
c7017ecc 2066 <li><code>Photo_on_Plain_Paper_-_Fine</code>; High quality photo printing on plain paper.</li>
db1f069b 2067
c7017ecc 2068 <li><code>Photo_on_Photo_Paper</code>; Normal quality photo printing on glossy photo paper.</li>
db1f069b 2069
c7017ecc 2070 <li><code>Photo_on_Photo_Paper_-_Fine</code>; High quality photo printing on glossy photo paper.</li>
db1f069b 2071
c7017ecc
MS		 2072 <li><code>Photo_on_Matte_Paper</code>; Normal quality photo printing on matte paper.</li>
2073
2074 <li><code>Photo_on_Matte_Paper_-_Fine</code>; High quality photo printing on matte paper.</li>
db1f069b
MS		 2075
2076</ul>
2077
2078<p>The value string consists of pairs of keywords, either an option name and
2079choice (*MainKeyword OptionKeyword) or a preset identifier and value
c7017ecc
MS		 2080(com.apple.print.preset.foo value). The following preset identifiers are currently used:</p>
2081
2082<ul>
2083
2084 <li><code>com.apple.print.preset.graphicsType</code>; specifies the type of printing used for this printing - "General" for general purpose printing and "Photo" for photo printing.</li>
2085
2086 <li><code>com.apple.print.preset.media-front-coating</code>; specifies the media type selected by this preset - "none" (plain paper), "glossy", "high-gloss", "semi-gloss", "satin", "matte", and "autodetect".</li>
2087
2088 <li><code>com.apple.print.preset.output-mode</code>; specifies the output mode for this preset - "color" (default for color printers) or "monochrome" (grayscale, default for B&amp;W printers).</li>
2089
2090 <li><code>com.apple.print.preset.quality</code>; specifies the overall print quality selected by this preset - "low" (draft), "mid" (normal), or "high".</li>
2091
2092</ul>
db1f069b
MS		 2093
2094<p>Presets, like options, can also be localized in multiple languages.</p>
2095
2096<p>Examples:</p>
2097
2098<pre class='command'>
2099*APPrinterPreset Photo_on_Photo_Paper/Photo on Photo Paper: "
2100 *MediaType Glossy
2101 *ColorModel RGB
2102 *Resolution 300dpi
2103 com.apple.print.preset.graphicsType Photo
2104 com.apple.print.preset.quality mid
2105 com.apple.print.preset.media-front-coating glossy"
2106*End
2107*fr.APPrinterPreset Photo_on_Photo_Paper/Photo sur papier photographique: ""
2108</pre>
2109
2110<h3><span class='info'>Mac OS X 10.3</span><a name='APPrinterUtilityPath'>APPrinterUtilityPath</a></h3>
2111
2112<p class='summary'>*APPrinterPrinterUtilityPath: "/Library/Printers/vendor/filename.app"</p>
2113
10d09e33 2114<p>This keyword defines a GUI application that can be used to do printer
db1f069b
MS		 2115maintenance functions such as cleaning the print head(s). See ... for more
2116information.</p>
2117
2118<p>Examples:</p>
2119
2120<pre class='command'>
2121*% Define the printer utility application
2122*APPrinterPrinterUtilityPath: "/Library/Printers/vendor/Tools/utility.app"
2123</pre>
2124
b9faaae1
MS		 2125<h3><span class='info'>Mac OS X 10.6</span><a name='APScannerOnly'>APScannerOnly</a></h3>
2126
2127<p class='summary'>*APScannerOnly: boolean</p>
2128
10d09e33 2129<p>This keyword specifies whether the device has scanning but no printing
b9faaae1
MS		 2130capabilities. The default is <tt>False</tt>.</p>
2131
2132<p>Examples:</p>
2133
2134<pre class='command'>
2135*APICADriver: True
2136*APScannerOnly: True
2137</pre>
2138
db1f069b
MS		 2139<h3><span class='info'>Mac OS X 10.3</span><a name='APScanAppBundleID'>APScanAppBundleID</a></h3>
2140
2141<p class='summary'>*APScanAppBundleID: "bundle ID"</p>
2142
10d09e33 2143<p>This keyword defines the application to use when scanning pages from
db1f069b
MS		 2144the device.</p>
2145
2146<p>Examples:</p>
2147
2148<pre class='command'>
c5571a1d 2149*APICADriver: True
db1f069b
MS		 2150*APScanAppBundleID: "com.apple.ImageCaptureApp"
2151</pre>
2152
2153
2154<h2 class='title'><a name='HISTORY'>Change History</a></h2>
2155
10d09e33
MS		 2156<h3>Changes in CUPS 1.5</h3>
2157
2158<ul>
2159
2160 <li>Changes all instances of PPD attributes to PPD keywords, to be consistent with the parent specification from Adobe.</li>
2161
2162</ul>
2163
2164
c7017ecc
MS		 2165<h3>Changes in CUPS 1.4.5</h3>
2166
2167<ul>
2168
2169 <li>Added <a href='#cupsPrintQuality'><tt>cupsPrintQuality</tt></a> UI keyword.</li>
2170
2171 <li>Added new properties and values for the <a href='#APPrinterPreset'><tt>APPrinterPreset</tt></a> keyword.</li>
2172
2173</ul>
2174
2175
b0f6947b 2176<h3>Changes in CUPS 1.4</h3>
634763e8
MS		 2177
2178<ul>
2179
c5571a1d 2180 <li>Added <a href='#APICADriver'><tt>APICADriver</tt></a>
10d09e33 2181 keyword.</li>
c5571a1d 2182
749b1e90 2183 <li>Added <a href='#cupsCommands'><tt>cupsCommands</tt></a>
10d09e33 2184 keyword.</li>
634763e8 2185
749b1e90 2186 <li>Added <a href='#cupsMarkerName'><tt>cupsMarkerName</tt></a>
10d09e33 2187 keyword.</li>
634763e8 2188
749b1e90 2189 <li>Added <a href='#cupsMarkerNotice'><tt>cupsMarkerNotice</tt></a>
10d09e33 2190 keyword.</li>
75bd9771 2191
749b1e90 2192 <li>Added <a href='#cupsPJLDisplay'><tt>cupsPJLDisplay</tt></a>
10d09e33 2193 keyword.</li>
01ce6322 2194
58dc1933 2195 <li>Added <a href='#cupsSNMPSupplies'><tt>cupsSNMPSupplies</tt></a>
10d09e33 2196 keyword.</li>
58dc1933 2197
749b1e90
MS		 2198 <li>Added <a href='#cupsUIResolver'><tt>cupsUIResolver</tt></a> and
2199 <a href='#cupsUIConstraints'><tt>cupsUIConstraints</tt></a>
10d09e33 2200 keywords.</li>
66ab9486 2201
749b1e90
MS		 2202 <li>Added
2203 <a href='#cupsMediaQualifier2'><tt>cupsMediaQualifier2</tt></a>,
2204 <a href='#cupsMediaQualifier3'><tt>cupsMediaQualifier3</tt></a>,
2205 <a href='#cupsMinSize'><tt>cupsMinSize</tt></a>, and
10d09e33 2206 <a href='#cupsMaxSize'><tt>cupsMaxSize</tt></a> keywords.</li>
749b1e90 2207
634763e8
MS		 2208</ul>
2209
2210
b0f6947b 2211<h3>Changes in CUPS 1.3.1</h3>
db1f069b
MS		 2212
2213<ul>
2214
10d09e33 2215 <li>Added missing Mac OS X <tt>AP</tt> keywords.</li>
db1f069b
MS		 2216
2217 <li>Added section on auto-configuration including the
2218 <tt>OID<i>MainKeyword</i></tt> and <tt>?<i>MainKeyword</i></tt>
10d09e33 2219 keywords.</li>
db1f069b
MS		 2220
2221 <li>Minor reorganization.</li>
2222
2223</ul>
2224
ef416fc2 2225
b0f6947b 2226<h3>Changes in CUPS 1.3</h3>
f7deaa1a 2227
2228<ul>
2229
749b1e90
MS		 2230 <li>Added <a href='#cupsBackSide'><tt>cupsBackSide</tt></a> and
2231 deprecated <a href='#cupsFlipDuplex'><tt>cupsFlipDuplex</tt></a>.</li>
bc44d920 2232
749b1e90
MS		 2233 <li>Added text URI information to
2234 <a href='#cupsIPPReason'><tt>cupsIPPReason</tt></a> documentation.</li>
bc44d920 2235
749b1e90
MS		 2236 <li>Added <a href='#APPrinterPreset'><tt>APPrinterPreset</tt></a>,
2237 <a href='#cupsIPPFinishings'><tt>cupsIPPFinishings</tt></a>, and
10d09e33 2238 <a href='#cupsPreFilter'><tt>cupsPreFilter</tt></a> keywords.</li>
09a101d6 2239
749b1e90
MS		 2240 <li>Added discussion of custom option code, sample
2241 <tt>CustomPageSize</tt> code, and "do not use dict and put" note.</li>
f7deaa1a 2242
2243</ul>
2244
b0f6947b 2245<h3>Changes in CUPS 1.2.8</h3>
b86bc4cf 2246
2247<ul>
2248
2249 <li>Added section on supported PostScript commands for raster
2250 drivers</li>
2251
2252</ul>
2253
b0f6947b 2254<h3>Changes in CUPS 1.2</h3>
ef416fc2 2255
2256<ul>
2257
10d09e33 2258 <li>Added globalization support keywords</li>
ef416fc2 2259
2260 <li>Added custom option values support</li>
2261
10d09e33 2262 <li>Added <a href='#APHelpBook'><tt>APHelpBook</tt></a> keyword</li>
4744bd90 2263
749b1e90 2264 <li>Added <a href='#APDuplexRequiresFlippedMargin'><tt>APDuplexRequiresFlippedMargin</tt></a>
10d09e33 2265 keyword</li>
a4d04587 2266
10d09e33 2267 <li>Added <a href='#cupsICCProfile'><tt>cupsICCProfile</tt></a> keyword</li>
ef416fc2 2268
10d09e33 2269 <li>Added <a href='#cupsIPPReason'><tt>cupsIPPReason</tt></a> keyword</li>
4744bd90 2270
10d09e33 2271 <li>Added <a href='#cupsLanguages'><tt>cupsLanguages</tt></a> keyword</li>
a4d04587 2272
10d09e33 2273 <li>Added <a href='#cupsPortMonitor'><tt>cupsPortMonitor</tt></a> keyword</li>
ef416fc2 2274
10d09e33 2275 <li>Removed <tt>cupsProtocol</tt> keyword</li>
ef416fc2 2276
2277</ul>
2278
b0f6947b 2279<h3>Changes in CUPS 1.1</h3>
ef416fc2 2280
2281<ul>
2282
10d09e33 2283 <li>Added <a href='#cupsFlipDuplex'><tt>cupsFlipDuplex</tt></a> keyword</li>
ef416fc2 2284
10d09e33 2285 <li>Added <tt>cupsProtocol</tt> keyword</li>
ef416fc2 2286
2287</ul>
10d09e33 2288</div>
ef416fc2 2289</body>
2290</html>
Unnamed repository; edit this file 'description' to name the repository.