doc/help/spec-ppd.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <!-- SECTION: Specifications -->
   4 <head>
   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">
   9 <style type="text/css"><!--
  10 BODY {
  11   font-family: lucida grande, geneva, helvetica, arial, sans-serif;
  12 }
  13
  14 H1, H2, H3, H4, H5, H6, P, TD, TH {
  15   font-family: lucida grande, geneva, helvetica, arial, sans-serif;
  16 }
  17
  18 KBD {
  19   font-family: monaco, courier, monospace;
  20   font-weight: bold;
  21 }
  22
  23 PRE {
  24   font-family: monaco, courier, monospace;
  25 }
  26
  27 PRE.command {
  28   border: dotted thin #7f7f7f;
  29   margin-left: 36pt;
  30   padding: 10px;
  31 }
  32
  33 P.compact {
  34   margin: 0;
  35 }
  36
  37 P.example {
  38   font-style: italic;
  39   margin-left: 36pt;
  40 }
  41
  42 PRE.example {
  43   background: #eeeeee;
  44   border: dotted thin #999999;
  45   margin-left: 36pt;
  46   padding: 10pt;
  47 }
  48
  49 PRE.command EM, PRE.example EM {
  50   font-family: lucida grande, geneva, helvetica, arial, sans-serif;
  51 }
  52
  53 P.command {
  54   font-family: monaco, courier, monospace;
  55   margin-left: 36pt;
  56 }
  57
  58 P.formula {
  59   font-style: italic;
  60   margin-left: 36pt;
  61 }
  62
  63 BLOCKQUOTE {
  64   background: #eeeeee;
  65   border: solid thin #999999;
  66   padding: 10pt;
  67 }
  68
  69 A IMG {
  70   border: none;
  71 }
  72
  73 A:link:hover IMG {
  74   background: #f0f0f0;
  75   border-radius: 10px;
  76   -moz-border-radius: 10px;
  77 }
  78
  79 A:link, A:visited {
  80   font-weight: normal;
  81   text-decoration: none;
  82 }
  83
  84 A:link:hover, A:visited:hover, A:active {
  85   text-decoration: underline;
  86 }
  87
  88 SUB, SUP {
  89   font-size: 50%;
  90 }
  91
  92 TR.data, TD.data, TR.data TD {
  93   margin-top: 10pt;
  94   padding: 5pt;
  95   border-bottom: solid 1pt #999999;
  96 }
  97
  98 TR.data TH {
  99   border-bottom: solid 1pt #999999;
 100   padding-top: 10pt;
 101   padding-left: 5pt;
 102   text-align: left;
 103 }
 104
 105 DIV.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
 113 DIV.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
 122 DIV.table TABLE TD {
 123   border: solid thin #cccccc;
 124   padding-top: 5pt;
 125 }
 126
 127 DIV.table TABLE TH {
 128   background: #cccccc;
 129   border: none;
 130   border-bottom: solid thin #999999;
 131 }
 132
 133 DIV.figure TABLE {
 134   margin-left: auto;
 135   margin-right: auto;
 136 }
 137
 138 DIV.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
 147 TH.label {
 148   text-align: right;
 149   vertical-align: top;
 150 }
 151
 152 TH.sublabel {
 153   text-align: right;
 154   font-weight: normal;
 155 }
 156
 157 HR {
 158   border: solid thin;
 159 }
 160
 161 SPAN.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
 171 H2 SPAN.info, H3 SPAN.info, H4 SPAN.info {
 172   float: right;
 173   font-size: 100%;
 174 }
 175
 176 H1.title {
 177 }
 178
 179 H2.title, H3.title {
 180   border-bottom: solid 2pt #000000;
 181 }
 182
 183 DIV.indent, TABLE.indent {
 184   margin-top: 2em;
 185   margin-left: auto;
 186   margin-right: auto;
 187   width: 90%;
 188 }
 189
 190 TABLE.indent {
 191   border-collapse: collapse;
 192 }
 193
 194 TABLE.indent TD, TABLE.indent TH {
 195   padding: 0;
 196 }
 197
 198 TABLE.list {
 199   border-collapse: collapse;
 200   margin-left: auto;
 201   margin-right: auto;
 202   width: 90%;
 203 }
 204
 205 TABLE.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
 216 TABLE.list TH A {
 217   color: #4444cc;
 218 }
 219
 220 TABLE.list TD {
 221   border-bottom: solid thin #eeeeee;
 222   padding-top: 5pt;
 223   padding-left: 5pt;
 224 }
 225
 226 TABLE.list TR:nth-child(even) {
 227   background: #f8f8f8;
 228 }
 229
 230 TABLE.list TR:nth-child(odd) {
 231   background: #f4f4f4;
 232 }
 233
 234 DT {
 235   margin-left: 36pt;
 236   margin-top: 12pt;
 237 }
 238
 239 DD {
 240   margin-left: 54pt;
 241 }
 242
 243 DL.category DT {
 244   font-weight: bold;
 245 }
 246
 247 P.summary {
 248   margin-left: 36pt;
 249   font-family: monaco, courier, monospace;
 250 }
 251
 252 DIV.summary TABLE {
 253   border: solid thin #999999;
 254   border-collapse: collapse;
 255   border-spacing: 0;
 256   margin: 10px;
 257 }
 258
 259 DIV.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
 266 DIV.summary TABLE THEAD TH {
 267   background: #eeeeee;
 268 }
 269
 270 /* API documentation styles... */
 271 div.body h1 {
 272   margin: 0;
 273 }
 274 div.body h2 {
 275   margin-top: 1.5em;
 276 }
 277 div.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 }
 289 code, p.code, pre, ul.code li {
 290   font-family: monaco, courier, monospace;
 291   font-size: 90%;
 292 }
 293 ul.code, ul.contents, ul.subcontents {
 294   list-style-type: none;
 295   margin: 0;
 296   padding-left: 0;
 297 }
 298 ul.code li {
 299   margin: 0;
 300 }
 301 ul.contents > li {
 302   margin-top: 1em;
 303 }
 304 ul.contents li ul.code, ul.contents li ul.subcontents {
 305   padding-left: 2em;
 306 }
 307 div.body dl {
 308   margin-left: 0;
 309   margin-top: 0;
 310 }
 311 div.body dt {
 312   font-style: italic;
 313   margin-left: 0;
 314   margin-top: 0;
 315 }
 316 div.body dd {
 317   margin-bottom: 0.5em;
 318 }
 319
 320 /* This is just for the HTML files generated with the framedhelp target */
 321 div.contents {
 322   background: #e8e8e8;
 323   border: solid thin black;
 324   padding: 10px;
 325 }
 326 div.contents h1 {
 327   font-size: 110%;
 328 }
 329 div.contents h2 {
 330   font-size: 100%;
 331 }
 332 div.contents ul.contents {
 333   font-size: 80%;
 334 }
 335 div.contents ul.subcontents li {
 336   margin-left: 1em;
 337   text-indent: -1em;
 338 }
 339 --></style>
 340 </head>
 341 <body>
 342 <div class='body'>
 343 <!--
 344   "$Id: spec-ppd.html 9345 2010-10-26 23:46:51Z mike $"
 345
 346   PPD extension documentation for CUPS.
 347
 348   Copyright 2007-2010 by Apple Inc.
 349   Copyright 1997-2007 by Easy Software Products.
 350
 351   These coded instructions, statements, and computer programs are the
 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/".
 356 -->
 357
 358 <H1 CLASS="title">CUPS PPD Extensions</H1>
 359
 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>
 361
 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">
 377 <li><a href="#SYNTAX">PPD File Syntax</a></li>
 378 <li><a href="#AUTOCONFIG">Auto-Configuration</a><ul class="subcontents">
 379         <li><a href="#APAutoSetupTool">APAutoSetupTool</a></li>
 380         <li><a href="#QUERYKEYWORD">?MainKeyword</a></li>
 381         <li><a href="#OID">OIDMainKeyword</a></li>
 382 </ul></li>
 383 <li><a href="#PROFILES">Color Profiles</a><ul class="subcontents">
 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>
 387 </ul></li>
 388 <li><a href="#CONSTRAINTS">Constraints</a><ul class="subcontents">
 389         <li><a href="#cupsUIConstraints">cupsUIConstraints</a></li>
 390         <li><a href="#cupsUIResolver">cupsUIResolver</a></li>
 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">
 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>
 400 </ul></li>
 401 <li><a href="#ATTRIBUTES">General Attributes</a><ul class="subcontents">
 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>
 422 </ul></li>
 423 <li><a href="#MACOSX">Mac OS X Attributes</a><ul class="subcontents">
 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>
 434 </ul></li>
 435 <li><a href="#HISTORY">Change History</a></li>
 436 </ul>
 437 <h2 class='title'><a name='SYNTAX'>PPD File Syntax</a></h2>
 438
 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>
 440
 441 <pre class='command'>
 442 PPD-FILE = HEADER +(DATA / COMMENT / LINE-END)
 443
 444 HEADER   = "*PPD-Adobe:" *WSP DQUOTE VERSION DQUOTE LINE-END
 445
 446 VERSION  = "4.0" / "4.1" / "4.2" / "4.3"
 447
 448 COMMENT  = "*%" *TCHAR LINE-END
 449
 450 DATA     = "*" 1*KCHAR [ WSP 1*KCHAR [ "/" 1*TCHAR ] ] ":"
 451            1*(*WSP VALUE) LINE-END
 452
 453 VALUE    = 1*TCHAR / DQUOTE 1*SCHAR DQUOTE
 454
 455 KCHAR    = ALPHA / DIGIT / "_" / "." / "-"
 456
 457 SCHAR    = LINE-END / WSP / %x21.23-7E.A0-FF
 458
 459 TCHAR    = %x20-7E.A0-FF
 460
 461 LINE-END = CR / LF / CR LF
 462 </pre>
 463
 464
 465 <h2 class='title'><a name='AUTOCONFIG'>Auto-Configuration</a></h2>
 466
 467 <p>CUPS supports several methods of auto-configuration via PPD keywords.</p>
 468
 469 <h3><span class='info'>Deprecated</span><a name='APAutoSetupTool'>APAutoSetupTool</a></h3>
 470
 471 <p class='summary'>*APAutoSetupTool: "/LibraryPrinters/vendor/filename"</p>
 472
 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>
 474
 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>
 478
 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>
 482 <p>Examples:</p>
 483
 484 <pre class='command'>
 485 *% Use our setup tool when adding a printer
 486 *APAutoSetupTool: "/Library/Printers/vendor/Tools/autosetuptool"
 487 </pre>
 488
 489 <h3><span class='info'>Mac OS X 10.2/CUPS 1.4</span><a name='QUERYKEYWORD'>?MainKeyword</a></h3>
 490
 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>
 495
 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>
 497
 498 <p>The PostScript code typically sends its response back using the <tt>=</tt> operator.</p>
 499
 500 <p>Example:</p>
 501
 502 <pre class='command'>
 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
 516 </pre>
 517
 518 <h3><span class='info'>Mac OS X 10.4/CUPS 1.5</span><a name='OID'>OIDMainKeyword</a></h3>
 519
 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>
 524
 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>
 526
 527 <p>Examples:</p>
 528
 529 <pre class='command'>
 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"
 536 </pre>
 537
 538
 539 <h2 class='title'><a name='PROFILES'>Color Profiles</a></h2>
 540
 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>
 542
 543 <blockquote><b>Note:</b>
 544
 545 <p>At this time, none of the CUPS raster filters support ICC profiles. This will be addressed as time and resources permit.</p>
 546
 547 </blockquote>
 548
 549 <h3><span class='info'>Deprecated</span><a name='cupsColorProfile'>cupsColorProfile</a></h3>
 550
 551 <p class='summary'>*cupsColorProfile Resolution/MediaType: "density gamma m00 m01 m02 m10 m11 m12 m20 m21 m22"</p>
 552
 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>
 554
 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>
 556
 557 <p>The <i>density</i> and <i>gamma</i> values define gamma and
 558 density adjustment function such that:</p>
 559
 560 <pre class='command'>
 561 f(x) = density * x <sup style='font-size: 100%'>gamma</sup>
 562 </pre>
 563
 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>
 565
 566 <pre class='command'>
 567 | m00 m01 m02 |
 568 | m10 m11 m12 |
 569 | m20 m21 m22 |
 570 </pre>
 571
 572 <p>Examples:</p>
 573
 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"
 577
 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"
 580
 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"
 583 </pre>
 584
 585
 586 <h3><span class='info'>Mac OS X 10.3/CUPS 1.2</span><a name='cupsICCProfile'>cupsICCProfile</a></h3>
 587
 588 <p class='summary'>*cupsICCProfile ColorModel.MediaType.Resolution/Description: "filename"</p>
 589
 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>
 591
 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>
 593
 594 <p>Examples:</p>
 595
 596 <pre class='command'>
 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"
 599
 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"
 602
 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>
 606
 607 <h4>Customizing the Profile Selection Keywords</h4>
 608
 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>
 610
 611 <pre class='command'>
 612 *cupsICCQualifier2: MainKeyword2
 613 *cupsICCQualifier3: MainKeyword3
 614 </pre>
 615
 616 <p>The default mapping is as follows:</p>
 617
 618 <pre class='command'>
 619 *cupsICCQualifier2: MediaType
 620 *cupsICCQualifier3: Resolution
 621 </pre>
 622
 623 <h3><span class='info'>Mac OS X 10.4</span><a name='APCustom'>Custom Color Matching Support</a></h3>
 624
 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>
 629
 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>
 631
 632 <blockquote><b>Note:</b>
 633
 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>
 635
 636 </blockquote>
 637
 638 <h4><span class='info'>Mac OS X 10.5</span><a name='APCustomColorMatchingName'>APCustomColorMatchingName</a></h4>
 639
 640 <p class='summary'>*APCustomColorMatchingName name/text: ""</p>
 641
 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>
 643
 644 <p>Examples:</p>
 645
 646 <pre class='command'>
 647 *% Define the names for our color matching...
 648 *APCustomColorMatchingName name/AcmeColor(tm): ""
 649 *fr.APCustomColorMatchingName name/La AcmeColor(tm): ""
 650 </pre>
 651
 652 <h4><span class='info'>Mac OS X 10.5</span><a name='APCustomColorMatchingProfile'>APCustomColorMatchingProfile</a></h4>
 653
 654 <p class='summary'>*APCustomColorMatchingProfile: name</p>
 655
 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>
 657
 658 <blockquote><b>Note:</b>
 659
 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>
 661
 662 </blockquote>
 663
 664 <p>Examples:</p>
 665
 666 <pre class='command'>
 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
 672 </pre>
 673
 674 <h4><span class='info'>Mac OS X 10.5</span><a name='APDefaultCustomColorMatchingProfile'>APDefaultCustomColorMatchingProfile</a></h4>
 675
 676 <p class='summary'>*APDefaultCustomColorMatchingProfile: name</p>
 677
 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>
 679
 680 <p>Examples:</p>
 681
 682 <pre class='command'>
 683 *% Use sRGB for RGB color by default
 684 *APSupportsCustomColorMatching: true
 685 *APDefaultCustomColorMatchingProfile: sRGB
 686 </pre>
 687
 688 <h4><span class='info'>Mac OS X 10.4</span><a name='APSupportsCustomColorMatching'>APSupportsCustomColorMatching</a></h4>
 689
 690 <p class='summary'>*APSupportsCustomColorMatching: boolean</p>
 691
 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>
 693
 694 <p>The default for <tt>APSupportsCustomColorMatching</tt> is <tt>false</tt>.</p>
 695
 696 <p>Examples:</p>
 697
 698 <pre class='command'>
 699 *APSupportsCustomColorMatching: true
 700 *APDefaultCustomColorMatchingProfile: sRGB
 701 </pre>
 702
 703
 704 <h2 class='title'><a name='CONSTRAINTS'>Constraints</a></h2>
 705
 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>
 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
 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>
 715
 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>
 717
 718 <blockquote><b>Note:</b>
 719
 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>
 721
 722 </blockquote>
 723
 724 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsUIConstraints'>cupsUIConstraints</a></h3>
 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
 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>
 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
 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
 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
 754 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsUIResolver'>cupsUIResolver</a></h3>
 755
 756 <p class='summary'>*cupsUIResolver resolver: "*Keyword1 OptionKeyword1 *Keyword2 OptionKeyword2 ..."</p>
 757
 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>
 759
 760 <p>Examples:</p>
 761
 762 <pre class='command'>
 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"
 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
 776 <h2 class='title'><a name='I18N'>Globalized PPD Support</a></h2>
 777
 778 <p>CUPS 1.2 and higher adds support for PPD files containing multiple languages by following the following additional rules:</p>
 779
 780 <ol>
 781
 782         <li>The <tt>LanguageVersion</tt> MUST be <tt>English</tt></li>
 783
 784         <li>The <tt>LanguageEncoding</tt> MUST be <tt>ISOLatin1</tt></li>
 785
 786         <li>The <tt>cupsLanguages</tt> keyword MUST be provided and list each of the supported locales in the PPD file</li>
 787
 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>
 789
 790         <li>The main keyword "Translation" MUST NOT be used</li>
 791
 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>
 793
 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>
 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>
 798
 799         <li>Locale-specific translation strings MUST be encoded using UTF-8.</li>
 800
 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>
 804
 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>
 808
 809         <li>Localization keywords MAY appear anywhere after the first line of the PPD file</li>
 810
 811 </ol>
 812
 813 <blockquote><b>Note:</b>
 814
 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>
 816
 817 </blockquote>
 818
 819 <p>Examples:</p>
 820
 821 <pre class='command'>
 822 *LanguageVersion: English
 823 *LanguageEncoding: ISOLatin1
 824 *cupsLanguages: "de fr_CA"
 825 *ModelName: "Foobar Laser 9999"
 826
 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: ""
 830
 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"
 835
 836 ...
 837
 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
 853 </pre>
 854
 855
 856 <h2 class='title'><a name='OPTIONS'><span class="info">CUPS 1.3/Mac OS X 10.6</span>Custom Options</a></h2>
 857
 858 <p>CUPS supports custom options using an extension of the <tt>CustomPageSize</tt> and <tt>ParamCustomPageSize</tt> syntax:</p>
 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
 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
 869 option 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>
 872
 873 <p>The "type" is one of the following keywords:</p>
 874
 875 <ul>
 876
 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>
 878
 879         <li><tt>int</tt> - an integer value from "minimum" to "maximum"</li>
 880
 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>
 882
 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>
 884
 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>
 886
 887         <li><tt>points</tt> - a measurement value in points from "minimum" to "maximum"</li>
 888
 889         <li><tt>real</tt> - a real value from "minimum" to "maximum"</li>
 890
 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>
 892
 893 </ul>
 894
 895 <p>Examples:</p>
 896
 897 <pre class='command'>
 898 <em>*% Base JCL key code option</em>
 899 *JCLOpenUI JCLPasscode/Key Code: PickOne
 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
 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>
 922 *CustomWatermarkText True: "&lt;&lt;/cupsString1 3 -1 roll&gt;&gt;setpagedevice"
 923 *ParamCustomWatermarkText Text: 1 string 0 32
 924
 925
 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"
 933 *CloseUI: *GammaDensity
 934
 935 <em>*% Custom PostScript gamma/density option</em>
 936 *CustomGammaDensity True: "&lt;&lt;/cupsReal1 3 -1 roll/cupsReal2 5 -1&gt;&gt;setpagedevice"
 937 *ParamCustomGammaDensity Gamma: 1 curve 0.1 10
 938 *ParamCustomGammaDensity Density: 2 real 0 2
 939 </pre>
 940
 941
 942 <h2 class='title'><a name='RASTERPS'>Writing PostScript Option Commands for Raster Drivers</a></h2>
 943
 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>
 945
 946 <pre class='command'>
 947 *PageSize A4: "&lt;&lt;/PageSize[595 842]&gt;&gt;setpagedevice"
 948 </pre>
 949
 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>
 951
 952 <pre class='command'>
 953 *CustomWatermarkText True: "&lt;&lt;/cupsString1 3 -1 roll&gt;&gt;setpagedevice"
 954 </pre>
 955
 956 <p>For a custom string value of "My Watermark", CUPS will produce the following PostScript code for the option:</p>
 957
 958 <pre class='command'>
 959 (My Watermark)
 960 &lt;&lt;/cupsString1 3 -1 roll&gt;&gt;setpagedevice
 961 </pre>
 962
 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>
 964
 965 <pre class='command'>
 966 &lt;&lt;/cupsString1(My Watermark)&gt;&gt;setpagedevice
 967 </pre>
 968
 969 <p>The resulting dictionary sets the page device attributes that are sent to your raster driver in the page header.</p>
 970
 971 <h3>Custom Page Size Code</a></h3>
 972
 973 <p>There are many possible implementations of the <tt>CustomPageSize</tt> code. For CUPS raster drivers, the following code is recommended:</p>
 974
 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"
 982 </pre>
 983
 984 <h3>Supported PostScript Operators</a></h3>
 985
 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>
 987
 988 <ul>
 989
 990         <li><tt>&lt;&lt;</tt> - Start a dictionary.</li>
 991
 992         <li><tt>&gt;&gt;</tt> - End a dictionary.</li>
 993
 994         <li><tt>[</tt> - Start an array.</li>
 995
 996         <li><tt>]</tt> - End an array.</li>
 997
 998         <li><tt>copy</tt> - Copy the top N objects on the stack.</li>
 999
1000         <li><tt>dup</tt> - Copy the top object on the stack.</li>
1001
1002         <li><tt>index</tt> - Copy the Nth from the top object on the stack.</li>
1003
1004         <li><tt>pop</tt> - Pop the top object on the stack.</li>
1005
1006         <li><tt>roll</tt> - Shift the top N objects on the stack.</li>
1007
1008         <li><tt>setpagedevice</tt> - Set the page header values according to the key/value dictionary on the stack.</li>
1009
1010 </ul>
1011
1012 <blockquote><b>Note:</b>
1013
1014 <p><em>Never</em> use the unsupported <tt>dict</tt> or <tt>put</tt>
1015 operators in your option code. These operators are typically used in
1016 option code dating back to Level 1 PostScript printers, which did not
1017 support the simpler <tt>&lt;&lt;</tt> or <tt>&gt;&gt;</tt> operators.
1018 If you have old option code using <tt>dict</tt> or <tt>put</tt>, you can
1019 rewrite it very easily to use the newer <tt>&lt;&lt;</tt> and
1020 <tt>&gt;&gt;</tt> operators instead. For example, the following code
1021 to set the page size:</p>
1022
1023 <style type='text/css'><!--
1024 PRE 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
1043 <h3>Supported Page Device Attributes</a></h3>
1044
1045 <p>Table 2 shows the supported page device attributes along with PostScript code examples.</p>
1046
1047 <div class='table'>
1048 <table summary='Supported Page Device Attributes'>
1049 <caption>Table 2: <a name='TABLE_2'>Supported Page Device Attributes</a></caption>
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>
1225         <td><tt>&lt;&lt;/cupsColorSpace 1 &gt;&gt;setpagedevice</tt></td>
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
1309 <h2 class='title'><a name='MEDIA'>Media Keywords</a></h2>
1310
1311 <p>The CUPS media keywords allow drivers to specify alternate custom page
1312 size limits based on up to two options.</p>
1313
1314 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMediaQualifier2'>cupsMediaQualifier2</a></h3>
1315
1316 <p class='summary'>*cupsMediaQualifier2: MainKeyword</p>
1317
1318 <p>This keyword specifies the second option to use for overriding the
1319 custom 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
1333 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMediaQualifier3'>cupsMediaQualifier3</a></h3>
1334
1335 <p class='summary'>*cupsMediaQualifier3: MainKeyword</p>
1336
1337 <p>This keyword specifies the third option to use for overriding the
1338 custom 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
1352 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMinSize'>cupsMinSize</a></h3>
1353
1354 <p class='summary'>*cupsMinSize .Qualifier2.Qualifier3: "width length"<br>
1355 *cupsMinSize .Qualifier2.: "width length"<br>
1356 *cupsMinSize ..Qualifier3: "width length"</p>
1357
1358 <p>This keyword specifies alternate minimum custom page sizes in points.
1359 The <a href='#cupsMediaQualifier2'><tt>cupsMediaQualifier2</tt></a> and
1360 <a href='#cupsMediaQualifier3'><tt>cupsMediaQualifier3</tt></a> keywords
1361 are 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
1375 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMaxSize'>cupsMaxSize</a></h3>
1376
1377 <p class='summary'>*cupsMaxSize .Qualifier2.Qualifier3: "width length"<br>
1378 *cupsMaxSize .Qualifier2.: "width length"<br>
1379 *cupsMaxSize ..Qualifier3: "width length"</p>
1380
1381 <p>This keyword specifies alternate maximum custom page sizes in points.
1382 The <a href='#cupsMediaQualifier2'><tt>cupsMediaQualifier2</tt></a> and
1383 <a href='#cupsMediaQualifier3'><tt>cupsMediaQualifier3</tt></a> keywords
1384 are 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
1399 <h2 class='title'><a name='ATTRIBUTES'>General Attributes</a></h2>
1400
1401 <h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsBackSide'>cupsBackSide</a></h3>
1402
1403 <p class='summary'>*cupsBackSide: keyword</p>
1404
1405 <p>This keyword requests special handling of the back side of pages
1406 when doing duplexed (2-sided) output. <a href='#TABLE_1'>Table 1</a>
1407 shows the supported keyword values for this keyword and their effect
1408 on the raster data sent to your driver. For example, when <tt>cupsBackSide</tt>
1409 is <code>Rotated</code> and <tt>Tumble</tt> is <tt>false</tt>, your driver
1410 will receive print data starting at the bottom right corner of the page, with
1411 each 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>
1417 keyword - if <tt>cupsBackSide</tt> is specified, <tt>cupsFlipDuplex</tt>
1418 will 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>
1495 keyword.</p>
1496
1497 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsCommands'>cupsCommands</a></h3>
1498
1499 <p class='summary'>*cupsCommands: "name name2 ... nameN"</p>
1500
1501 <p>This string keyword specifies the commands that are supported by the
1502 CUPS command file filter for this device. The command names are separated
1503 by 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
1513 <h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsEvenDuplex'>cupsEvenDuplex</a></h3>
1514
1515 <p class='summary'>*cupsEvenDuplex: boolean</p>
1516
1517 <p>This boolean keyword notifies the RIP filters that the
1518 destination printer requires an even number of pages when 2-sided
1519 printing 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
1532 <p>This boolean keyword specifies whether the PPD defines a facsimile device. The default is <tt>false</tt>.</p>
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
1544 <p>This string keyword provides a conversion rule from the
1545 given source type to the printer's native format using the
1546 filter "program". If a printer supports the source type directly,
1547 the 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,
1567 the <tt>cupsFlipDuplex</tt> keyword is deprecated. Instead, use
1568 the <a href='#cupsBackSide'><tt>cupsBackSide</tt></a> keyword to specify
1569 the coordinate system (pixel layout) of the page data on the back side of
1570 duplex pages.</p>
1571
1572 <p>The value <code>true</code> maps to a <tt>cupsBackSide</tt> value
1573 of <code>Rotated</code> on Mac OS X and <code>Flipped</code> with
1574 Ghostscript.</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
1582 new keywords for maximum compatibility, for example:</p>
1583
1584 <pre class='command'>
1585 *cupsBackSide: Rotated
1586 *cupsFlipDuplex: true
1587 </pre>
1588
1589 <p>Similarly, drivers written for other operating systems using
1590 Ghostscript can use:</p>
1591
1592 <pre class='command'>
1593 *cupsBackSide: Flipped
1594 *cupsFlipDuplex: true
1595 </pre></blockquote>
1596
1597 <h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsIPPFinishings'>cupsIPPFinishings</a></h3>
1598
1599 <p class='summary'>*cupsIPPFinishings number/text: "*Option Choice ..."</p>
1600
1601 <p>This keyword defines a mapping from IPP <code>finishings</code>
1602 values 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
1613 <h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsIPPReason'>cupsIPPReason</a></h3>
1614
1615 <p class='summary'>*cupsIPPReason reason/Reason Text: "optional URIs"</p>
1616
1617 <p>This optional keyword maps custom
1618 <code>printer-state-reasons</code> keywords that are generated by
1619 the driver to human readable text. The optional URIs string
1620 contains zero or more URIs separated by a newline. Each URI can
1621 be a CUPS server absolute path to a help file under the
1622 scheduler's <code>DocumentRoot</code> directory, a full HTTP URL
1623 ("http://www.domain.com/path/to/help/page.html"), or any other
1624 valid URI which directs the user at additional information
1625 concerning the condition that is being reported.</p>
1626
1627 <p>Since the reason text is limited to 80 characters by the PPD specification,
1628 longer text strings can be included by URI-encoding the text with the "text"
1629 scheme, for example "text:some%20text". Multiple <code>text</code> URIs are
1630 combined (with spaces between each URI) by the <tt>ppdLocalizeIPPReason</tt>
1631 into 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
1641 text: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>
1650 *APHelpBook: "file:///Library/Printers/vendor/Help.bundle"
1651 *cupsIPPReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html
1652 help:anchor='com.vendor-error'%20bookID=Vendor%20Help
1653 http://www.vendor.com/help"
1654 *End
1655 </pre>
1656
1657 <h3><span class='info'>CUPS 1.2/Mac OS X 10.5</span><a name='cupsLanguages'>cupsLanguages</a></h3>
1658
1659 <p class='summary'>*cupsLanguages: "locale list"</p>
1660
1661 <p>This keyword describes which language localizations are
1662 included in the PPD. The "locale list" string is a space-delimited
1663 list 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>
1669 *cupsLanguages: "en_CA en_UK en_US fr_CA fr_FR"
1670 </pre>
1671
1672 <h3><a name='cupsManualCopies'>cupsManualCopies</a></h3>
1673
1674 <p class='summary'>*cupsManualCopies: boolean</p>
1675
1676 <p>This boolean keyword notifies the RIP filters that the
1677 destination printer does not support copy generation in
1678 hardware. 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
1687 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMarkerName'>cupsMarkerName</a></h3>
1688
1689 <p class='summary'>*cupsMarkerName/Name Text: ""</p>
1690
1691 <p>This optional keyword maps <code>marker-names</code> strings that are
1692 generated 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
1701 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMarkerNotice'>cupsMarkerNotice</a></h3>
1702
1703 <p class='summary'>*cupsMarkerNotice: "disclaimer text"</p>
1704
1705 <p>This optional keyword provides disclaimer text for the supply level
1706 information provided by the driver, typically something like "supply levels
1707 are approximate".</p>
1708
1709 <p>Examples:</p>
1710
1711 <pre class='command'>
1712 *cupsMarkerNotice: "Supply levels are approximate."
1713 </pre>
1714
1715 <h3><a name='cupsModelNumber'>cupsModelNumber</a></h3>
1716
1717 <p class='summary'>*cupsModelNumber: number</p>
1718
1719 <p>This integer keyword specifies a printer-specific model
1720 number. This number can be used by a filter program to adjust
1721 the 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
1730 <h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsPJLCharset'>cupsPJLCharset</a></h3>
1731
1732 <p class='summary'>*cupsPJLCharset: "ISO character set name"</p>
1733
1734 <p>This string keyword specifies the character set that is used
1735 for strings in PJL commands. If not specified, US-ASCII is
1736 assumed.</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
1745 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsPJLDisplay'>cupsPJLDisplay</a></h3>
1746
1747 <p class='summary'>*cupsPJLDisplay: "what"</p>
1748
1749 <p>This optional keyword specifies which command is used to display the
1750 job ID, name, and user on the printer's control panel. "What" is either "none"
1751 to disable this functionality, "job" to use "@PJL JOB DISPLAY", or "rdymsg"
1752 to 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>
1763
1764 <h3><span class='info'>CUPS 1.2/Mac OS X 10.5</span><a name='cupsPortMonitor'>cupsPortMonitor</a></h3>
1765
1766 <p class='summary'>*cupsPortMonitor urischeme/Descriptive Text: "port monitor"</p>
1767
1768 <p>This string keyword specifies printer-specific "port
1769 monitor" filters that may be used with the printer. The CUPS
1770 scheduler also looks for the <tt>Protocols</tt> keyword to see
1771 if the <tt>BCP</tt> or <tt>TBCP</tt> protocols are supported. If
1772 so, the corresponding port monitor ("bcp" and "tbcp",
1773 respectively) is listed in the printer's
1774 <tt>port-monitor-supported</tt> keyword.</p>
1775
1776 <p>The "urischeme" portion of the keyword specifies the URI scheme
1777 that this port monitor should be used for. Typically this is used to
1778 pre-select a particular port monitor for each type of connection that
1779 is supported by the printer. The "port monitor" string can be "none"
1780 to 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
1796 <h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsPreFilter'>cupsPreFilter</a></h3>
1797
1798 <p class='summary'>*cupsPreFilter: "source/type cost program"</p>
1799
1800 <p>This string keyword provides a pre-filter rule. The pre-filter
1801 program will be inserted in the conversion chain immediately
1802 before 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
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
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>
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
1839 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsSNMPSupplies'>cupsSNMPSupplies</a></h3>
1840
1841 <p class='summary'>*cupsSNMPSupplies: boolean</p>
1842
1843 <p>This keyword tells the standard network backends whether they should query
1844 the 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
1854 <h3><a name='cupsVersion'>cupsVersion</a></h3>
1855
1856 <p class='summary'>*cupsVersion: major.minor</p>
1857
1858 <p>This required keyword describes which version of the CUPS
1859 PPD 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
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
1876 <p>This keyword defines additional option panes that are displayed in the
1877 print dialog. Each keyword adds one or more option panes. See the "OutputBinsPDE"
1878 example and <a href='http://developer.apple.com/qa/qa2004/qa1352.html'>Apple
1879 Technical Q&amp;A QA1352</a> for information on writing your own print dialog
1880 plug-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
1886 in 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
1902 <p>This boolean keyword notifies the RIP filters that the
1903 destination printer requires the top and bottom margins of the
1904 <tt>ImageableArea</tt> to be swapped for the back page. The
1905 default is <tt>true</tt> when <tt>cupsBackSide</tt> is <tt>Flipped</tt>
1906 and <tt>false</tt> otherwise. <a href='#TABLE_2'>Table 2</a> shows how
1907 <tt>APDuplexRequiresFlippedMargin</tt> interacts with <tt>cupsBackSide</tt>
1908 and 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>
1978 keyword.</p>
1979
1980 <h3><a name='APHelpBook'>APHelpBook</a></h3>
1981
1982 <p class='summary'>*APHelpBook: "bundle URL"</p>
1983
1984 <p>This string keyword specifies the Apple help book bundle to use when
1985 looking up IPP reason codes for this printer driver. The
1986 <a href='#cupsIPPReason'><tt>cupsIPPReason</tt></a> keyword maps
1987 "help" URIs to this file.</p>
1988
1989 <p>Example:</p>
1990
1991 <pre class='command'>
1992 *APHelpBook: "file:///Library/Printers/vendor/Help.bundle"
1993 </pre>
1994
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
1999 <p>This keyword specifies whether the device has a matching Image Capture
2000 Architecture (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
2009 <h3><span class='info'>Mac OS X 10.3</span><a name='APPrinterIconPath'>APPrinterIconPath</a></h3>
2010
2011 <p class='summary'>*APPrinterIconPath: "/Library/Printers/vendor/filename.icns"</p>
2012
2013 <p>This keyword defines the location of a printer icon file to use when
2014 displaying the printer. The file must be in the Apple icon format.</p>
2015
2016 <p>Examples:</p>
2017
2018 <pre class='command'>
2019 *% Apple icon file
2020 *APPrinterIconPath: "/Library/Printers/vendor/Icons/filename.icns"
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
2027 <p>This keyword defines an program that checks the ink/toner/marker levels
2028 on a printer, returning an XML document with those levels. See the "InkTool"
2029 example and
2030 <a href='http://developer.apple.com/technotes/tn2005/tn2144.html'>Apple
2031 Technical 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
2044 <p>This keyword defines presets for multiple options that show up
2045 in the print dialog of applications (such as iPhoto) that set the job
2046 style hint to <tt>NSPrintPhotoJobStyleHint</tt>. Each preset maps to one or
2047 more pairs of PPD options and choices as well as providing key/value data for
2048 the application. The following standard preset names are currently defined:</p>
2049
2050 <ul>
2051
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>
2059
2060         <li><code>Photo_with_Paper_Auto-Detect</code>; Normal quality photo printing with auto-detected media.</li>
2061
2062         <li><code>Photo_with_Paper_Auto-Detect_-_Fine</code>; High quality photo printing with auto-detected media.</li>
2063
2064         <li><code>Photo_on_Plain_Paper</code>; Normal quality photo printing on plain paper.</li>
2065
2066         <li><code>Photo_on_Plain_Paper_-_Fine</code>; High quality photo printing on plain paper.</li>
2067
2068         <li><code>Photo_on_Photo_Paper</code>; Normal quality photo printing on glossy photo paper.</li>
2069
2070         <li><code>Photo_on_Photo_Paper_-_Fine</code>; High quality photo printing on glossy photo paper.</li>
2071
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>
2075
2076 </ul>
2077
2078 <p>The value string consists of pairs of keywords, either an option name and
2079 choice (*MainKeyword OptionKeyword) or a preset identifier and value
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>
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
2114 <p>This keyword defines a GUI application that can be used to do printer
2115 maintenance functions such as cleaning the print head(s). See ... for more
2116 information.</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
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
2129 <p>This keyword specifies whether the device has scanning but no printing
2130 capabilities. 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
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
2143 <p>This keyword defines the application to use when scanning pages from
2144 the device.</p>
2145
2146 <p>Examples:</p>
2147
2148 <pre class='command'>
2149 *APICADriver: True
2150 *APScanAppBundleID: "com.apple.ImageCaptureApp"
2151 </pre>
2152
2153
2154 <h2 class='title'><a name='HISTORY'>Change History</a></h2>
2155
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
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
2176 <h3>Changes in CUPS 1.4</h3>
2177
2178 <ul>
2179
2180         <li>Added <a href='#APICADriver'><tt>APICADriver</tt></a>
2181         keyword.</li>
2182
2183         <li>Added <a href='#cupsCommands'><tt>cupsCommands</tt></a>
2184         keyword.</li>
2185
2186         <li>Added <a href='#cupsMarkerName'><tt>cupsMarkerName</tt></a>
2187         keyword.</li>
2188
2189         <li>Added <a href='#cupsMarkerNotice'><tt>cupsMarkerNotice</tt></a>
2190         keyword.</li>
2191
2192         <li>Added <a href='#cupsPJLDisplay'><tt>cupsPJLDisplay</tt></a>
2193         keyword.</li>
2194
2195         <li>Added <a href='#cupsSNMPSupplies'><tt>cupsSNMPSupplies</tt></a>
2196         keyword.</li>
2197
2198         <li>Added <a href='#cupsUIResolver'><tt>cupsUIResolver</tt></a> and
2199         <a href='#cupsUIConstraints'><tt>cupsUIConstraints</tt></a>
2200         keywords.</li>
2201
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
2206         <a href='#cupsMaxSize'><tt>cupsMaxSize</tt></a> keywords.</li>
2207
2208 </ul>
2209
2210
2211 <h3>Changes in CUPS 1.3.1</h3>
2212
2213 <ul>
2214
2215         <li>Added missing Mac OS X <tt>AP</tt> keywords.</li>
2216
2217         <li>Added section on auto-configuration including the
2218         <tt>OID<i>MainKeyword</i></tt> and <tt>?<i>MainKeyword</i></tt>
2219         keywords.</li>
2220
2221         <li>Minor reorganization.</li>
2222
2223 </ul>
2224
2225
2226 <h3>Changes in CUPS 1.3</h3>
2227
2228 <ul>
2229
2230         <li>Added <a href='#cupsBackSide'><tt>cupsBackSide</tt></a> and
2231         deprecated <a href='#cupsFlipDuplex'><tt>cupsFlipDuplex</tt></a>.</li>
2232
2233         <li>Added text URI information to
2234         <a href='#cupsIPPReason'><tt>cupsIPPReason</tt></a> documentation.</li>
2235
2236         <li>Added <a href='#APPrinterPreset'><tt>APPrinterPreset</tt></a>,
2237         <a href='#cupsIPPFinishings'><tt>cupsIPPFinishings</tt></a>, and
2238         <a href='#cupsPreFilter'><tt>cupsPreFilter</tt></a> keywords.</li>
2239
2240         <li>Added discussion of custom option code, sample
2241         <tt>CustomPageSize</tt> code, and "do not use dict and put" note.</li>
2242
2243 </ul>
2244
2245 <h3>Changes in CUPS 1.2.8</h3>
2246
2247 <ul>
2248
2249         <li>Added section on supported PostScript commands for raster
2250         drivers</li>
2251
2252 </ul>
2253
2254 <h3>Changes in CUPS 1.2</h3>
2255
2256 <ul>
2257
2258         <li>Added globalization support keywords</li>
2259
2260         <li>Added custom option values support</li>
2261
2262         <li>Added <a href='#APHelpBook'><tt>APHelpBook</tt></a> keyword</li>
2263
2264         <li>Added <a href='#APDuplexRequiresFlippedMargin'><tt>APDuplexRequiresFlippedMargin</tt></a>
2265         keyword</li>
2266
2267         <li>Added <a href='#cupsICCProfile'><tt>cupsICCProfile</tt></a> keyword</li>
2268
2269         <li>Added <a href='#cupsIPPReason'><tt>cupsIPPReason</tt></a> keyword</li>
2270
2271         <li>Added <a href='#cupsLanguages'><tt>cupsLanguages</tt></a> keyword</li>
2272
2273         <li>Added <a href='#cupsPortMonitor'><tt>cupsPortMonitor</tt></a> keyword</li>
2274
2275         <li>Removed <tt>cupsProtocol</tt> keyword</li>
2276
2277 </ul>
2278
2279 <h3>Changes in CUPS 1.1</h3>
2280
2281 <ul>
2282
2283         <li>Added <a href='#cupsFlipDuplex'><tt>cupsFlipDuplex</tt></a> keyword</li>
2284
2285         <li>Added <tt>cupsProtocol</tt> keyword</li>
2286
2287 </ul>
2288 </div>
2289 </body>
2290 </html>