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-2011 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="#cupsFilter2">cupsFilter2</a></li>
 408         <li><a href="#cupsFlipDuplex">cupsFlipDuplex</a></li>
 409         <li><a href="#cupsIPPFinishings">cupsIPPFinishings</a></li>
 410         <li><a href="#cupsIPPReason">cupsIPPReason</a></li>
 411         <li><a href="#cupsIPPSupplies">cupsIPPSupplies</a></li>
 412         <li><a href="#cupsLanguages">cupsLanguages</a></li>
 413         <li><a href="#cupsManualCopies">cupsManualCopies</a></li>
 414         <li><a href="#cupsMarkerName">cupsMarkerName</a></li>
 415         <li><a href="#cupsMarkerNotice">cupsMarkerNotice</a></li>
 416         <li><a href="#cupsMaxCopies">cupsMaxCopies</a></li>
 417         <li><a href="#cupsModelNumber">cupsModelNumber</a></li>
 418         <li><a href="#cupsPJLCharset">cupsPJLCharset</a></li>
 419         <li><a href="#cupsPJLDisplay">cupsPJLDisplay</a></li>
 420         <li><a href="#cupsPortMonitor">cupsPortMonitor</a></li>
 421         <li><a href="#cupsPreFilter">cupsPreFilter</a></li>
 422         <li><a href="#cupsPrintQuality">cupsPrintQuality</a></li>
 423         <li><a href="#cupsSingleFile">cupsSingleFile</a></li>
 424         <li><a href="#cupsSNMPSupplies">cupsSNMPSupplies</a></li>
 425         <li><a href="#cupsVersion">cupsVersion</a></li>
 426         <li><a href="#JCLToPDFInterpreter">JCLToPDFInterpreter</a></li>
 427 </ul></li>
 428 <li><a href="#MACOSX">Mac OS X Attributes</a><ul class="subcontents">
 429         <li><a href="#APDialogExtension">APDialogExtension</a></li>
 430         <li><a href="#APDuplexRequiresFlippedMargin">APDuplexRequiresFlippedMargin</a></li>
 431         <li><a href="#APHelpBook">APHelpBook</a></li>
 432         <li><a href="#APICADriver">APICADriver</a></li>
 433         <li><a href="#APPrinterIconPath">APPrinterIconPath</a></li>
 434         <li><a href="#APPrinterLowInkTool">APPrinterLowInkTool</a></li>
 435         <li><a href="#APPrinterPreset">APPrinterPreset</a></li>
 436         <li><a href="#APPrinterUtilityPath">APPrinterUtilityPath</a></li>
 437         <li><a href="#APScannerOnly">APScannerOnly</a></li>
 438         <li><a href="#APScanAppBundleID">APScanAppBundleID</a></li>
 439 </ul></li>
 440 <li><a href="#HISTORY">Change History</a></li>
 441 </ul>
 442 <h2 class='title'><a name='SYNTAX'>PPD File Syntax</a></h2>
 443
 444 <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>
 445
 446 <pre class='command'>
 447 PPD-FILE = HEADER +(DATA / COMMENT / LINE-END)
 448
 449 HEADER   = "*PPD-Adobe:" *WSP DQUOTE VERSION DQUOTE LINE-END
 450
 451 VERSION  = "4.0" / "4.1" / "4.2" / "4.3"
 452
 453 COMMENT  = "*%" *TCHAR LINE-END
 454
 455 DATA     = "*" 1*KCHAR [ WSP 1*KCHAR [ "/" 1*TCHAR ] ] ":"
 456            1*(*WSP VALUE) LINE-END
 457
 458 VALUE    = 1*TCHAR / DQUOTE 1*SCHAR DQUOTE
 459
 460 KCHAR    = ALPHA / DIGIT / "_" / "." / "-"
 461
 462 SCHAR    = LINE-END / WSP / %x21.23-7E.A0-FF
 463
 464 TCHAR    = %x20-7E.A0-FF
 465
 466 LINE-END = CR / LF / CR LF
 467 </pre>
 468
 469
 470 <h2 class='title'><a name='AUTOCONFIG'>Auto-Configuration</a></h2>
 471
 472 <p>CUPS supports several methods of auto-configuration via PPD keywords.</p>
 473
 474 <h3><span class='info'>Mac OS X 10.5</span><a name='APAutoSetupTool'>APAutoSetupTool</a></h3>
 475
 476 <p class='summary'>*APAutoSetupTool: "/LibraryPrinters/vendor/filename"</p>
 477
 478 <p>This Mac OS X 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>
 479
 480 <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>
 481
 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>ColorModel</tt>, <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>cupsICCQualifier1</tt>, <tt>cupsICCQualifier2</tt>, and <tt>cupsICCQualifier3</tt> keywords define the mapping from selector to main keyword:</p>
 610
 611 <pre class='command'>
 612 *cupsICCQualifier1: MainKeyword1
 613 *cupsICCQualifier2: MainKeyword2
 614 *cupsICCQualifier3: MainKeyword3
 615 </pre>
 616
 617 <p>The default mapping is as follows:</p>
 618
 619 <pre class='command'>
 620 *cupsICCQualifier1: ColorModel
 621 *cupsICCQualifier2: MediaType
 622 *cupsICCQualifier3: Resolution
 623 </pre>
 624
 625 <h3><span class='info'>Mac OS X 10.4</span><a name='APCustom'>Custom Color Matching Support</a></h3>
 626
 627 <p class='summary'>*<a href='#APSupportsCustomColorMatching'>APSupportsCustomColorMatching</a>: true<br>
 628 *<a href='#APCustomColorMatchingName'>APCustomColorMatchingName</a> name/text: ""<br>
 629 *<a href='#APCustomColorMatchingProfile'>APCustomColorMatchingProfile</a>: profile<br>
 630 *<a href='#APDefaultCustomColorMatchingProfile'>APDefaultCustomColorMatchingProfile</a>: profile</p>
 631
 632 <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>
 633
 634 <blockquote><b>Note:</b>
 635
 636 <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>
 637
 638 </blockquote>
 639
 640 <h4><span class='info'>Mac OS X 10.5</span><a name='APCustomColorMatchingName'>APCustomColorMatchingName</a></h4>
 641
 642 <p class='summary'>*APCustomColorMatchingName name/text: ""</p>
 643
 644 <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>
 645
 646 <p>Examples:</p>
 647
 648 <pre class='command'>
 649 *% Define the names for our color matching...
 650 *APCustomColorMatchingName name/AcmeColor(tm): ""
 651 *fr.APCustomColorMatchingName name/La AcmeColor(tm): ""
 652 </pre>
 653
 654 <h4><span class='info'>Mac OS X 10.5</span><a name='APCustomColorMatchingProfile'>APCustomColorMatchingProfile</a></h4>
 655
 656 <p class='summary'>*APCustomColorMatchingProfile: name</p>
 657
 658 <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>
 659
 660 <blockquote><b>Note:</b>
 661
 662 <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>
 663
 664 </blockquote>
 665
 666 <p>Examples:</p>
 667
 668 <pre class='command'>
 669 *% Use sRGB for RGB color by default, but support both sRGB and AdobeRGB
 670 *APSupportsCustomColorMatching: true
 671 *APDefaultCustomColorMatchingProfile: sRGB
 672 *APCustomColorMatchingProfile: sRGB
 673 *APCustomColorMatchingProfile: AdobeRGB
 674 </pre>
 675
 676 <h4><span class='info'>Mac OS X 10.5</span><a name='APDefaultCustomColorMatchingProfile'>APDefaultCustomColorMatchingProfile</a></h4>
 677
 678 <p class='summary'>*APDefaultCustomColorMatchingProfile: name</p>
 679
 680 <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>
 681
 682 <p>Examples:</p>
 683
 684 <pre class='command'>
 685 *% Use sRGB for RGB color by default
 686 *APSupportsCustomColorMatching: true
 687 *APDefaultCustomColorMatchingProfile: sRGB
 688 </pre>
 689
 690 <h4><span class='info'>Mac OS X 10.4</span><a name='APSupportsCustomColorMatching'>APSupportsCustomColorMatching</a></h4>
 691
 692 <p class='summary'>*APSupportsCustomColorMatching: boolean</p>
 693
 694 <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>
 695
 696 <p>The default for <tt>APSupportsCustomColorMatching</tt> is <tt>false</tt>.</p>
 697
 698 <p>Examples:</p>
 699
 700 <pre class='command'>
 701 *APSupportsCustomColorMatching: true
 702 *APDefaultCustomColorMatchingProfile: sRGB
 703 </pre>
 704
 705
 706 <h2 class='title'><a name='CONSTRAINTS'>Constraints</a></h2>
 707
 708 <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>
 709
 710 <pre class='command'>
 711 *% Do not allow 2-sided printing on transparency media
 712 *UIConstraints: "*Duplex *MediaType Transparency"
 713 *UIConstraints: "*MediaType Transparency *Duplex"
 714 </pre>
 715
 716 <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>
 717
 718 <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>
 719
 720 <blockquote><b>Note:</b>
 721
 722 <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>
 723
 724 </blockquote>
 725
 726 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsUIConstraints'>cupsUIConstraints</a></h3>
 727
 728 <p class='summary'>*cupsUIConstraints resolver: "*Keyword1 *Keyword2 ..."<br>
 729 *cupsUIConstraints resolver: "*Keyword1 OptionKeyword1 *Keyword2 ..."<br>
 730 *cupsUIConstraints resolver: "*Keyword1 *Keyword2 OptionKeyword2 ..."<br>
 731 *cupsUIConstraints resolver: "*Keyword1 OptionKeyword1 *Keyword2 OptionKeyword2 ..."<br>
 732 *cupsUIConstraints: "*InstallableKeyword1 OptionKeyword1 *Keyword2 OptionKeyword2 ..."</p>
 733
 734 <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>
 735
 736 <p>Examples:</p>
 737
 738 <pre class='command'>
 739 <em>*% Specify that 2-sided printing cannot happen on transparencies</em>
 740 *cupsUIConstraints transparency: "*Duplex *MediaType Transparency"
 741
 742 <em>*% Specify that envelope printing cannot happen from the paper trays</em>
 743 *cupsUIConstraints envelope: "*PageSize Env10 *InputSlot Tray1"
 744 *cupsUIConstraints envelope: "*PageSize Env10 *InputSlot Tray1"
 745 *cupsUIConstraints envelope: "*PageSize EnvDL *InputSlot Tray2"
 746 *cupsUIConstraints envelope: "*PageSize EnvDL *InputSlot Tray2"
 747
 748 <em>*% Specify an installable option constraint for the envelope feeder</em>
 749 *cupsUIConstraints: "*InputSlot EnvFeeder *InstalledEnvFeeder"
 750
 751 <em>*% Specify that photo printing cannot happen on plain paper or transparencies at 1200dpi</em>
 752 *cupsUIConstraints photo: "*OutputMode Photo *MediaType Plain *Resolution 1200dpi"
 753 *cupsUIConstraints photo: "*OutputMode Photo *MediaType Transparency *Resolution 1200dpi"
 754 </pre>
 755
 756 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsUIResolver'>cupsUIResolver</a></h3>
 757
 758 <p class='summary'>*cupsUIResolver resolver: "*Keyword1 OptionKeyword1 *Keyword2 OptionKeyword2 ..."</p>
 759
 760 <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>
 761
 762 <p>Examples:</p>
 763
 764 <pre class='command'>
 765 <em>*% Specify the options to change for the 2-sided transparency constraint</em>
 766 *cupsUIResolver transparency: "*Duplex None *MediaType Plain"
 767
 768 <em>*% Specify the options to change for the envelope printing constraints.  Notice
 769 *% that we try to change the InputSlot to either the envelope feeder or the
 770 *% manual feed first, then we change the page size...</em>
 771 *cupsUIResolver envelope: "*InputSlot EnvFeeder *InputSlot ManualFeed *PageSize Letter"
 772
 773 <em>*% Specify the options to change for the photo printing constraints</em>
 774 *cupsUIResolver photo: "*OutputMode Best *Resolution 600dpi"
 775 </pre>
 776
 777
 778 <h2 class='title'><a name='I18N'>Globalized PPD Support</a></h2>
 779
 780 <p>CUPS 1.2 and higher adds support for PPD files containing multiple languages by following the following additional rules:</p>
 781
 782 <ol>
 783
 784         <li>The <tt>LanguageVersion</tt> MUST be <tt>English</tt></li>
 785
 786         <li>The <tt>LanguageEncoding</tt> MUST be <tt>ISOLatin1</tt></li>
 787
 788         <li>The <tt>cupsLanguages</tt> keyword MUST be provided and list each of the supported locales in the PPD file</li>
 789
 790         <li>Main and option keywords MUST NOT exceed 34 (instead of 40) characters to allow room for the locale prefixes in translation keywords</li>
 791
 792         <li>The main keyword "Translation" MUST NOT be used</li>
 793
 794         <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>
 795
 796         <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>
 797                 <li>A generic language translation ("ll") SHOULD be provided with country-specific differences ("ll_CC") provided only as needed</li>
 798                 <li>For historical reasons, the "zh" and "zh_CN" locales map to Simplified Chinese while the "zh_TW" locale maps to Traditional Chinese</li>
 799         </ul></li>
 800
 801         <li>Locale-specific translation strings MUST be encoded using UTF-8.</li>
 802
 803         <li>Main keywords MUST be localized using one of the following forms:
 804         <p><tt>*ll.Translation MainKeyword/translation text: ""</tt><br />
 805         <tt>*ll_CC.Translation MainKeyword/translation text: ""</tt></p></li>
 806
 807         <li>Option keywords MUST be localized using one of the following forms:
 808         <p><tt>*ll.MainKeyword OptionKeyword/translation text: ""</tt><br>
 809         <tt>*ll_CC.MainKeyword OptionKeyword/translation text: ""</tt></p></li>
 810
 811         <li>Localization keywords MAY appear anywhere after the first line of the PPD file</li>
 812
 813 </ol>
 814
 815 <blockquote><b>Note:</b>
 816
 817 <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>
 818
 819 </blockquote>
 820
 821 <p>Examples:</p>
 822
 823 <pre class='command'>
 824 *LanguageVersion: English
 825 *LanguageEncoding: ISOLatin1
 826 *cupsLanguages: "de fr_CA"
 827 *ModelName: "Foobar Laser 9999"
 828
 829 <em>*% Localize ModelName for French and German</em>
 830 *fr_CA.Translation ModelName/La Foobar Laser 9999: ""
 831 *de.Translation ModelName/Foobar LaserDrucken 9999: ""
 832
 833 *cupsIPPReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html"
 834 <em>*% Localize printer-state-reason for French and German</em>
 835 *fr_CA.cupsIPPReason com.vendor-error/Une erreur s&egrave;rieuse s'est produite: "/help/com.vendor/error.html"
 836 *de.cupsIPPReason com.vendor-error/Eine ernste St&ouml;rung trat: "/help/com.vendor/error.html"
 837
 838 ...
 839
 840 *OpenUI *InputSlot/Paper Source: PickOne
 841 *OrderDependency: 10 AnySetup *InputSlot
 842 *DefaultInputSlot: Auto
 843 <em>*% Localize InputSlot for French and German</em>
 844 *fr_CA.Translation InputSlot/Papier source: ""
 845 *de.Translation InputSlot/Papiereinzug: ""
 846 *InputSlot Auto/Default: "&lt;&lt;/ManualFeed false&gt;&gt;setpagedevice"
 847 <em>*% Localize InputSlot=Auto for French and German</em>
 848 *fr_CA.InputSlot Auto/Par Defaut: ""
 849 *de.InputSlot Auto/Standard: ""
 850 *InputSlot Manual/Manual Feed: "&lt;&lt;/ManualFeed true&gt;&gt;setpagedevice"
 851 <em>*% Localize InputSlot=Manual for French and German</em>
 852 *fr_CA.InputSlot Manual/Manuel mecanisme de alimentation: ""
 853 *de.InputSlot Manual/Manueller Einzug: ""
 854 *CloseUI: *InputSlot
 855 </pre>
 856
 857
 858 <h2 class='title'><a name='OPTIONS'><span class="info">CUPS 1.3/Mac OS X 10.6</span>Custom Options</a></h2>
 859
 860 <p>CUPS supports custom options using an extension of the <tt>CustomPageSize</tt> and <tt>ParamCustomPageSize</tt> syntax:</p>
 861
 862 <pre class='command'>
 863 *CustomFoo True: "command"
 864 *ParamCustomFoo Name1/Text 1: order type minimum maximum
 865 *ParamCustomFoo Name2/Text 2: order type minimum maximum
 866 ...
 867 *ParamCustomFoo NameN/Text N: order type minimum maximum
 868 </pre>
 869
 870 <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
 871 option value is "1234" then CUPS will output the string "@PJL SET PASSCODE=1234".</p>
 872
 873 <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>
 874
 875 <p>The "type" is one of the following keywords:</p>
 876
 877 <ul>
 878
 879         <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>
 880
 881         <li><tt>int</tt> - an integer value from "minimum" to "maximum"</li>
 882
 883         <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>
 884
 885         <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>
 886
 887         <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>
 888
 889         <li><tt>points</tt> - a measurement value in points from "minimum" to "maximum"</li>
 890
 891         <li><tt>real</tt> - a real value from "minimum" to "maximum"</li>
 892
 893         <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>
 894
 895 </ul>
 896
 897 <p>Examples:</p>
 898
 899 <pre class='command'>
 900 <em>*% Base JCL key code option</em>
 901 *JCLOpenUI JCLPasscode/Key Code: PickOne
 902 *OrderDependency: 10 JCLSetup *JCLPasscode
 903 *DefaultJCLPasscode: None
 904 *JCLPasscode None/No Code: ""
 905 *JCLPasscode 1111: "@PJL SET PASSCODE = 1111&lt;0A&gt;"
 906 *JCLPasscode 2222: "@PJL SET PASSCODE = 2222&lt;0A&gt;"
 907 *JCLPasscode 3333: "@PJL SET PASSCODE = 3333&lt;0A&gt;"
 908 *JCLCloseUI: *JCLPasscode
 909
 910 <em>*% Custom JCL key code option</em>
 911 *CustomJCLPasscode True: "@PJL SET PASSCODE = \1&lt;0A&gt;"
 912 *ParamCustomJCLPasscode Code/Key Code: 1 passcode 4 4
 913
 914
 915 <em>*% Base PostScript watermark option</em>
 916 *OpenUI WatermarkText/Watermark Text: PickOne
 917 *OrderDependency: 10 AnySetup *WatermarkText
 918 *DefaultWatermarkText: None
 919 *WatermarkText None: ""
 920 *WatermarkText Draft: "&lt;&lt;/cupsString1(Draft)&gt;&gt;setpagedevice"
 921 *CloseUI: *WatermarkText
 922
 923 <em>*% Custom PostScript watermark option</em>
 924 *CustomWatermarkText True: "&lt;&lt;/cupsString1 3 -1 roll&gt;&gt;setpagedevice"
 925 *ParamCustomWatermarkText Text: 1 string 0 32
 926
 927
 928 <em>*% Base PostScript gamma/density option</em>
 929 *OpenUI GammaDensity/Gamma and Density: PickOne
 930 *OrderDependency: 10 AnySetup *GammaDensity
 931 *DefaultGammaDensity: Normal
 932 *GammaDensity Normal/Normal: "&lt;&lt;/cupsReal1 1.0/cupsReal2 1.0&gt;&gt;setpagedevice"
 933 *GammaDensity Light/Lighter: "&lt;&lt;/cupsReal1 0.9/cupsReal2 0.67&gt;&gt;setpagedevice"
 934 *GammaDensity Dark/Darker: "&lt;&lt;/cupsReal1 1.1/cupsReal2 1.5&gt;&gt;setpagedevice"
 935 *CloseUI: *GammaDensity
 936
 937 <em>*% Custom PostScript gamma/density option</em>
 938 *CustomGammaDensity True: "&lt;&lt;/cupsReal1 3 -1 roll/cupsReal2 5 -1&gt;&gt;setpagedevice"
 939 *ParamCustomGammaDensity Gamma: 1 curve 0.1 10
 940 *ParamCustomGammaDensity Density: 2 real 0 2
 941 </pre>
 942
 943
 944 <h2 class='title'><a name='RASTERPS'>Writing PostScript Option Commands for Raster Drivers</a></h2>
 945
 946 <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>
 947
 948 <pre class='command'>
 949 *PageSize A4: "&lt;&lt;/PageSize[595 842]&gt;&gt;setpagedevice"
 950 </pre>
 951
 952 <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>
 953
 954 <pre class='command'>
 955 *CustomWatermarkText True: "&lt;&lt;/cupsString1 3 -1 roll&gt;&gt;setpagedevice"
 956 </pre>
 957
 958 <p>For a custom string value of "My Watermark", CUPS will produce the following PostScript code for the option:</p>
 959
 960 <pre class='command'>
 961 (My Watermark)
 962 &lt;&lt;/cupsString1 3 -1 roll&gt;&gt;setpagedevice
 963 </pre>
 964
 965 <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>
 966
 967 <pre class='command'>
 968 &lt;&lt;/cupsString1(My Watermark)&gt;&gt;setpagedevice
 969 </pre>
 970
 971 <p>The resulting dictionary sets the page device attributes that are sent to your raster driver in the page header.</p>
 972
 973 <h3>Custom Page Size Code</a></h3>
 974
 975 <p>There are many possible implementations of the <tt>CustomPageSize</tt> code. For CUPS raster drivers, the following code is recommended:</p>
 976
 977 <pre class='command'>
 978 *ParamCustomPageSize Width:        1 points <i>min-width max-width</i>
 979 *ParamCustomPageSize Height:       2 points <i>min-height max-height</i>
 980 *ParamCustomPageSize WidthOffset:  3 points 0 0
 981 *ParamCustomPageSize HeightOffset: 4 points 0 0
 982 *ParamCustomPageSize Orientation:  5 int 0 0
 983 *CustomPageSize True: "pop pop pop &lt;&lt;/PageSize[5 -2 roll]/ImagingBBox null&gt;&gt;setpagedevice"
 984 </pre>
 985
 986 <h3>Supported PostScript Operators</a></h3>
 987
 988 <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>
 989
 990 <ul>
 991
 992         <li><tt>&lt;&lt;</tt> - Start a dictionary.</li>
 993
 994         <li><tt>&gt;&gt;</tt> - End a dictionary.</li>
 995
 996         <li><tt>[</tt> - Start an array.</li>
 997
 998         <li><tt>]</tt> - End an array.</li>
 999
1000         <li><tt>copy</tt> - Copy the top N objects on the stack.</li>
1001
1002         <li><tt>dup</tt> - Copy the top object on the stack.</li>
1003
1004         <li><tt>index</tt> - Copy the Nth from the top object on the stack.</li>
1005
1006         <li><tt>pop</tt> - Pop the top object on the stack.</li>
1007
1008         <li><tt>roll</tt> - Shift the top N objects on the stack.</li>
1009
1010         <li><tt>setpagedevice</tt> - Set the page header values according to the key/value dictionary on the stack.</li>
1011
1012 </ul>
1013
1014 <blockquote><b>Note:</b>
1015
1016 <p><em>Never</em> use the unsupported <tt>dict</tt> or <tt>put</tt>
1017 operators in your option code. These operators are typically used in
1018 option code dating back to Level 1 PostScript printers, which did not
1019 support the simpler <tt>&lt;&lt;</tt> or <tt>&gt;&gt;</tt> operators.
1020 If you have old option code using <tt>dict</tt> or <tt>put</tt>, you can
1021 rewrite it very easily to use the newer <tt>&lt;&lt;</tt> and
1022 <tt>&gt;&gt;</tt> operators instead. For example, the following code
1023 to set the page size:</p>
1024
1025 <style type='text/css'><!--
1026 PRE B {
1027   background: #000000;
1028   color: #ffffff;
1029   padding: 2px 5px;
1030 }
1031 --></style>
1032
1033 <pre class='command'>
1034 <b>1 dict dup</b> /PageSize [612 792] <b>put</b> setpagedevice
1035 </pre>
1036
1037 <p>can be rewritten as:</p>
1038
1039 <pre class='command'>
1040 <b>&lt;&lt;</b> /PageSize [612 792] <b>&gt;&gt;</b> setpagedevice
1041 </pre>
1042
1043 </blockquote>
1044
1045 <h3>Supported Page Device Attributes</a></h3>
1046
1047 <p>Table 2 shows the supported page device attributes along with PostScript code examples.</p>
1048
1049 <div class='table'>
1050 <table summary='Supported Page Device Attributes'>
1051 <caption>Table 2: <a name='TABLE_2'>Supported Page Device Attributes</a></caption>
1052 <thead>
1053 <tr>
1054         <th>Name(s)</th>
1055         <th>Type</th>
1056         <th>Description</th>
1057         <th>Example(s)</th>
1058 </tr>
1059 </thead>
1060 <tbody>
1061 <tr valign='top'>
1062         <td><tt>AdvanceDistance</tt></td>
1063         <td>Integer</td>
1064         <td>Specifies the number of points to advance roll media after printing.</td>
1065         <td><tt>&lt;&lt;/AdvanceDistance 18&gt;&gt;setpagedevice</tt></td>
1066 </tr>
1067 <tr valign='top'>
1068         <td><tt>AdvanceMedia</tt></td>
1069         <td>Integer</td>
1070         <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>
1071         <td><tt>&lt;&lt;/AdvanceMedia 4&gt;&gt;setpagedevice</tt></td>
1072 </tr>
1073 <tr valign='top'>
1074         <td><tt>Collate</tt></td>
1075         <td>Boolean</td>
1076         <td>Specifies whether collated copies are required.</td>
1077         <td><tt>&lt;&lt;/Collate true&gt;&gt;setpagedevice</tt></td>
1078 </tr>
1079 <tr valign='top'>
1080         <td><tt>CutMedia</tt></td>
1081         <td>Integer</td>
1082         <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>
1083         <td><tt>&lt;&lt;/CutMedia 1&gt;&gt;setpagedevice</tt></td>
1084 </tr>
1085 <tr valign='top'>
1086         <td><tt>Duplex</tt></td>
1087         <td>Boolean</td>
1088         <td>Specifies whether 2-sided printing is required.</td>
1089         <td><tt>&lt;&lt;/Duplex true&gt;&gt;setpagedevice</tt></td>
1090 </tr>
1091 <tr valign='top'>
1092         <td><tt>HWResolution</tt></td>
1093         <td>Integer Array</td>
1094         <td>Specifies the resolution of the page image in pixels per inch.</td>
1095         <td><tt>&lt;&lt;/HWResolution[1200 1200]&gt;&gt;setpagedevice</tt></td>
1096 </tr>
1097 <tr valign='top'>
1098         <td><tt>InsertSheet</tt></td>
1099         <td>Boolean</td>
1100         <td>Specifies whether to insert a blank sheet before the job.</td>
1101         <td><tt>&lt;&lt;/InsertSheet true&gt;&gt;setpagedevice</tt></td>
1102 </tr>
1103 <tr valign='top'>
1104         <td><tt>Jog</tt></td>
1105         <td>Integer</td>
1106         <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>
1107         <td><tt>&lt;&lt;/Jog 2&gt;&gt;setpagedevice</tt></td>
1108 </tr>
1109 <tr valign='top'>
1110         <td><tt>LeadingEdge</tt></td>
1111         <td>Integer</td>
1112         <td>Specifies the leading edge of the media: 0 = top, 1 = right, 2 = bottom, 3 = left.</td>
1113         <td><tt>&lt;&lt;/LeadingEdge 0&gt;&gt;setpagedevice</tt></td>
1114 </tr>
1115 <tr valign='top'>
1116         <td><tt>ManualFeed</tt></td>
1117         <td>Boolean</td>
1118         <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>
1119         <td><tt>&lt;&lt;/ManualFeed true&gt;&gt;setpagedevice</tt></td>
1120 </tr>
1121 <tr valign='top'>
1122         <td><tt>MediaClass</tt></td>
1123         <td>String</td>
1124         <td>Specifies a named media.</td>
1125         <td><tt>&lt;&lt;/MediaClass (Invoices)&gt;&gt;setpagedevice</tt></td>
1126 </tr>
1127 <tr valign='top'>
1128         <td><tt>MediaColor</tt></td>
1129         <td>String</td>
1130         <td>Specifies the color of the media.</td>
1131         <td><tt>&lt;&lt;/MediaColor &gt;&gt;setpagedevice</tt></td>
1132 </tr>
1133 <tr valign='top'>
1134         <td><tt>MediaPosition</tt></td>
1135         <td>Integer</td>
1136         <td>Specifies the tray or source of the media.</td>
1137         <td><tt>&lt;&lt;/MediaPosition 12&gt;&gt;setpagedevice</tt></td>
1138 </tr>
1139 <tr valign='top'>
1140         <td><tt>MediaType</tt></td>
1141         <td>String</td>
1142         <td>Specifies the general media type.</td>
1143         <td><tt>&lt;&lt;/MediaType (Glossy)&gt;&gt;setpagedevice</tt></td>
1144 </tr>
1145 <tr valign='top'>
1146         <td><tt>MediaWeight</tt></td>
1147         <td>Integer</td>
1148         <td>Specifies the media weight in grams per meter<sup>2</sup>.</td>
1149         <td><tt>&lt;&lt;/MediaWeight 100&gt;&gt;setpagedevice</tt></td>
1150 </tr>
1151 <tr valign='top'>
1152         <td><tt>MirrorPrint</tt></td>
1153         <td>Boolean</td>
1154         <td>Specifies whether to flip the output image horizontally.</td>
1155         <td><tt>&lt;&lt;/MirrorPrint true&gt;&gt;setpagedevice</tt></td>
1156 </tr>
1157 <tr valign='top'>
1158         <td><tt>NegativePrint</tt></td>
1159         <td>Boolean</td>
1160         <td>Specifies whether to invert the output image.</td>
1161         <td><tt>&lt;&lt;/NegativePrint true&gt;&gt;setpagedevice</tt></td>
1162 </tr>
1163 <tr valign='top'>
1164         <td><tt>NumCopies</tt></td>
1165         <td>Integer</td>
1166         <td>Specifies the number of copies to produce of each page.</td>
1167         <td><tt>&lt;&lt;/NumCopies 100&gt;&gt;setpagedevice</tt></td>
1168 </tr>
1169 <tr valign='top'>
1170         <td><tt>Orientation</tt></td>
1171         <td>Integer</td>
1172         <td>Specifies the orientation of the output: 0 = portrait, 1 = landscape rotated counter-clockwise, 2 = upside-down, 3 = landscape rotated clockwise.</td>
1173         <td><tt>&lt;&lt;/Orientation 3&gt;&gt;setpagedevice</tt></td>
1174 </tr>
1175 <tr valign='top'>
1176         <td><tt>OutputFaceUp</tt></td>
1177         <td>Boolean</td>
1178         <td>Specifies whether to place the media face-up in the output bin/tray.</td>
1179         <td><tt>&lt;&lt;/OutputFaceUp true&gt;&gt;setpagedevice</tt></td>
1180 </tr>
1181 <tr valign='top'>
1182         <td><tt>OutputType</tt></td>
1183         <td>String</td>
1184         <td>Specifies the output type name.</td>
1185         <td><tt>&lt;&lt;/OutputType (Photo)&gt;&gt;setpagedevice</tt></td>
1186 </tr>
1187 <tr valign='top'>
1188         <td><tt>PageSize</tt></td>
1189         <td>Integer/Real Array</td>
1190         <td>Specifies the width and length/height of the page in points.</td>
1191         <td><tt>&lt;&lt;/PageSize[595 842]&gt;&gt;setpagedevice</tt></td>
1192 </tr>
1193 <tr valign='top'>
1194         <td><tt>Separations</tt></td>
1195         <td>Boolean</td>
1196         <td>Specifies whether to produce color separations.</td>
1197         <td><tt>&lt;&lt;/Separations true&gt;&gt;setpagedevice</tt></td>
1198 </tr>
1199 <tr valign='top'>
1200         <td><tt>TraySwitch</tt></td>
1201         <td>Boolean</td>
1202         <td>Specifies whether to switch trays automatically.</td>
1203         <td><tt>&lt;&lt;/TraySwitch true&gt;&gt;setpagedevice</tt></td>
1204 </tr>
1205 <tr valign='top'>
1206         <td><tt>Tumble</tt></td>
1207         <td>Boolean</td>
1208         <td>Specifies whether the back sides of pages are rotated 180 degrees.</td>
1209         <td><tt>&lt;&lt;/Tumble true&gt;&gt;setpagedevice</tt></td>
1210 </tr>
1211 <tr valign='top'>
1212         <td><tt>cupsBorderlessScalingFactor</tt></td>
1213         <td>Real</td>
1214         <td>Specifies the amount to scale the page image dimensions.</td>
1215         <td><tt>&lt;&lt;/cupsBorderlessScalingFactor 1.01&gt;&gt;setpagedevice</tt></td>
1216 </tr>
1217 <tr valign='top'>
1218         <td><tt>cupsColorOrder</tt></td>
1219         <td>Integer</td>
1220         <td>Specifies the order of colors: 0 = chunked, 1 = banded, 2 = planar.</td>
1221         <td><tt>&lt;&lt;/cupsColorOrder 0&gt;&gt;setpagedevice</tt></td>
1222 </tr>
1223 <tr valign='top'>
1224         <td><tt>cupsColorSpace</tt></td>
1225         <td>Integer</td>
1226         <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>
1227         <td><tt>&lt;&lt;/cupsColorSpace 1 &gt;&gt;setpagedevice</tt></td>
1228 </tr>
1229 <tr valign='top'>
1230         <td><tt>cupsCompression</tt></td>
1231         <td>Integer</td>
1232         <td>Specifies a driver compression type/mode.</td>
1233         <td><tt>&lt;&lt;/cupsCompression 2&gt;&gt;setpagedevice</tt></td>
1234 </tr>
1235 <tr valign='top'>
1236         <td><tt>cupsInteger0<br>
1237         ...<br>
1238         cupsInteger15</tt></td>
1239         <td>Integer</td>
1240         <td>Specifies driver integer values.</td>
1241         <td><tt>&lt;&lt;/cupsInteger11 1234&gt;&gt;setpagedevice</tt></td>
1242 </tr>
1243 <tr valign='top'>
1244         <td><tt>cupsMarkerType</tt></td>
1245         <td>String</td>
1246         <td>Specifies the type of ink/toner to use.</td>
1247         <td><tt>&lt;&lt;/cupsMarkerType (Black+Color)&gt;&gt;setpagedevice</tt></td>
1248 </tr>
1249 <tr valign='top'>
1250         <td><tt>cupsMediaType</tt></td>
1251         <td>Integer</td>
1252         <td>Specifies a numeric media type.</td>
1253         <td><tt>&lt;&lt;/cupsMediaType 999&gt;&gt;setpagedevice</tt></td>
1254 </tr>
1255 <tr valign='top'>
1256         <td><tt>cupsPageSizeName</tt></td>
1257         <td>String</td>
1258         <td>Specifies the name of the page size.</td>
1259         <td><tt>&lt;&lt;/cupsPageSizeName (A4.Full)&gt;&gt;setpagedevice</tt></td>
1260 </tr>
1261 <tr valign='top'>
1262         <td><tt>cupsPreferredBitsPerColor</tt></td>
1263         <td>Integer</td>
1264         <td>Specifies the preferred number of bits per color, typically 8 or 16.</td>
1265         <td><tt>&lt;&lt;/cupsPreferredBitsPerColor 16&gt;&gt;setpagedevice</tt></td>
1266 </tr>
1267 <tr valign='top'>
1268         <td><tt>cupsReal0<br>
1269         ...<br>
1270         cupsReal15</tt></td>
1271         <td>Real</td>
1272         <td>Specifies driver real number values.</td>
1273         <td><tt>&lt;&lt;/cupsReal15 1.234&gt;&gt;setpagedevice</tt></td>
1274 </tr>
1275 <tr valign='top'>
1276         <td><tt>cupsRenderingIntent</tt></td>
1277         <td>String</td>
1278         <td>Specifies the color rendering intent.</td>
1279         <td><tt>&lt;&lt;/cupsRenderingIntent (AbsoluteColorimetric)&gt;&gt;setpagedevice</tt></td>
1280 </tr>
1281 <tr valign='top'>
1282         <td><tt>cupsRowCount</tt></td>
1283         <td>Integer</td>
1284         <td>Specifies the number of rows of raster data to print on each line for some drivers.</td>
1285         <td><tt>&lt;&lt;/cupsRowCount 24&gt;&gt;setpagedevice</tt></td>
1286 </tr>
1287 <tr valign='top'>
1288         <td><tt>cupsRowFeed</tt></td>
1289         <td>Integer</td>
1290         <td>Specifies the number of rows to feed between passes for some drivers.</td>
1291         <td><tt>&lt;&lt;/cupsRowFeed 17&gt;&gt;setpagedevice</tt></td>
1292 </tr>
1293 <tr valign='top'>
1294         <td><tt>cupsRowStep</tt></td>
1295         <td>Integer</td>
1296         <td>Specifies the number of lines between columns/rows on the print head for some drivers.</td>
1297         <td><tt>&lt;&lt;/cupsRowStep 2&gt;&gt;setpagedevice</tt></td>
1298 </tr>
1299 <tr valign='top'>
1300         <td><tt>cupsString0<br>
1301         ...<br>
1302         cupsString15</tt></td>
1303         <td>String</td>
1304         <td>Specifies driver string values.</td>
1305         <td><tt>&lt;&lt;/cupsString0(String Value)&gt;&gt;setpagedevice</tt></td>
1306 </tr>
1307 </tbody>
1308 </table></div>
1309
1310
1311 <h2 class='title'><a name='MEDIA'>Media Keywords</a></h2>
1312
1313 <p>The CUPS media keywords allow drivers to specify alternate custom page
1314 size limits based on up to two options.</p>
1315
1316 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMediaQualifier2'>cupsMediaQualifier2</a></h3>
1317
1318 <p class='summary'>*cupsMediaQualifier2: MainKeyword</p>
1319
1320 <p>This keyword specifies the second option to use for overriding the
1321 custom page size limits.</p>
1322
1323 <p>Example:</p>
1324
1325 <pre class='command'>
1326 <em>*% Specify alternate custom page size limits based on InputSlot and Quality</em>
1327 *cupsMediaQualifier2: InputSlot
1328 *cupsMediaQualifier3: Quality
1329 *cupsMaxSize .Manual.: "1000 1000"
1330 *cupsMinSize .Manual.: "100 100"
1331 *cupsMinSize .Manual.Photo: "200 200"
1332 *cupsMinSize ..Photo: "300 300"
1333 </pre>
1334
1335 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMediaQualifier3'>cupsMediaQualifier3</a></h3>
1336
1337 <p class='summary'>*cupsMediaQualifier3: MainKeyword</p>
1338
1339 <p>This keyword specifies the third option to use for overriding the
1340 custom page size limits.</p>
1341
1342 <p>Example:</p>
1343
1344 <pre class='command'>
1345 <em>*% Specify alternate custom page size limits based on InputSlot and Quality</em>
1346 *cupsMediaQualifier2: InputSlot
1347 *cupsMediaQualifier3: Quality
1348 *cupsMaxSize .Manual.: "1000 1000"
1349 *cupsMinSize .Manual.: "100 100"
1350 *cupsMinSize .Manual.Photo: "200 200"
1351 *cupsMinSize ..Photo: "300 300"
1352 </pre>
1353
1354 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMinSize'>cupsMinSize</a></h3>
1355
1356 <p class='summary'>*cupsMinSize .Qualifier2.Qualifier3: "width length"<br>
1357 *cupsMinSize .Qualifier2.: "width length"<br>
1358 *cupsMinSize ..Qualifier3: "width length"</p>
1359
1360 <p>This keyword specifies alternate minimum custom page sizes in points.
1361 The <a href='#cupsMediaQualifier2'><tt>cupsMediaQualifier2</tt></a> and
1362 <a href='#cupsMediaQualifier3'><tt>cupsMediaQualifier3</tt></a> keywords
1363 are used to identify options to use for matching.</p>
1364
1365 <p>Example:</p>
1366
1367 <pre class='command'>
1368 <em>*% Specify alternate custom page size limits based on InputSlot and Quality</em>
1369 *cupsMediaQualifier2: InputSlot
1370 *cupsMediaQualifier3: Quality
1371 *cupsMaxSize .Manual.: "1000 1000"
1372 *cupsMinSize .Manual.: "100 100"
1373 *cupsMinSize .Manual.Photo: "200 200"
1374 *cupsMinSize ..Photo: "300 300"
1375 </pre>
1376
1377 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMaxSize'>cupsMaxSize</a></h3>
1378
1379 <p class='summary'>*cupsMaxSize .Qualifier2.Qualifier3: "width length"<br>
1380 *cupsMaxSize .Qualifier2.: "width length"<br>
1381 *cupsMaxSize ..Qualifier3: "width length"</p>
1382
1383 <p>This keyword specifies alternate maximum custom page sizes in points.
1384 The <a href='#cupsMediaQualifier2'><tt>cupsMediaQualifier2</tt></a> and
1385 <a href='#cupsMediaQualifier3'><tt>cupsMediaQualifier3</tt></a> keywords
1386 are used to identify options to use for matching.</p>
1387
1388 <p>Example:</p>
1389
1390 <pre class='command'>
1391 <em>*% Specify alternate custom page size limits based on InputSlot and Quality</em>
1392 *cupsMediaQualifier2: InputSlot
1393 *cupsMediaQualifier3: Quality
1394 *cupsMaxSize .Manual.: "1000 1000"
1395 *cupsMinSize .Manual.: "100 100"
1396 *cupsMinSize .Manual.Photo: "200 200"
1397 *cupsMinSize ..Photo: "300 300"
1398 </pre>
1399
1400
1401 <h2 class='title'><a name='ATTRIBUTES'>General Attributes</a></h2>
1402
1403 <h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsBackSide'>cupsBackSide</a></h3>
1404
1405 <p class='summary'>*cupsBackSide: keyword</p>
1406
1407 <p>This keyword requests special handling of the back side of pages
1408 when doing duplexed (2-sided) output. <a href='#TABLE_1'>Table 1</a>
1409 shows the supported keyword values for this keyword and their effect
1410 on the raster data sent to your driver. For example, when <tt>cupsBackSide</tt>
1411 is <code>Rotated</code> and <tt>Tumble</tt> is <tt>false</tt>, your driver
1412 will receive print data starting at the bottom right corner of the page, with
1413 each line going right-to-left instead of left-to-right. The default value is
1414 <code>Normal</code>.</p>
1415
1416 <blockquote><b>Note:</b>
1417
1418 <p><tt>cupsBackSide</tt> replaces the older <tt>cupsFlipDuplex</tt>
1419 keyword - if <tt>cupsBackSide</tt> is specified, <tt>cupsFlipDuplex</tt>
1420 will be ignored.</p>
1421
1422 </blockquote>
1423
1424 <div class='table'>
1425 <table width='80%' summary='Back Side Raster Coordinate System'>
1426 <caption>Table 1: <a name='TABLE_1'>Back Side Raster Coordinate System</a></caption>
1427 <thead>
1428 <tr>
1429         <th>cupsBackSide</th>
1430         <th>Tumble Value</th>
1431         <th>Image Presentation</th>
1432 </tr>
1433 </thead>
1434 <tbody>
1435 <tr>
1436         <td><code>Normal</code></td>
1437         <td><code>false</code></td>
1438         <td>Left-to-right, top-to-bottom</td>
1439 </tr>
1440 <tr>
1441         <td><code>Normal</code></td>
1442         <td><code>true</code></td>
1443         <td>Left-to-right, top-to-bottom</td>
1444 </tr>
1445 <tr>
1446         <td><code>ManualTumble</code></td>
1447         <td><code>false</code></td>
1448         <td>Left-to-right, top-to-bottom</td>
1449 </tr>
1450 <tr>
1451         <td><code>ManualTumble</code></td>
1452         <td><code>true</code></td>
1453         <td>Right-to-left, bottom-to-top</td>
1454 </tr>
1455 <tr>
1456         <td><code>Rotated</code></td>
1457         <td><code>false</code></td>
1458         <td>Right-to-left, bottom-to-top</td>
1459 </tr>
1460 <tr>
1461         <td><code>Rotated</code></td>
1462         <td><code>true</code></td>
1463         <td>Right-to-left, top-to-bottom</td>
1464 </tr>
1465 <tr>
1466         <td><code>Flipped</code> *</td>
1467         <td><code>false</code></td>
1468         <td>Left-to-right, bottom-to-top</td>
1469 </tr>
1470 <tr>
1471         <td><code>Flipped</code> *</td>
1472         <td><code>true</code></td>
1473         <td>Right-to-left, top-to-bottom</td>
1474 </tr>
1475 </tbody>
1476 </table>
1477 </div>
1478
1479 <p><em>* - Not supported in Mac OS X 10.5.x and earlier</em></p>
1480
1481 <div class='figure'><table summary='Back side images'>
1482 <caption>Figure 1: Back side images</caption>
1483 <tr><td><img src='../images/raster.png' width='624' height='448' alt='Back side images'></td></tr>
1484 </table></div>
1485
1486 <p>Examples:</p>
1487
1488 <pre class='command'>
1489 <em>*% Flip the page image for the back side of duplexed output</em>
1490 *cupsBackSide: Flipped
1491
1492 <em>*% Rotate the page image for the back side of duplexed output</em>
1493 *cupsBackSide: Rotated
1494 </pre>
1495
1496 <p>Also see the related <a href='#APDuplexRequiresFlippedMargin'><tt>APDuplexRequiresFlippedMargin</tt></a>
1497 keyword.</p>
1498
1499 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsCommands'>cupsCommands</a></h3>
1500
1501 <p class='summary'>*cupsCommands: "name name2 ... nameN"</p>
1502
1503 <p>This string keyword specifies the commands that are supported by the
1504 CUPS command file filter for this device. The command names are separated
1505 by whitespace.</p>
1506
1507 <p>Example:</p>
1508
1509 <pre class='command'>
1510 <em>*% Specify the list of commands we support</em>
1511 *cupsCommands: "AutoConfigure Clean PrintSelfTestPage ReportLevels com.vendor.foo"
1512 </pre>
1513
1514
1515 <h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsEvenDuplex'>cupsEvenDuplex</a></h3>
1516
1517 <p class='summary'>*cupsEvenDuplex: boolean</p>
1518
1519 <p>This boolean keyword notifies the RIP filters that the
1520 destination printer requires an even number of pages when 2-sided
1521 printing is selected. The default value is <code>false</code>.</p>
1522
1523 <p>Example:</p>
1524
1525 <pre class='command'>
1526 <em>*% Always send an even number of pages when duplexing</em>
1527 *cupsEvenDuplex: true
1528 </pre>
1529
1530 <h3><a name='cupsFax'>cupsFax</a></h3>
1531
1532 <p class='summary'>*cupsFax: boolean</p>
1533
1534 <p>This boolean keyword specifies whether the PPD defines a facsimile device. The default is <tt>false</tt>.</p>
1535
1536 <p>Examples:</p>
1537
1538 <pre class='command'>
1539 *cupsFax: true
1540 </pre>
1541
1542 <h3><a name='cupsFilter'>cupsFilter</a></h3>
1543
1544 <p class='summary'>*cupsFilter: "source/type cost program"</p>
1545
1546 <p>This string keyword provides a conversion rule from the
1547 given source type to the printer's native format using the
1548 filter "program". If a printer supports the source type directly,
1549 the special filter program "-" may be specified.</p>
1550
1551 <p>Examples:</p>
1552
1553 <pre class='command'>
1554 <em>*% Standard raster printer driver filter</em>
1555 *cupsFilter: "application/vnd.cups-raster 100 rastertofoo"
1556
1557 <em>*% Plain text filter</em>
1558 *cupsFilter: "text/plain 10 texttofoo"
1559
1560 <em>*% Pass-through filter for PostScript printers</em>
1561 *cupsFilter: "application/vnd.cups-postscript 0 -"
1562 </pre>
1563
1564 <h3><span class='info'>CUPS 1.5</span><a name='cupsFilter2'>cupsFilter2</a></h3>
1565
1566 <p class='summary'>*cupsFilter2: "source/type destination/type cost program"</p>
1567
1568 <p>This string keyword provides a conversion rule from the given source type to the printer's native format using the filter "program". If a printer supports the source type directly, the special filter program "-" may be specified. The destination type is automatically created as needed and is passed to the filters and backend as the FINAL_CONTENT_TYPE value.</p>
1569
1570 <blockquote><b>Note:</b>
1571
1572 <p>The presence of a single <code>cupsFilter2</code> keyword in the PPD file will hide any <code>cupsFilter</code> keywords from the CUPS scheduler. When using <code>cupsFilter2</code> to provide filters specific for CUPS 1.5 and later, provide a <code>cupsFilter2</code> line for every filter and a <code>cupsFilter</code> line for each filter that is compatible with older versions of CUPS.</p>
1573
1574 </blockquote>
1575
1576 <p>Examples:</p>
1577
1578 <pre class='command'>
1579 <em>*% Standard raster printer driver filter</em>
1580 *cupsFilter2: "application/vnd.cups-raster application/vnd.foo 100 rastertofoo"
1581
1582 <em>*% Plain text filter</em>
1583 *cupsFilter2: "text/plain application/vnd.foo 10 texttofoo"
1584
1585 <em>*% Pass-through filter for PostScript printers</em>
1586 *cupsFilter2: "application/vnd.cups-postscript application/postscript 0 -"
1587 </pre>
1588
1589 <h3><span class='info'>Deprecated</span><a name='cupsFlipDuplex'>cupsFlipDuplex</a></h3>
1590
1591 <p class='summary'>*cupsFlipDuplex: boolean</p>
1592
1593 <p>Due to implementation differences between Mac OS X and Ghostscript,
1594 the <tt>cupsFlipDuplex</tt> keyword is deprecated. Instead, use
1595 the <a href='#cupsBackSide'><tt>cupsBackSide</tt></a> keyword to specify
1596 the coordinate system (pixel layout) of the page data on the back side of
1597 duplex pages.</p>
1598
1599 <p>The value <code>true</code> maps to a <tt>cupsBackSide</tt> value
1600 of <code>Rotated</code> on Mac OS X and <code>Flipped</code> with
1601 Ghostscript.</p>
1602
1603 <p>The default value is <code>false</code>.</p>
1604
1605 <blockquote><b>Note:</b>
1606
1607 <p>Mac OS X drivers that previously used
1608 <tt>cupsFlipDuplex</tt> may wish to provide both the old and
1609 new keywords for maximum compatibility, for example:</p>
1610
1611 <pre class='command'>
1612 *cupsBackSide: Rotated
1613 *cupsFlipDuplex: true
1614 </pre>
1615
1616 <p>Similarly, drivers written for other operating systems using
1617 Ghostscript can use:</p>
1618
1619 <pre class='command'>
1620 *cupsBackSide: Flipped
1621 *cupsFlipDuplex: true
1622 </pre></blockquote>
1623
1624 <h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsIPPFinishings'>cupsIPPFinishings</a></h3>
1625
1626 <p class='summary'>*cupsIPPFinishings number/text: "*Option Choice ..."</p>
1627
1628 <p>This keyword defines a mapping from IPP <code>finishings</code>
1629 values to PPD options and choices.</p>
1630
1631 <p>Examples:</p>
1632
1633 <pre class='command'>
1634 *cupsIPPFinishings 4/staple: "*StapleLocation SinglePortrait"
1635 *cupsIPPFinishings 5/punch: "*PunchMedia Yes *PunchLocation LeftSide"
1636 *cupsIPPFinishings 20/staple-top-left: "*StapleLocation SinglePortrait"
1637 *cupsIPPFinishings 21/staple-bottom-left: "*StapleLocation SingleLandscape"
1638 </pre>
1639
1640 <h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsIPPReason'>cupsIPPReason</a></h3>
1641
1642 <p class='summary'>*cupsIPPReason reason/Reason Text: "optional URIs"</p>
1643
1644 <p>This optional keyword maps custom
1645 <code>printer-state-reasons</code> keywords that are generated by
1646 the driver to human readable text. The optional URIs string
1647 contains zero or more URIs separated by a newline. Each URI can
1648 be a CUPS server absolute path to a help file under the
1649 scheduler's <code>DocumentRoot</code> directory, a full HTTP URL
1650 ("http://www.domain.com/path/to/help/page.html"), or any other
1651 valid URI which directs the user at additional information
1652 concerning the condition that is being reported.</p>
1653
1654 <p>Since the reason text is limited to 80 characters by the PPD specification, longer text strings can be included by URI-encoding the text with the "text" scheme, for example "text:some%20text". Multiple <code>text</code> URIs are combined by the <tt>ppdLocalizeIPPReason</tt> into a single string that can be displayed to the user.</p>
1655
1656 <p>Examples:</p>
1657
1658 <pre class='command'>
1659 <em>*% Map com.vendor-error to text but no page</em>
1660 *cupsIPPReason com.vendor-error/A serious error occurred: ""
1661
1662 <em>*% Map com.vendor-error to more than 80 characters of text but no page</em>
1663 *cupsIPPReason com.vendor-error/A serious error occurred: "text:Now%20is%20the%20time
1664 text:for%20all%20good%20men%20to%20come%20to%20the%20aid%20of%20their%20country."
1665
1666 <em>*% Map com.vendor-error to text and a local page</em>
1667 *cupsIPPReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html"
1668
1669 <em>*% Map com.vendor-error to text and a remote page</em>
1670 *cupsIPPReason com.vendor-error/A serious error occurred: "http://www.vendor.com/help"
1671
1672 <em>*% Map com.vendor-error to text and a local, Apple help book, and remote page</em>
1673 *APHelpBook: "file:///Library/Printers/vendor/Help.bundle"
1674 *cupsIPPReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html
1675 help:anchor='com.vendor-error'%20bookID=Vendor%20Help
1676 http://www.vendor.com/help"
1677 *End
1678 </pre>
1679
1680 <h3><span class='info'>CUPS 1.5</span><a name='cupsIPPSupplies'>cupsIPPSupplies</a></h3>
1681
1682 <p class='summary'>*cupsIPPSupplies: boolean</p>
1683
1684 <p>This keyword tells the IPP backend whether it should report the current marker-xxx supply attribute values. The default value is <code>True</code>.
1685
1686 <p>Example:</p>
1687
1688 <pre class='command'>
1689 <em>*% Do not use IPP marker-xxx attributes to report supply levels</em>
1690 *cupsIPPSupplies: False
1691 </pre>
1692
1693 <h3><span class='info'>CUPS 1.2/Mac OS X 10.5</span><a name='cupsLanguages'>cupsLanguages</a></h3>
1694
1695 <p class='summary'>*cupsLanguages: "locale list"</p>
1696
1697 <p>This keyword describes which language localizations are
1698 included in the PPD. The "locale list" string is a space-delimited
1699 list of locale names ("en", "en_US", "fr_CA", etc.)</p>
1700
1701 <p>Example:</p>
1702
1703 <pre class='command'>
1704 <em>*% Specify Canadian, UK, and US English, and Canadian and French French</em>
1705 *cupsLanguages: "en_CA en_UK en_US fr_CA fr_FR"
1706 </pre>
1707
1708 <h3><a name='cupsManualCopies'>cupsManualCopies</a></h3>
1709
1710 <p class='summary'>*cupsManualCopies: boolean</p>
1711
1712 <p>This boolean keyword notifies the RIP filters that the
1713 destination printer does not support copy generation in
1714 hardware. The default value is <code>false</code>.</p>
1715
1716 <p>Example:</p>
1717
1718 <pre class='command'>
1719 <em>*% Tell the RIP filters to generate the copies for us</em>
1720 *cupsManualCopies: true
1721 </pre>
1722
1723 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMarkerName'>cupsMarkerName</a></h3>
1724
1725 <p class='summary'>*cupsMarkerName/Name Text: ""</p>
1726
1727 <p>This optional keyword maps <code>marker-names</code> strings that are
1728 generated by the driver to human readable text.</p>
1729
1730 <p>Examples:</p>
1731
1732 <pre class='command'>
1733 <em>*% Map cyanToner to "Cyan Toner"</em>
1734 *cupsMarkerName cyanToner/Cyan Toner: ""
1735 </pre>
1736
1737 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsMarkerNotice'>cupsMarkerNotice</a></h3>
1738
1739 <p class='summary'>*cupsMarkerNotice: "disclaimer text"</p>
1740
1741 <p>This optional keyword provides disclaimer text for the supply level
1742 information provided by the driver, typically something like "supply levels
1743 are approximate".</p>
1744
1745 <p>Examples:</p>
1746
1747 <pre class='command'>
1748 *cupsMarkerNotice: "Supply levels are approximate."
1749 </pre>
1750
1751 <h3><span class='info'>CUPS 1.6</span><a name='cupsMaxCopies'>cupsMaxCopies</a></h3>
1752
1753 <p class='summary'>*cupsMaxCopies: integer</p>
1754
1755 <p>This integer keyword notifies the filters that the destination printer supports up to N copies in hardware. The default value is <code>9999</code>.</p>
1756
1757 <p>Example:</p>
1758
1759 <pre class='command'>
1760 <em>*% Tell the RIP filters we can do up to 99 copies</em>
1761 *cupsMaxCopies: 99
1762 </pre>
1763
1764 <h3><a name='cupsModelNumber'>cupsModelNumber</a></h3>
1765
1766 <p class='summary'>*cupsModelNumber: number</p>
1767
1768 <p>This integer keyword specifies a printer-specific model
1769 number. This number can be used by a filter program to adjust
1770 the output for a specific model of printer.</p>
1771
1772 <p>Example:</p>
1773
1774 <pre class='command'>
1775 <em>*% Specify an integer for a driver-specific model number</em>
1776 *cupsModelNumber: 1234
1777 </pre>
1778
1779 <h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsPJLCharset'>cupsPJLCharset</a></h3>
1780
1781 <p class='summary'>*cupsPJLCharset: "ISO character set name"</p>
1782
1783 <p>This string keyword specifies the character set that is used
1784 for strings in PJL commands. If not specified, US-ASCII is
1785 assumed.</p>
1786
1787 <p>Example:</p>
1788
1789 <pre class='command'>
1790 <em>*% Specify UTF-8 is used in PJL strings</em>
1791 *cupsPJLCharset: "UTF-8"
1792 </pre>
1793
1794 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsPJLDisplay'>cupsPJLDisplay</a></h3>
1795
1796 <p class='summary'>*cupsPJLDisplay: "what"</p>
1797
1798 <p>This optional keyword specifies which command is used to display the
1799 job ID, name, and user on the printer's control panel. "What" is either "none"
1800 to disable this functionality, "job" to use "@PJL JOB DISPLAY", or "rdymsg"
1801 to use "@PJL RDYMSG DISPLAY". The default is "job".</p>
1802
1803 <p>Examples:</p>
1804
1805 <pre class='command'>
1806 <em>*% Display job information using @PJL SET RDYMSG DISPLAY="foo"</em>
1807 *cupsPJLDisplay: "rdymsg"
1808
1809 <em>*% Display job information display</em>
1810 *cupsPJLDisplay: "none"
1811 </pre>
1812
1813 <h3><span class='info'>CUPS 1.2/Mac OS X 10.5</span><a name='cupsPortMonitor'>cupsPortMonitor</a></h3>
1814
1815 <p class='summary'>*cupsPortMonitor urischeme/Descriptive Text: "port monitor"</p>
1816
1817 <p>This string keyword specifies printer-specific "port
1818 monitor" filters that may be used with the printer. The CUPS
1819 scheduler also looks for the <tt>Protocols</tt> keyword to see
1820 if the <tt>BCP</tt> or <tt>TBCP</tt> protocols are supported. If
1821 so, the corresponding port monitor ("bcp" and "tbcp",
1822 respectively) is listed in the printer's
1823 <tt>port-monitor-supported</tt> keyword.</p>
1824
1825 <p>The "urischeme" portion of the keyword specifies the URI scheme
1826 that this port monitor should be used for. Typically this is used to
1827 pre-select a particular port monitor for each type of connection that
1828 is supported by the printer. The "port monitor" string can be "none"
1829 to disable the port monitor for the given URI scheme.</p>
1830
1831 <p>Examples:</p>
1832
1833 <pre class='command'>
1834 <em>*% Specify a PostScript printer that supports the TBCP protocol</em>
1835 *Protocols: TBCP PJL
1836
1837 <em>*% Specify that TBCP should be used for socket connections but not USB</em>
1838 *cupsPortMonitor socket/AppSocket Printing: "tbcp"
1839 *cupsPortMonitor usb/USB Printing: "none"
1840
1841 <em>*% Specify a printer-specific port monitor for an Epson USB printer</em>
1842 *cupsPortMonitor usb/USB Status Monitor: "epson-usb"
1843 </pre>
1844
1845 <h3><span class='info'>CUPS 1.3/Mac OS X 10.5</span><a name='cupsPreFilter'>cupsPreFilter</a></h3>
1846
1847 <p class='summary'>*cupsPreFilter: "source/type cost program"</p>
1848
1849 <p>This string keyword provides a pre-filter rule. The pre-filter
1850 program will be inserted in the conversion chain immediately
1851 before the filter that accepts the given MIME type.</p>
1852
1853 <p>Examples:</p>
1854
1855 <pre class='command'>
1856 <em>*% PDF pre-filter</em>
1857 *cupsPreFilter: "application/pdf 100 mypdfprefilter"
1858
1859 <em>*% PNG pre-filter</em>
1860 *cupsPreFilter: "image/png 0 mypngprefilter"
1861 </pre>
1862
1863
1864 <h3><span class='info'>CUPS 1.5</span><a name='cupsPrintQuality'>cupsPrintQuality</a></h3>
1865
1866 <p class='summary'>*cupsPrintQuality keyword/text: "code"</p>
1867
1868 <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>
1869
1870 <blockquote><b>Note:</b>
1871
1872 <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>
1873
1874 </blockquote>
1875
1876 <p>Examples:</p>
1877
1878 <pre class='command'>
1879 *OpenUI *cupsPrintQuality/Print Quality: PickOne
1880 *OrderDependency: 10 AnySetup *cupsPrintQuality
1881 *DefaultcupsPrintQuality: Normal
1882 *cupsPrintQuality Draft/Draft: "code"
1883 *cupsPrintQuality Normal/Normal: "code"
1884 *cupsPrintQuality High/Photo: "code"
1885 *CloseUI: *cupsPrintQuality
1886 </pre>
1887
1888 <h3><span class='info'>CUPS 1.5</span><a name='cupsSingleFile'>cupsSingleFile</a></h3>
1889
1890 <p class='summary'>*cupsSingleFile: Boolean</p>
1891
1892 <p>This boolean keyword tells the scheduler whether to print multiple files in a job together or singly. The default is "False" which uses a single instance of the backend for all files in the print job. Setting this keyword to "True" will result in separate instances of the backend for each file in the print job.</p>
1893
1894 <p>Examples:</p>
1895
1896 <pre class='command'>
1897 <em>*% Send all print data to a single backend</em>
1898 *cupsSingleFile: False
1899
1900 <em>*% Send each file using a separate backend</em>
1901 *cupsSingleFile: True
1902 </pre>
1903
1904 <h3><span class='info'>CUPS 1.4/Mac OS X 10.6</span><a name='cupsSNMPSupplies'>cupsSNMPSupplies</a></h3>
1905
1906 <p class='summary'>*cupsSNMPSupplies: boolean</p>
1907
1908 <p>This keyword tells the standard network backends whether they should query
1909 the standard SNMP Printer MIB OIDs for supply levels. The default value is
1910 <code>True</code>.
1911
1912 <p>Example:</p>
1913
1914 <pre class='command'>
1915 <em>*% Do not use SNMP queries to report supply levels</em>
1916 *cupsSNMPSupplies: False
1917 </pre>
1918
1919 <h3><a name='cupsVersion'>cupsVersion</a></h3>
1920
1921 <p class='summary'>*cupsVersion: major.minor</p>
1922
1923 <p>This required keyword describes which version of the CUPS
1924 PPD file extensions was used. Currently it must be the string
1925 "1.0", "1.1", "1.2", "1.3", "1.4", "1.5", or "1.6".</p>
1926
1927 <p>Example:</p>
1928
1929 <pre class='command'>
1930 <em>*% Specify a CUPS 1.2 driver</em>
1931 *cupsVersion: "1.2"
1932 </pre>
1933
1934
1935 <h3><span class="info">CUPS 1.6</span><a name="JCLToPDFInterpreter">JCLToPDFInterpreter</a></h3>
1936
1937 <p class="summary">*JCLToPDFInterpreter: "JCL"</p>
1938
1939 <p>This keyword provfides the JCL command to insert a PDF job file into a printer-ready data stream. The JCL command is added after the <tt>JCLBegin</tt> value and any commands for JCL options in the PPD file.</p>
1940
1941 <p>Example:</p>
1942
1943 <pre class='command'>
1944 <em>*% PJL command to start the PDF interpreter</em>
1945 *JCLToPDFInterpreter: "@PJL ENTER LANGUAGE = PDF&lt;0A&gt;"
1946 </pre>
1947
1948
1949 <h2 class='title'><a name='MACOSX'>Mac OS X Attributes</a></h2>
1950
1951 <h3><span class='info'>Mac OS X 10.3</span><a name='APDialogExtension'>APDialogExtension</a></h3>
1952
1953 <p class='summary'>*APDialogExtension: "/Library/Printers/vendor/filename.plugin"</p>
1954
1955 <p>This keyword defines additional option panes that are displayed in the
1956 print dialog. Each keyword adds one or more option panes. See the "OutputBinsPDE"
1957 example and <a href='http://developer.apple.com/qa/qa2004/qa1352.html'>Apple
1958 Technical Q&amp;A QA1352</a> for information on writing your own print dialog
1959 plug-ins.</p>
1960
1961 <blockquote><b>Note:</b>
1962
1963 <p>Starting with Mac OS X 10.5, each plug-in must be compiled "4-way fat"
1964 (32-bit and 64-bit for both PowerPC and Intel) with garbage collection enabled
1965 in order to be usable with all applications.</p>
1966
1967 </blockquote>
1968
1969 <p>Examples:</p>
1970
1971 <pre class='command'>
1972 *% Add two panes for finishing and driver options
1973 *APDialogExtension: "/Library/Printers/vendor/finishing.plugin"
1974 *APDialogExtension: "/Library/Printers/vendor/options.plugin"
1975 </pre>
1976
1977 <h3><span class='info'>Mac OS X 10.4</span><a name='APDuplexRequiresFlippedMargin'>APDuplexRequiresFlippedMargin</a></h3>
1978
1979 <p class='summary'>*APDuplexRequiresFlippedMargin: boolean</p>
1980
1981 <p>This boolean keyword notifies the RIP filters that the
1982 destination printer requires the top and bottom margins of the
1983 <tt>ImageableArea</tt> to be swapped for the back page. The
1984 default is <tt>true</tt> when <tt>cupsBackSide</tt> is <tt>Flipped</tt>
1985 and <tt>false</tt> otherwise. <a href='#TABLE_2'>Table 2</a> shows how
1986 <tt>APDuplexRequiresFlippedMargin</tt> interacts with <tt>cupsBackSide</tt>
1987 and the <tt>Tumble</tt> page attribute.</p>
1988
1989 <div class='table'>
1990 <table width='80%' summary='Margin Flipping Modes'>
1991 <caption>Table 2: <a name='TABLE_2'>Margin Flipping Modes</a></caption>
1992 <thead>
1993 <tr>
1994         <th>APDuplexRequiresFlippedMargin</th>
1995         <th>cupsBackSide</th>
1996         <th>Tumble Value</th>
1997         <th>Margins</th>
1998 </tr>
1999 </thead>
2000 <tbody>
2001 <tr>
2002         <td>false</td>
2003         <td>any</td>
2004         <td>any</td>
2005         <td>Normal</td>
2006 </tr>
2007 <tr>
2008         <td>any</td>
2009         <td>Normal</td>
2010         <td>any</td>
2011         <td>Normal</td>
2012 </tr>
2013 <tr>
2014         <td>true</td>
2015         <td>ManualDuplex</td>
2016         <td>false</td>
2017         <td>Normal</td>
2018 </tr>
2019 <tr>
2020         <td>true</td>
2021         <td>ManualDuplex</td>
2022         <td>true</td>
2023         <td>Flipped</td>
2024 </tr>
2025 <tr>
2026         <td>true</td>
2027         <td>Rotated</td>
2028         <td>false</td>
2029         <td>Flipped</td>
2030 </tr>
2031 <tr>
2032         <td>true</td>
2033         <td>Rotated</td>
2034         <td>true</td>
2035         <td>Normal</td>
2036 </tr>
2037 <tr>
2038         <td>true or unspecified</td>
2039         <td>Flipped</td>
2040         <td>any</td>
2041         <td>Flipped</td>
2042 </tr>
2043 </tbody>
2044 </table></div>
2045
2046 <p>Example:</p>
2047
2048 <pre class='command'>
2049 <em>*% Rotate the back side images</em>
2050 *cupsBackSide: Rotated
2051
2052 <em>*% Don't swap the top and bottom margins for the back side</em>
2053 *APDuplexRequiresFlippedMargin: false
2054 </pre>
2055
2056 <p>Also see the related <a href='#cupsBackSide'><tt>cupsBackSide</tt></a>
2057 keyword.</p>
2058
2059 <h3><a name='APHelpBook'>APHelpBook</a></h3>
2060
2061 <p class='summary'>*APHelpBook: "bundle URL"</p>
2062
2063 <p>This string keyword specifies the Apple help book bundle to use when
2064 looking up IPP reason codes for this printer driver. The
2065 <a href='#cupsIPPReason'><tt>cupsIPPReason</tt></a> keyword maps
2066 "help" URIs to this file.</p>
2067
2068 <p>Example:</p>
2069
2070 <pre class='command'>
2071 *APHelpBook: "file:///Library/Printers/vendor/Help.bundle"
2072 </pre>
2073
2074 <h3><span class='info'>Mac OS X 10.6</span><a name='APICADriver'>APICADriver</a></h3>
2075
2076 <p class='summary'>*APICADriver: boolean</p>
2077
2078 <p>This keyword specifies whether the device has a matching Image Capture
2079 Architecture (ICA) driver for scanning. The default is <tt>False</tt>.</p>
2080
2081 <p>Examples:</p>
2082
2083 <pre class='command'>
2084 *APICADriver: True
2085 *APScanAppBundleID: "com.apple.ImageCaptureApp"
2086 </pre>
2087
2088 <h3><span class='info'>Mac OS X 10.3</span><a name='APPrinterIconPath'>APPrinterIconPath</a></h3>
2089
2090 <p class='summary'>*APPrinterIconPath: "/Library/Printers/vendor/filename.icns"</p>
2091
2092 <p>This keyword defines the location of a printer icon file to use when
2093 displaying the printer. The file must be in the Apple icon format.</p>
2094
2095 <p>Examples:</p>
2096
2097 <pre class='command'>
2098 *% Apple icon file
2099 *APPrinterIconPath: "/Library/Printers/vendor/Icons/filename.icns"
2100 </pre>
2101
2102 <h3><span class='info'>Mac OS X 10.4</span><a name='APPrinterLowInkTool'>APPrinterLowInkTool</a></h3>
2103
2104 <p class='summary'>*APPrinterLowInkTool: "/Library/Printers/vendor/program"</p>
2105
2106 <p>This keyword defines an program that checks the ink/toner/marker levels
2107 on a printer, returning an XML document with those levels. See the "InkTool"
2108 example and
2109 <a href='http://developer.apple.com/technotes/tn2005/tn2144.html'>Apple
2110 Technical Note TN2144</a> for more information.</p>
2111
2112 <p>Examples:</p>
2113
2114 <pre class='command'>
2115 *% Use a vendor monitoring program
2116 *APPrinterLowInkTool: "/Library/Printers/vendor/Tools/lowinktool"
2117 </pre>
2118
2119 <h3><span class='info'>Mac OS X 10.5</span><a name='APPrinterPreset'>APPrinterPreset</a></h3>
2120
2121 <p class='summary'>*APPrinterPreset name/text: "*Option Choice ..."</p>
2122
2123 <p>This keyword defines presets for multiple options that show up
2124 in the print dialog of applications (such as iPhoto) that set the job
2125 style hint to <tt>NSPrintPhotoJobStyleHint</tt>. Each preset maps to one or
2126 more pairs of PPD options and choices as well as providing key/value data for
2127 the application. The following standard preset names are currently defined:</p>
2128
2129 <ul>
2130
2131         <li><code>General_with_Paper_Auto-Detect</code>; Normal quality general printing with auto-detected media.</li>
2132
2133         <li><code>General_with_Paper_Auto-Detect_-_Draft</code>; Draft quality general printing with auto-detected media.</li>
2134
2135         <li><code>General_on_Plain_Paper</code>; Normal quality general printing on plain paper.</li>
2136
2137         <li><code>General_on_Plain_Paper_-_Draft</code>; Draft quality general printing on plain paper.</li>
2138
2139         <li><code>Photo_with_Paper_Auto-Detect</code>; Normal quality photo printing with auto-detected media.</li>
2140
2141         <li><code>Photo_with_Paper_Auto-Detect_-_Fine</code>; High quality photo printing with auto-detected media.</li>
2142
2143         <li><code>Photo_on_Plain_Paper</code>; Normal quality photo printing on plain paper.</li>
2144
2145         <li><code>Photo_on_Plain_Paper_-_Fine</code>; High quality photo printing on plain paper.</li>
2146
2147         <li><code>Photo_on_Photo_Paper</code>; Normal quality photo printing on glossy photo paper.</li>
2148
2149         <li><code>Photo_on_Photo_Paper_-_Fine</code>; High quality photo printing on glossy photo paper.</li>
2150
2151         <li><code>Photo_on_Matte_Paper</code>; Normal quality photo printing on matte paper.</li>
2152
2153         <li><code>Photo_on_Matte_Paper_-_Fine</code>; High quality photo printing on matte paper.</li>
2154
2155 </ul>
2156
2157 <p>The value string consists of pairs of keywords, either an option name and
2158 choice (*MainKeyword OptionKeyword) or a preset identifier and value
2159 (com.apple.print.preset.foo value). The following preset identifiers are currently used:</p>
2160
2161 <ul>
2162
2163         <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>
2164
2165         <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>
2166
2167         <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>
2168
2169         <li><code>com.apple.print.preset.quality</code>; specifies the overall print quality selected by this preset - "low" (draft), "mid" (normal), or "high".</li>
2170
2171 </ul>
2172
2173 <p>Presets, like options, can also be localized in multiple languages.</p>
2174
2175 <p>Examples:</p>
2176
2177 <pre class='command'>
2178 *APPrinterPreset Photo_on_Photo_Paper/Photo on Photo Paper: "
2179   *MediaType Glossy
2180   *ColorModel RGB
2181   *Resolution 300dpi
2182   com.apple.print.preset.graphicsType Photo
2183   com.apple.print.preset.quality mid
2184   com.apple.print.preset.media-front-coating glossy"
2185 *End
2186 *fr.APPrinterPreset Photo_on_Photo_Paper/Photo sur papier photographique: ""
2187 </pre>
2188
2189 <h3><span class='info'>Mac OS X 10.3</span><a name='APPrinterUtilityPath'>APPrinterUtilityPath</a></h3>
2190
2191 <p class='summary'>*APPrinterPrinterUtilityPath: "/Library/Printers/vendor/filename.app"</p>
2192
2193 <p>This keyword defines a GUI application that can be used to do printer
2194 maintenance functions such as cleaning the print head(s). See ... for more
2195 information.</p>
2196
2197 <p>Examples:</p>
2198
2199 <pre class='command'>
2200 *% Define the printer utility application
2201 *APPrinterPrinterUtilityPath: "/Library/Printers/vendor/Tools/utility.app"
2202 </pre>
2203
2204 <h3><span class='info'>Mac OS X 10.6</span><a name='APScannerOnly'>APScannerOnly</a></h3>
2205
2206 <p class='summary'>*APScannerOnly: boolean</p>
2207
2208 <p>This keyword specifies whether the device has scanning but no printing
2209 capabilities. The default is <tt>False</tt>.</p>
2210
2211 <p>Examples:</p>
2212
2213 <pre class='command'>
2214 *APICADriver: True
2215 *APScannerOnly: True
2216 </pre>
2217
2218 <h3><span class='info'>Mac OS X 10.3</span><a name='APScanAppBundleID'>APScanAppBundleID</a></h3>
2219
2220 <p class='summary'>*APScanAppBundleID: "bundle ID"</p>
2221
2222 <p>This keyword defines the application to use when scanning pages from
2223 the device.</p>
2224
2225 <p>Examples:</p>
2226
2227 <pre class='command'>
2228 *APICADriver: True
2229 *APScanAppBundleID: "com.apple.ImageCaptureApp"
2230 </pre>
2231
2232
2233 <h2 class='title'><a name='HISTORY'>Change History</a></h2>
2234
2235 <h3>Changes in CUPS 1.6</h3>
2236
2237 <ul>
2238
2239         <li>Added <a href="#cupsMaxCopies"><tt>cupsMaxCopies</tt></a> keyword.</li>
2240
2241         <li>Documented <a href="#JCLToPDFInterpreter"><tt>JCLToPDFInterpreter</tt></a> keyword.</li>
2242
2243         <li>Updated <a href="#cupsVersion"><tt>cupsVersion</tt></a> keyword documentation to list all current releases of CUPS.</li>
2244
2245 </ul>
2246
2247
2248 <h3>Changes in CUPS 1.5</h3>
2249
2250 <ul>
2251
2252         <li>Changes all instances of PPD attributes to PPD keywords, to be consistent with the parent specification from Adobe.</li>
2253
2254 </ul>
2255
2256
2257 <h3>Changes in CUPS 1.4.5</h3>
2258
2259 <ul>
2260
2261         <li>Added <a href='#cupsPrintQuality'><tt>cupsPrintQuality</tt></a> UI keyword.</li>
2262
2263         <li>Added new properties and values for the <a href='#APPrinterPreset'><tt>APPrinterPreset</tt></a> keyword.</li>
2264
2265 </ul>
2266
2267
2268 <h3>Changes in CUPS 1.4</h3>
2269
2270 <ul>
2271
2272         <li>Added <a href='#APICADriver'><tt>APICADriver</tt></a>
2273         keyword.</li>
2274
2275         <li>Added <a href='#cupsCommands'><tt>cupsCommands</tt></a>
2276         keyword.</li>
2277
2278         <li>Added <a href='#cupsMarkerName'><tt>cupsMarkerName</tt></a>
2279         keyword.</li>
2280
2281         <li>Added <a href='#cupsMarkerNotice'><tt>cupsMarkerNotice</tt></a>
2282         keyword.</li>
2283
2284         <li>Added <a href='#cupsPJLDisplay'><tt>cupsPJLDisplay</tt></a>
2285         keyword.</li>
2286
2287         <li>Added <a href='#cupsSNMPSupplies'><tt>cupsSNMPSupplies</tt></a>
2288         keyword.</li>
2289
2290         <li>Added <a href='#cupsUIResolver'><tt>cupsUIResolver</tt></a> and
2291         <a href='#cupsUIConstraints'><tt>cupsUIConstraints</tt></a>
2292         keywords.</li>
2293
2294         <li>Added
2295         <a href='#cupsMediaQualifier2'><tt>cupsMediaQualifier2</tt></a>,
2296         <a href='#cupsMediaQualifier3'><tt>cupsMediaQualifier3</tt></a>,
2297         <a href='#cupsMinSize'><tt>cupsMinSize</tt></a>, and
2298         <a href='#cupsMaxSize'><tt>cupsMaxSize</tt></a> keywords.</li>
2299
2300 </ul>
2301
2302
2303 <h3>Changes in CUPS 1.3.1</h3>
2304
2305 <ul>
2306
2307         <li>Added missing Mac OS X <tt>AP</tt> keywords.</li>
2308
2309         <li>Added section on auto-configuration including the
2310         <tt>OID<i>MainKeyword</i></tt> and <tt>?<i>MainKeyword</i></tt>
2311         keywords.</li>
2312
2313         <li>Minor reorganization.</li>
2314
2315 </ul>
2316
2317
2318 <h3>Changes in CUPS 1.3</h3>
2319
2320 <ul>
2321
2322         <li>Added <a href='#cupsBackSide'><tt>cupsBackSide</tt></a> and
2323         deprecated <a href='#cupsFlipDuplex'><tt>cupsFlipDuplex</tt></a>.</li>
2324
2325         <li>Added text URI information to
2326         <a href='#cupsIPPReason'><tt>cupsIPPReason</tt></a> documentation.</li>
2327
2328         <li>Added <a href='#APPrinterPreset'><tt>APPrinterPreset</tt></a>,
2329         <a href='#cupsIPPFinishings'><tt>cupsIPPFinishings</tt></a>, and
2330         <a href='#cupsPreFilter'><tt>cupsPreFilter</tt></a> keywords.</li>
2331
2332         <li>Added discussion of custom option code, sample
2333         <tt>CustomPageSize</tt> code, and "do not use dict and put" note.</li>
2334
2335 </ul>
2336
2337 <h3>Changes in CUPS 1.2.8</h3>
2338
2339 <ul>
2340
2341         <li>Added section on supported PostScript commands for raster
2342         drivers</li>
2343
2344 </ul>
2345
2346 <h3>Changes in CUPS 1.2</h3>
2347
2348 <ul>
2349
2350         <li>Added globalization support keywords</li>
2351
2352         <li>Added custom option values support</li>
2353
2354         <li>Added <a href='#APHelpBook'><tt>APHelpBook</tt></a> keyword</li>
2355
2356         <li>Added <a href='#APDuplexRequiresFlippedMargin'><tt>APDuplexRequiresFlippedMargin</tt></a>
2357         keyword</li>
2358
2359         <li>Added <a href='#cupsICCProfile'><tt>cupsICCProfile</tt></a> keyword</li>
2360
2361         <li>Added <a href='#cupsIPPReason'><tt>cupsIPPReason</tt></a> keyword</li>
2362
2363         <li>Added <a href='#cupsLanguages'><tt>cupsLanguages</tt></a> keyword</li>
2364
2365         <li>Added <a href='#cupsPortMonitor'><tt>cupsPortMonitor</tt></a> keyword</li>
2366
2367         <li>Removed <tt>cupsProtocol</tt> keyword</li>
2368
2369 </ul>
2370
2371 <h3>Changes in CUPS 1.1</h3>
2372
2373 <ul>
2374
2375         <li>Added <a href='#cupsFlipDuplex'><tt>cupsFlipDuplex</tt></a> keyword</li>
2376
2377         <li>Added <tt>cupsProtocol</tt> keyword</li>
2378
2379 </ul>
2380 </div>
2381 </body>
2382 </html>