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