filter/spec-ppd.shtml

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