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'> 6PPD-FILE = HEADER +(DATA / COMMENT / LINE-END) 7 8HEADER = "*PPD-Adobe:" *WSP DQUOTE VERSION DQUOTE LINE-END 9 10VERSION = "4.0" / "4.1" / "4.2" / "4.3" 11 12COMMENT = "*%" *TCHAR LINE-END 13 14DATA = "*" 1*KCHAR [ WSP 1*KCHAR [ "/" 1*TCHAR ] ] ":" 15 1*(*WSP VALUE) LINE-END 16 17VALUE = 1*TCHAR / DQUOTE 1*SCHAR DQUOTE 18 19KCHAR = ALPHA / DIGIT / "_" / "." / "-" 20 21SCHAR = LINE-END / WSP / %x21.23-7E.A0-FF 22 23TCHAR = %x20-7E.A0-FF 24 25LINE-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 class="title"><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 class="title"><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 class="title"><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 class="title"><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 121density adjustment function such that:</p> 122 123<pre class='command'> 124f(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 class="title"><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 class="title">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 class="title"><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 class="title"><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 class="title"><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 class="title"><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 class="title"><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 class="title"><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 class="title"><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èrieuse s'est produite: "/help/com.vendor/error.html" 402*de.cupsIPPReason com.vendor-error/Eine ernste Stö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: "<</ManualFeed false>>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: "<</ManualFeed true>>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 437option 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 "<</cupsReal1 2 1 roll>>setpagedevice" and the option value is "2.0" then CUPS will output the string "2.0 <</cupsReal1 2 1 roll>>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<0A>" 472*JCLPasscode 2222: "@PJL SET PASSCODE = 2222<0A>" 473*JCLPasscode 3333: "@PJL SET PASSCODE = 3333<0A>" 474*JCLCloseUI: *JCLPasscode 475 476<em>*% Custom JCL key code option</em> 477*CustomJCLPasscode True: "@PJL SET PASSCODE = \1<0A>" 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: "<</cupsString1(Draft)>>setpagedevice" 487*CloseUI: *WatermarkText 488 489<em>*% Custom PostScript watermark option</em> 490*CustomWatermarkText True: "<</cupsString1 3 -1 roll>>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: "<</cupsReal1 1.0/cupsReal2 1.0>>setpagedevice" 499*GammaDensity Light/Lighter: "<</cupsReal1 0.9/cupsReal2 0.67>>setpagedevice" 500*GammaDensity Dark/Darker: "<</cupsReal1 1.1/cupsReal2 1.5>>setpagedevice" 501*CloseUI: *GammaDensity 502 503<em>*% Custom PostScript gamma/density option</em> 504*CustomGammaDensity True: "<</cupsReal1 3 -1 roll/cupsReal2 5 -1>>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: "<</PageSize[595 842]>>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: "<</cupsString1 3 -1 roll>>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<</cupsString1 3 -1 roll>>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<</cupsString1(My Watermark)>>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 class="title">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 <</PageSize[5 -2 roll]/ImagingBBox null>>setpagedevice" 551</pre> 552 553 554<h3 class="title">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><<</tt> - Start a dictionary.</li> 561 562 <li><tt>>></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> 585operators in your option code. These operators are typically used in 586option code dating back to Level 1 PostScript printers, which did not 587support the simpler <tt><<</tt> or <tt>>></tt> operators. 588If you have old option code using <tt>dict</tt> or <tt>put</tt>, you can 589rewrite it very easily to use the newer <tt><<</tt> and 590<tt>>></tt> operators instead. For example, the following code 591to set the page size:</p> 592 593<style type='text/css'><!-- 594PRE 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><<</b> /PageSize [612 792] <b>>></b> setpagedevice 609</pre> 610 611</blockquote> 612 613 614<h3 class="title">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><</AdvanceDistance 18>>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><</AdvanceMedia 4>>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><</Collate true>>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><</CutMedia 1>>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><</Duplex true>>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><</HWResolution[1200 1200]>>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><</InsertSheet true>>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><</Jog 2>>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><</LeadingEdge 0>>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><</ManualFeed true>>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><</MediaClass (Invoices)>>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><</MediaColor >>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><</MediaPosition 12>>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><</MediaType (Glossy)>>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><</MediaWeight 100>>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><</MirrorPrint true>>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><</NegativePrint true>>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><</NumCopies 100>>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><</Orientation 3>>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><</OutputFaceUp true>>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><</OutputType (Photo)>>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><</PageSize[595 842]>>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><</Separations true>>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><</TraySwitch true>>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><</Tumble true>>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><</cupsBorderlessScalingFactor 1.01>>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><</cupsColorOrder 0>>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><</cupsColorSpace 1 >>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><</cupsCompression 2>>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><</cupsInteger11 1234>>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><</cupsMarkerType (Black+Color)>>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><</cupsMediaType 999>>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><</cupsPageSizeName (A4.Full)>>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><</cupsPreferredBitsPerColor 16>>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><</cupsReal15 1.234>>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><</cupsRenderingIntent (AbsoluteColorimetric)>>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><</cupsRowCount 24>>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><</cupsRowFeed 17>>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><</cupsRowStep 2>>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><</cupsString0(String Value)>>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 883size limits based on up to two options.</p> 884 885 886<h3 class="title"><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 891custom 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 class="title"><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 911custom 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 class="title"><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. 933The <a href='#cupsMediaQualifier2'><tt>cupsMediaQualifier2</tt></a> and 934<a href='#cupsMediaQualifier3'><tt>cupsMediaQualifier3</tt></a> keywords 935are 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 class="title"><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. 957The <a href='#cupsMediaQualifier2'><tt>cupsMediaQualifier2</tt></a> and 958<a href='#cupsMediaQualifier3'><tt>cupsMediaQualifier3</tt></a> keywords 959are 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 class="title"><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 class="title"><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 996when doing duplexed (2-sided) output. <a href='#TABLE_1'>Table 1</a> 997shows the supported keyword values for this keyword and their effect 998on the raster data sent to your driver. For example, when <tt>cupsBackSide</tt> 999is <code>Rotated</code> and <tt>Tumble</tt> is <tt>false</tt>, your driver 1000will receive print data starting at the bottom right corner of the page, with 1001each 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> 1007keyword - if <tt>cupsBackSide</tt> is specified, <tt>cupsFlipDuplex</tt> 1008will 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> 1085keyword.</p> 1086 1087 1088<h3 class="title"><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 1093CUPS command file filter for this device. The command names are separated 1094by 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 class="title"><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 1109destination printer requires an even number of pages when 2-sided 1110printing 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 class="title"><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 class="title"><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 1138given source type to the printer's native format using the 1139filter "program". If a printer supports the source type directly, 1140the 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 class="title"><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 class="title"><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 class="title"><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, 1206the <tt>cupsFlipDuplex</tt> keyword is deprecated. Instead, use 1207the <a href='#cupsBackSide'><tt>cupsBackSide</tt></a> keyword to specify 1208the coordinate system (pixel layout) of the page data on the back side of 1209duplex pages.</p> 1210 1211<p>The value <code>true</code> maps to a <tt>cupsBackSide</tt> value 1212of <code>Rotated</code> on macOS and <code>Flipped</code> with 1213Ghostscript.</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 1221new 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 1229Ghostscript can use:</p> 1230 1231<pre class='command'> 1232*cupsBackSide: Flipped 1233*cupsFlipDuplex: true 1234</pre></blockquote> 1235 1236 1237<h3 class="title"><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> 1242values 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 class="title"><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 1260the driver to human readable text. The optional URIs string 1261contains zero or more URIs separated by a newline. Each URI can 1262be a CUPS server absolute path to a help file under the 1263scheduler's <code>DocumentRoot</code> directory, a full HTTP URL 1264("http://www.domain.com/path/to/help/page.html"), or any other 1265valid URI which directs the user at additional information 1266concerning 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 1278text: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 1289help:anchor='com.vendor-error'%20bookID=Vendor%20Help 1290http://www.vendor.com/help" 1291*End 1292</pre> 1293 1294 1295<h3 class="title"><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 class="title"><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 class="title"><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 class="title"><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. The following format characters are supported:</p> 1342 1343<ul> 1344 <li><code>1</code>: US ASCII digits.</li> 1345 <li><code>A</code>: US ASCII letters.</li> 1346 <li><code>C</code>: US ASCII letters, numbers, and punctuation.</li> 1347 <li><code>.</code>: Any US ASCII printable character (0x20 to 0x7e).</li> 1348 <li><code>N</code>: Any Unicode digit character.</li> 1349 <li><code>U</code>: Any Unicode letter character.</li> 1350 <li><code>*</code>: Any Unicode (utf-8) character.</li> 1351</ul> 1352 1353<p>The format characters are repeated to indicate the length of the 1354password string. For example, "1111" indicated a 4-digit US ASCII PIN code.</p> 1355 1356<p>Example:</p> 1357 1358<pre class='command'> 1359<em>*% Specify the printer supports 4-digit PIN codes.</em> 1360*cupsJobPassword: "1111" 1361</pre> 1362 1363 1364<h3 class="title"><span class='info'>CUPS 1.2/macOS 10.5</span><a name='cupsLanguages'>cupsLanguages</a></h3> 1365 1366<p class='summary'>*cupsLanguages: "locale list"</p> 1367 1368<p>This keyword describes which language localizations are 1369included in the PPD. The "locale list" string is a space-delimited 1370list of locale names ("en", "en_US", "fr_CA", etc.)</p> 1371 1372<p>Example:</p> 1373 1374<pre class='command'> 1375<em>*% Specify Canadian, UK, and US English, and Canadian and French French</em> 1376*cupsLanguages: "en_CA en_UK en_US fr_CA fr_FR" 1377</pre> 1378 1379 1380<h3 class="title"><span class='info'>CUPS 1.7/macOS 10.9</span><a name='cupsMandatory'>cupsMandatory</a></h3> 1381 1382<p class='summary'>*cupsMandatory: "attribute1 attribute2 ... attributeN"</p> 1383 1384<p>This keyword defines a list of IPP attributes that must be provided when submitting a print job creation request.</p> 1385 1386<p>Example:</p> 1387 1388<pre class='command'> 1389<em>*% Specify that the user must supply a job-password</em> 1390*cupsMandatory: "job-password job-password-encryption" 1391</pre> 1392 1393 1394<h3 class="title"><a name='cupsManualCopies'>cupsManualCopies</a></h3> 1395 1396<p class='summary'>*cupsManualCopies: boolean</p> 1397 1398<p>This boolean keyword notifies the RIP filters that the 1399destination printer does not support copy generation in 1400hardware. The default value is <code>false</code>.</p> 1401 1402<p>Example:</p> 1403 1404<pre class='command'> 1405<em>*% Tell the RIP filters to generate the copies for us</em> 1406*cupsManualCopies: true 1407</pre> 1408 1409 1410<h3 class="title"><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsMarkerName'>cupsMarkerName</a></h3> 1411 1412<p class='summary'>*cupsMarkerName/Name Text: ""</p> 1413 1414<p>This optional keyword maps <code>marker-names</code> strings that are 1415generated by the driver to human readable text.</p> 1416 1417<p>Examples:</p> 1418 1419<pre class='command'> 1420<em>*% Map cyanToner to "Cyan Toner"</em> 1421*cupsMarkerName cyanToner/Cyan Toner: "" 1422</pre> 1423 1424 1425<h3 class="title"><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsMarkerNotice'>cupsMarkerNotice</a></h3> 1426 1427<p class='summary'>*cupsMarkerNotice: "disclaimer text"</p> 1428 1429<p>This optional keyword provides disclaimer text for the supply level 1430information provided by the driver, typically something like "supply levels 1431are approximate".</p> 1432 1433<p>Examples:</p> 1434 1435<pre class='command'> 1436*cupsMarkerNotice: "Supply levels are approximate." 1437</pre> 1438 1439 1440<h3 class="title"><span class='info'>CUPS 1.6/macOS 10.8</span><a name='cupsMaxCopies'>cupsMaxCopies</a></h3> 1441 1442<p class='summary'>*cupsMaxCopies: integer</p> 1443 1444<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> 1445 1446<p>Example:</p> 1447 1448<pre class='command'> 1449<em>*% Tell the RIP filters we can do up to 99 copies</em> 1450*cupsMaxCopies: 99 1451</pre> 1452 1453 1454<h3 class="title"><a name='cupsModelNumber'>cupsModelNumber</a></h3> 1455 1456<p class='summary'>*cupsModelNumber: number</p> 1457 1458<p>This integer keyword specifies a printer-specific model 1459number. This number can be used by a filter program to adjust 1460the output for a specific model of printer.</p> 1461 1462<p>Example:</p> 1463 1464<pre class='command'> 1465<em>*% Specify an integer for a driver-specific model number</em> 1466*cupsModelNumber: 1234 1467</pre> 1468 1469 1470<h3 class="title"><span class='info'>CUPS 1.3/macOS 10.5</span><a name='cupsPJLCharset'>cupsPJLCharset</a></h3> 1471 1472<p class='summary'>*cupsPJLCharset: "ISO character set name"</p> 1473 1474<p>This string keyword specifies the character set that is used 1475for strings in PJL commands. If not specified, US-ASCII is 1476assumed.</p> 1477 1478<p>Example:</p> 1479 1480<pre class='command'> 1481<em>*% Specify UTF-8 is used in PJL strings</em> 1482*cupsPJLCharset: "UTF-8" 1483</pre> 1484 1485 1486<h3 class="title"><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsPJLDisplay'>cupsPJLDisplay</a></h3> 1487 1488<p class='summary'>*cupsPJLDisplay: "what"</p> 1489 1490<p>This optional keyword specifies which command is used to display the 1491job ID, name, and user on the printer's control panel. "What" is either "none" 1492to disable this functionality, "job" to use "@PJL JOB DISPLAY", or "rdymsg" 1493to use "@PJL RDYMSG DISPLAY". The default is "job".</p> 1494 1495<p>Examples:</p> 1496 1497<pre class='command'> 1498<em>*% Display job information using @PJL SET RDYMSG DISPLAY="foo"</em> 1499*cupsPJLDisplay: "rdymsg" 1500 1501<em>*% Display job information display</em> 1502*cupsPJLDisplay: "none" 1503</pre> 1504 1505 1506<h3 class="title"><span class='info'>CUPS 1.2/macOS 10.5</span><a name='cupsPortMonitor'>cupsPortMonitor</a></h3> 1507 1508<p class='summary'>*cupsPortMonitor urischeme/Descriptive Text: "port monitor"</p> 1509 1510<p>This string keyword specifies printer-specific "port 1511monitor" filters that may be used with the printer. The CUPS 1512scheduler also looks for the <tt>Protocols</tt> keyword to see 1513if the <tt>BCP</tt> or <tt>TBCP</tt> protocols are supported. If 1514so, the corresponding port monitor ("bcp" and "tbcp", 1515respectively) is listed in the printer's 1516<tt>port-monitor-supported</tt> keyword.</p> 1517 1518<p>The "urischeme" portion of the keyword specifies the URI scheme 1519that this port monitor should be used for. Typically this is used to 1520pre-select a particular port monitor for each type of connection that 1521is supported by the printer. The "port monitor" string can be "none" 1522to disable the port monitor for the given URI scheme.</p> 1523 1524<p>Examples:</p> 1525 1526<pre class='command'> 1527<em>*% Specify a PostScript printer that supports the TBCP protocol</em> 1528*Protocols: TBCP PJL 1529 1530<em>*% Specify that TBCP should be used for socket connections but not USB</em> 1531*cupsPortMonitor socket/AppSocket Printing: "tbcp" 1532*cupsPortMonitor usb/USB Printing: "none" 1533 1534<em>*% Specify a printer-specific port monitor for an Epson USB printer</em> 1535*cupsPortMonitor usb/USB Status Monitor: "epson-usb" 1536</pre> 1537 1538 1539<h3 class="title"><span class='info'>CUPS 1.3/macOS 10.5</span><a name='cupsPreFilter'>cupsPreFilter</a></h3> 1540 1541<p class='summary'>*cupsPreFilter: "source/type cost program"</p> 1542 1543<p>This string keyword provides a pre-filter rule. The pre-filter 1544program will be inserted in the conversion chain immediately 1545before the filter that accepts the given MIME type.</p> 1546 1547<p>Examples:</p> 1548 1549<pre class='command'> 1550<em>*% PDF pre-filter</em> 1551*cupsPreFilter: "application/pdf 100 mypdfprefilter" 1552 1553<em>*% PNG pre-filter</em> 1554*cupsPreFilter: "image/png 0 mypngprefilter" 1555</pre> 1556 1557 1558<h3 class="title"><span class='info'>CUPS 1.5</span><a name='cupsPrintQuality'>cupsPrintQuality</a></h3> 1559 1560<p class='summary'>*cupsPrintQuality keyword/text: "code"</p> 1561 1562<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> 1563 1564<blockquote><b>Note:</b> 1565 1566<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> 1567 1568</blockquote> 1569 1570<p>Examples:</p> 1571 1572<pre class='command'> 1573*OpenUI *cupsPrintQuality/Print Quality: PickOne 1574*OrderDependency: 10 AnySetup *cupsPrintQuality 1575*DefaultcupsPrintQuality: Normal 1576*cupsPrintQuality Draft/Draft: "code" 1577*cupsPrintQuality Normal/Normal: "code" 1578*cupsPrintQuality High/Photo: "code" 1579*CloseUI: *cupsPrintQuality 1580</pre> 1581 1582 1583<h3 class="title"><span class='info'>CUPS 1.5</span><a name='cupsSingleFile'>cupsSingleFile</a></h3> 1584 1585<p class='summary'>*cupsSingleFile: Boolean</p> 1586 1587<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> 1588 1589<p>Examples:</p> 1590 1591<pre class='command'> 1592<em>*% Send all print data to a single backend</em> 1593*cupsSingleFile: False 1594 1595<em>*% Send each file using a separate backend</em> 1596*cupsSingleFile: True 1597</pre> 1598 1599 1600<h3 class="title"><span class='info'>CUPS 1.4/macOS 10.6</span><a name='cupsSNMPSupplies'>cupsSNMPSupplies</a></h3> 1601 1602<p class='summary'>*cupsSNMPSupplies: boolean</p> 1603 1604<p>This keyword tells the standard network backends whether they should query 1605the standard SNMP Printer MIB OIDs for supply levels. The default value is 1606<code>True</code>. 1607 1608<p>Example:</p> 1609 1610<pre class='command'> 1611<em>*% Do not use SNMP queries to report supply levels</em> 1612*cupsSNMPSupplies: False 1613</pre> 1614 1615 1616<h3 class="title"><a name='cupsVersion'>cupsVersion</a></h3> 1617 1618<p class='summary'>*cupsVersion: major.minor</p> 1619 1620<p>This required keyword describes which version of the CUPS 1621PPD file extensions was used. Currently it must be the string 1622"1.0", "1.1", "1.2", "1.3", "1.4", "1.5", or "1.6".</p> 1623 1624<p>Example:</p> 1625 1626<pre class='command'> 1627<em>*% Specify a CUPS 1.2 driver</em> 1628*cupsVersion: "1.2" 1629</pre> 1630 1631 1632<h3 class="title"><span class="info">CUPS 1.6/macOS 10.8</span><a name="JCLToPDFInterpreter">JCLToPDFInterpreter</a></h3> 1633 1634<p class="summary">*JCLToPDFInterpreter: "JCL"</p> 1635 1636<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> 1637 1638<p>Example:</p> 1639 1640<pre class='command'> 1641<em>*% PJL command to start the PDF interpreter</em> 1642*JCLToPDFInterpreter: "@PJL ENTER LANGUAGE = PDF<0A>" 1643</pre> 1644 1645 1646<h2 class='title'><a name='MACOSX'>macOS Attributes</a></h2> 1647 1648<h3 class="title"><span class='info'>Deprecated</span><a name='APDialogExtension'>APDialogExtension</a></h3> 1649 1650<p class='summary'>*APDialogExtension: "/Library/Printers/vendor/filename.plugin"</p> 1651 1652<p>This keyword defines additional option panes that are displayed in the 1653print dialog. Each keyword adds one or more option panes. See the "OutputBinsPDE" 1654example and <a href='http://developer.apple.com/qa/qa2004/qa1352.html'>Apple 1655Technical Q&A QA1352</a> for information on writing your own print dialog 1656plug-ins.</p> 1657 1658<blockquote><b>Note:</b> 1659 1660<p>Since 2010, AirPrint has enabled the printing of full quality photos and 1661documents from the Mac without requiring driver software. Starting with macOS 166210.12, system level security features prevent print dialog plug-ins from being 1663loaded into applications that have enabled the library validation security 1664feature. As of macOS 10.14 the <code>APDialogExtension</code> attribute used to 1665create macOS print drivers is deprecated. All new printer models should support 1666AirPrint moving forward.</p> 1667 1668</blockquote> 1669 1670<p>Examples:</p> 1671 1672<pre class='command'> 1673*% Add two panes for finishing and driver options 1674*APDialogExtension: "/Library/Printers/vendor/finishing.plugin" 1675*APDialogExtension: "/Library/Printers/vendor/options.plugin" 1676</pre> 1677 1678 1679<h3 class="title"><span class='info'>macOS 10.4</span><a name='APDuplexRequiresFlippedMargin'>APDuplexRequiresFlippedMargin</a></h3> 1680 1681<p class='summary'>*APDuplexRequiresFlippedMargin: boolean</p> 1682 1683<p>This boolean keyword notifies the RIP filters that the 1684destination printer requires the top and bottom margins of the 1685<tt>ImageableArea</tt> to be swapped for the back page. The 1686default is <tt>true</tt> when <tt>cupsBackSide</tt> is <tt>Flipped</tt> 1687and <tt>false</tt> otherwise. <a href='#TABLE_2'>Table 2</a> shows how 1688<tt>APDuplexRequiresFlippedMargin</tt> interacts with <tt>cupsBackSide</tt> 1689and the <tt>Tumble</tt> page attribute.</p> 1690 1691<div class='table'> 1692<table width='80%' summary='Margin Flipping Modes'> 1693<caption>Table 2: <a name='TABLE_2'>Margin Flipping Modes</a></caption> 1694<thead> 1695<tr> 1696 <th>APDuplexRequiresFlippedMargin</th> 1697 <th>cupsBackSide</th> 1698 <th>Tumble Value</th> 1699 <th>Margins</th> 1700</tr> 1701</thead> 1702<tbody> 1703<tr> 1704 <td>false</td> 1705 <td>any</td> 1706 <td>any</td> 1707 <td>Normal</td> 1708</tr> 1709<tr> 1710 <td>any</td> 1711 <td>Normal</td> 1712 <td>any</td> 1713 <td>Normal</td> 1714</tr> 1715<tr> 1716 <td>true</td> 1717 <td>ManualDuplex</td> 1718 <td>false</td> 1719 <td>Normal</td> 1720</tr> 1721<tr> 1722 <td>true</td> 1723 <td>ManualDuplex</td> 1724 <td>true</td> 1725 <td>Flipped</td> 1726</tr> 1727<tr> 1728 <td>true</td> 1729 <td>Rotated</td> 1730 <td>false</td> 1731 <td>Flipped</td> 1732</tr> 1733<tr> 1734 <td>true</td> 1735 <td>Rotated</td> 1736 <td>true</td> 1737 <td>Normal</td> 1738</tr> 1739<tr> 1740 <td>true or unspecified</td> 1741 <td>Flipped</td> 1742 <td>any</td> 1743 <td>Flipped</td> 1744</tr> 1745</tbody> 1746</table></div> 1747 1748<p>Example:</p> 1749 1750<pre class='command'> 1751<em>*% Rotate the back side images</em> 1752*cupsBackSide: Rotated 1753 1754<em>*% Don't swap the top and bottom margins for the back side</em> 1755*APDuplexRequiresFlippedMargin: false 1756</pre> 1757 1758<p>Also see the related <a href='#cupsBackSide'><tt>cupsBackSide</tt></a> 1759keyword.</p> 1760 1761 1762<h3 class="title"><a name='APHelpBook'>APHelpBook</a></h3> 1763 1764<p class='summary'>*APHelpBook: "bundle URL"</p> 1765 1766<p>This string keyword specifies the Apple help book bundle to use when 1767looking up IPP reason codes for this printer driver. The 1768<a href='#cupsIPPReason'><tt>cupsIPPReason</tt></a> keyword maps 1769"help" URIs to this file.</p> 1770 1771<p>Example:</p> 1772 1773<pre class='command'> 1774*APHelpBook: "file:///Library/Printers/vendor/Help.bundle" 1775</pre> 1776 1777 1778<h3 class="title"><span class='info'>macOS 10.6</span><a name='APICADriver'>APICADriver</a></h3> 1779 1780<p class='summary'>*APICADriver: boolean</p> 1781 1782<p>This keyword specifies whether the device has a matching Image Capture 1783Architecture (ICA) driver for scanning. The default is <tt>False</tt>.</p> 1784 1785<p>Examples:</p> 1786 1787<pre class='command'> 1788*APICADriver: True 1789*APScanAppBundleID: "com.apple.ImageCaptureApp" 1790</pre> 1791 1792 1793<h3 class="title"><span class='info'>macOS 10.3</span><a name='APPrinterIconPath'>APPrinterIconPath</a></h3> 1794 1795<p class='summary'>*APPrinterIconPath: "/Library/Printers/vendor/filename.icns"</p> 1796 1797<p>This keyword defines the location of a printer icon file to use when 1798displaying the printer. The file must be in the Apple icon format.</p> 1799 1800<p>Examples:</p> 1801 1802<pre class='command'> 1803*% Apple icon file 1804*APPrinterIconPath: "/Library/Printers/vendor/Icons/filename.icns" 1805</pre> 1806 1807 1808<h3 class="title"><span class='info'>macOS 10.4</span><a name='APPrinterLowInkTool'>APPrinterLowInkTool</a></h3> 1809 1810<p class='summary'>*APPrinterLowInkTool: "/Library/Printers/vendor/program"</p> 1811 1812<p>This keyword defines an program that checks the ink/toner/marker levels 1813on a printer, returning an XML document with those levels. See the "InkTool" 1814example and 1815<a href='http://developer.apple.com/technotes/tn2005/tn2144.html'>Apple 1816Technical Note TN2144</a> for more information.</p> 1817 1818<p>Examples:</p> 1819 1820<pre class='command'> 1821*% Use a vendor monitoring program 1822*APPrinterLowInkTool: "/Library/Printers/vendor/Tools/lowinktool" 1823</pre> 1824 1825 1826<h3 class="title"><span class='info'>macOS 10.5</span><a name='APPrinterPreset'>APPrinterPreset</a></h3> 1827 1828<p class='summary'>*APPrinterPreset name/text: "*Option Choice ..."</p> 1829 1830<p>This keyword defines presets for multiple options that show up 1831in the print dialog of applications (such as iPhoto) that set the job 1832style hint to <tt>NSPrintPhotoJobStyleHint</tt>. Each preset maps to one or 1833more pairs of PPD options and choices as well as providing key/value data for 1834the application. The following standard preset names are currently defined:</p> 1835 1836<ul> 1837 1838 <li><code>General_with_Paper_Auto-Detect</code>; Normal quality general printing with auto-detected media.</li> 1839 1840 <li><code>General_with_Paper_Auto-Detect_-_Draft</code>; Draft quality general printing with auto-detected media.</li> 1841 1842 <li><code>General_on_Plain_Paper</code>; Normal quality general printing on plain paper.</li> 1843 1844 <li><code>General_on_Plain_Paper_-_Draft</code>; Draft quality general printing on plain paper.</li> 1845 1846 <li><code>Photo_with_Paper_Auto-Detect</code>; Normal quality photo printing with auto-detected media.</li> 1847 1848 <li><code>Photo_with_Paper_Auto-Detect_-_Fine</code>; High quality photo printing with auto-detected media.</li> 1849 1850 <li><code>Photo_on_Plain_Paper</code>; Normal quality photo printing on plain paper.</li> 1851 1852 <li><code>Photo_on_Plain_Paper_-_Fine</code>; High quality photo printing on plain paper.</li> 1853 1854 <li><code>Photo_on_Photo_Paper</code>; Normal quality photo printing on glossy photo paper.</li> 1855 1856 <li><code>Photo_on_Photo_Paper_-_Fine</code>; High quality photo printing on glossy photo paper.</li> 1857 1858 <li><code>Photo_on_Matte_Paper</code>; Normal quality photo printing on matte paper.</li> 1859 1860 <li><code>Photo_on_Matte_Paper_-_Fine</code>; High quality photo printing on matte paper.</li> 1861 1862</ul> 1863 1864<p>The value string consists of pairs of keywords, either an option name and 1865choice (*MainKeyword OptionKeyword) or a preset identifier and value 1866(com.apple.print.preset.foo value). The following preset identifiers are currently used:</p> 1867 1868<ul> 1869 1870 <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> 1871 1872 <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> 1873 1874 <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&W printers).</li> 1875 1876 <li><code>com.apple.print.preset.quality</code>; specifies the overall print quality selected by this preset - "low" (draft), "mid" (normal), or "high".</li> 1877 1878</ul> 1879 1880<p>Presets, like options, can also be localized in multiple languages.</p> 1881 1882<p>Examples:</p> 1883 1884<pre class='command'> 1885*APPrinterPreset Photo_on_Photo_Paper/Photo on Photo Paper: " 1886 *MediaType Glossy 1887 *ColorModel RGB 1888 *Resolution 300dpi 1889 com.apple.print.preset.graphicsType Photo 1890 com.apple.print.preset.quality mid 1891 com.apple.print.preset.media-front-coating glossy" 1892*End 1893*fr.APPrinterPreset Photo_on_Photo_Paper/Photo sur papier photographique: "" 1894</pre> 1895 1896 1897<h3 class="title"><span class='info'>macOS 10.3</span><a name='APPrinterUtilityPath'>APPrinterUtilityPath</a></h3> 1898 1899<p class='summary'>*APPrinterPrinterUtilityPath: "/Library/Printers/vendor/filename.app"</p> 1900 1901<p>This keyword defines a GUI application that can be used to do printer 1902maintenance functions such as cleaning the print head(s). See ... for more 1903information.</p> 1904 1905<p>Examples:</p> 1906 1907<pre class='command'> 1908*% Define the printer utility application 1909*APPrinterPrinterUtilityPath: "/Library/Printers/vendor/Tools/utility.app" 1910</pre> 1911 1912 1913<h3 class="title"><span class='info'>macOS 10.6</span><a name='APScannerOnly'>APScannerOnly</a></h3> 1914 1915<p class='summary'>*APScannerOnly: boolean</p> 1916 1917<p>This keyword specifies whether the device has scanning but no printing 1918capabilities. The default is <tt>False</tt>.</p> 1919 1920<p>Examples:</p> 1921 1922<pre class='command'> 1923*APICADriver: True 1924*APScannerOnly: True 1925</pre> 1926 1927 1928<h3 class="title"><span class='info'>macOS 10.3</span><a name='APScanAppBundleID'>APScanAppBundleID</a></h3> 1929 1930<p class='summary'>*APScanAppBundleID: "bundle ID"</p> 1931 1932<p>This keyword defines the application to use when scanning pages from 1933the device.</p> 1934 1935<p>Examples:</p> 1936 1937<pre class='command'> 1938*APICADriver: True 1939*APScanAppBundleID: "com.apple.ImageCaptureApp" 1940</pre> 1941 1942 1943<h2 class='title'><a name='HISTORY'>Change History</a></h2> 1944 1945<h3 class="title">Changes in CUPS 2.3</h3> 1946 1947<ul> 1948 1949 <li>Added <a href="#cupsFinishingTemplate"><tt>cupsFinishingTemplate</tt></a> option.</li> 1950 1951</ul> 1952 1953 1954<h3 class="title">Changes in CUPS 1.7</h3> 1955 1956<ul> 1957 1958 <li>Added <a href="#cupsJobAccountId"><tt>cupsJobAccountId</tt></a>, 1959 <a href="#cupsJobAccountingUserId"><tt>cupsJobAccountingUserId</tt></a>, 1960 <a href="#cupsJobPassword"><tt>cupsJobPassword</tt></a>, 1961 <a href="#cupsMandatory"><tt>cupsMandatory</tt></a> keywords.</li> 1962 1963</ul> 1964 1965 1966<h3 class="title">Changes in CUPS 1.6</h3> 1967 1968<ul> 1969 1970 <li>Added <a href="#cupsPageSizeCategory"><tt>cupsPageSizeCategory</tt></a> keyword (originally defined in CUPS 1.4).</li> 1971 1972 <li>Added <a href="#cupsMaxCopies"><tt>cupsMaxCopies</tt></a> keyword.</li> 1973 1974 <li>Documented <a href="#JCLToPDFInterpreter"><tt>JCLToPDFInterpreter</tt></a> keyword.</li> 1975 1976 <li>Updated <a href="#cupsVersion"><tt>cupsVersion</tt></a> keyword documentation to list all current releases of CUPS.</li> 1977 1978</ul> 1979 1980 1981<h3 class="title">Changes in CUPS 1.5</h3> 1982 1983<ul> 1984 1985 <li>Changes all instances of PPD attributes to PPD keywords, to be consistent with the parent specification from Adobe.</li> 1986 1987</ul> 1988 1989 1990<h3 class="title">Changes in CUPS 1.4.5</h3> 1991 1992<ul> 1993 1994 <li>Added <a href='#cupsPrintQuality'><tt>cupsPrintQuality</tt></a> UI keyword.</li> 1995 1996 <li>Added new properties and values for the <a href='#APPrinterPreset'><tt>APPrinterPreset</tt></a> keyword.</li> 1997 1998</ul> 1999 2000 2001<h3 class="title">Changes in CUPS 1.4</h3> 2002 2003<ul> 2004 2005 <li>Added <a href='#APICADriver'><tt>APICADriver</tt></a> 2006 keyword.</li> 2007 2008 <li>Added <a href='#cupsCommands'><tt>cupsCommands</tt></a> 2009 keyword.</li> 2010 2011 <li>Added <a href='#cupsMarkerName'><tt>cupsMarkerName</tt></a> 2012 keyword.</li> 2013 2014 <li>Added <a href='#cupsMarkerNotice'><tt>cupsMarkerNotice</tt></a> 2015 keyword.</li> 2016 2017 <li>Added <a href='#cupsPJLDisplay'><tt>cupsPJLDisplay</tt></a> 2018 keyword.</li> 2019 2020 <li>Added <a href='#cupsSNMPSupplies'><tt>cupsSNMPSupplies</tt></a> 2021 keyword.</li> 2022 2023 <li>Added <a href='#cupsUIResolver'><tt>cupsUIResolver</tt></a> and 2024 <a href='#cupsUIConstraints'><tt>cupsUIConstraints</tt></a> 2025 keywords.</li> 2026 2027 <li>Added 2028 <a href='#cupsMediaQualifier2'><tt>cupsMediaQualifier2</tt></a>, 2029 <a href='#cupsMediaQualifier3'><tt>cupsMediaQualifier3</tt></a>, 2030 <a href='#cupsMinSize'><tt>cupsMinSize</tt></a>, and 2031 <a href='#cupsMaxSize'><tt>cupsMaxSize</tt></a> keywords.</li> 2032 2033</ul> 2034 2035 2036<h3 class="title">Changes in CUPS 1.3.1</h3> 2037 2038<ul> 2039 2040 <li>Added missing macOS <tt>AP</tt> keywords.</li> 2041 2042 <li>Added section on auto-configuration including the 2043 <tt>OID<i>MainKeyword</i></tt> and <tt>?<i>MainKeyword</i></tt> 2044 keywords.</li> 2045 2046 <li>Minor reorganization.</li> 2047 2048</ul> 2049 2050 2051<h3 class="title">Changes in CUPS 1.3</h3> 2052 2053<ul> 2054 2055 <li>Added <a href='#cupsBackSide'><tt>cupsBackSide</tt></a> and 2056 deprecated <a href='#cupsFlipDuplex'><tt>cupsFlipDuplex</tt></a>.</li> 2057 2058 <li>Added text URI information to 2059 <a href='#cupsIPPReason'><tt>cupsIPPReason</tt></a> documentation.</li> 2060 2061 <li>Added <a href='#APPrinterPreset'><tt>APPrinterPreset</tt></a>, 2062 <a href='#cupsIPPFinishings'><tt>cupsIPPFinishings</tt></a>, and 2063 <a href='#cupsPreFilter'><tt>cupsPreFilter</tt></a> keywords.</li> 2064 2065 <li>Added discussion of custom option code, sample 2066 <tt>CustomPageSize</tt> code, and "do not use dict and put" note.</li> 2067 2068</ul> 2069 2070 2071<h3 class="title">Changes in CUPS 1.2.8</h3> 2072 2073<ul> 2074 2075 <li>Added section on supported PostScript commands for raster 2076 drivers</li> 2077 2078</ul> 2079 2080 2081<h3 class="title">Changes in CUPS 1.2</h3> 2082 2083<ul> 2084 2085 <li>Added globalization support keywords</li> 2086 2087 <li>Added custom option values support</li> 2088 2089 <li>Added <a href='#APHelpBook'><tt>APHelpBook</tt></a> keyword</li> 2090 2091 <li>Added <a href='#APDuplexRequiresFlippedMargin'><tt>APDuplexRequiresFlippedMargin</tt></a> 2092 keyword</li> 2093 2094 <li>Added <a href='#cupsICCProfile'><tt>cupsICCProfile</tt></a> keyword</li> 2095 2096 <li>Added <a href='#cupsIPPReason'><tt>cupsIPPReason</tt></a> keyword</li> 2097 2098 <li>Added <a href='#cupsLanguages'><tt>cupsLanguages</tt></a> keyword</li> 2099 2100 <li>Added <a href='#cupsPortMonitor'><tt>cupsPortMonitor</tt></a> keyword</li> 2101 2102 <li>Removed <tt>cupsProtocol</tt> keyword</li> 2103 2104</ul> 2105 2106 2107<h3 class="title">Changes in CUPS 1.1</h3> 2108 2109<ul> 2110 2111 <li>Added <a href='#cupsFlipDuplex'><tt>cupsFlipDuplex</tt></a> keyword</li> 2112 2113 <li>Added <tt>cupsProtocol</tt> keyword</li> 2114 2115</ul> 2116
