doc/help/spec-ppd.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
   2 <html>
   3 <!-- SECTION: Specifications -->
   4 <head>
   5         <title>CUPS PPD Extensions</title>
   6         <meta name='keywords' content='Programming, PostScript Printer Description'>
   7         <link rel='stylesheet' type='text/css' href='../cups.css'>
   8 </head>
   9 <body>
  10 <!--
  11   "$Id: spec-ppd.html 6096 2006-11-14 17:06:28Z mike $"
  12
  13   CUPS PPD extensions specification for the Common UNIX Printing System (CUPS).
  14
  15   Copyright 1997-2006 by Easy Software Products.
  16
  17   These coded instructions, statements, and computer programs are the
  18   property of Easy Software Products and are protected by Federal
  19   copyright law.  Distribution and use rights are outlined in the file
  20   "LICENSE.txt" which should have been included with this file.  If this
  21   file is missing or damaged please contact Easy Software Products
  22   at:
  23
  24       Attn: CUPS Licensing Information
  25       Easy Software Products
  26       44141 Airport View Drive, Suite 204
  27       Hollywood, Maryland 20636 USA
  28
  29       Voice: (301) 373-9600
  30       EMail: cups-info@cups.org
  31         WWW: http://www.cups.org
  32 -->
  33
  34 <h2 class='title'><a name='INTRODUCTION'>Introduction</a></h2>
  35
  36 <p>This specification describes the attributes and extensions
  37 that CUPS adds to <a
  38 href="http://partners.adobe.com/public/developer/en/ps/5003.PPD_Spec_v4.3.pdf">
  39 Adobe TechNote #5003: PostScript Printer Description File Format
  40 Specification Version 4.3</a>. PostScript Printer Description
  41 ("PPD") files describe the capabilities of each printer and are
  42 used by CUPS to support printer-specific features and intelligent
  43 filtering.</p>
  44
  45 <h2 class='title'><a name='SYNTAX'>PPD File Syntax</a></h2>
  46
  47 <p>The PPD format is text-based and uses lines of up to 255
  48 characters terminated by a carriage return, linefeed, or
  49 combination of carriage return and line feed. The following ABNF
  50 definition [RFC2234] defines the general format of lines in a PPD
  51 file:</p>
  52
  53 <pre class='command'>
  54 PPD-FILE = HEADER +(DATA / COMMENT / LINE-END)
  55
  56 HEADER   = "*" 0x50.50.44.2D.41.64.6F.62.65 ":"   ; *PPD-Adobe:
  57            *WSP DQUOTE "4.3" DQUOTE LINE-END
  58
  59 COMMENT  = "*%" *TCHAR LINE-END
  60
  61 DATA     = "*" 1*KCHAR [ WSP 1*KCHAR [ "/" 1*TCHAR ] ] ":"
  62            1*(*WSP VALUE) LINE-END
  63
  64 VALUE    = 1*TCHAR / DQUOTE 1*SCHAR DQUOTE
  65
  66 KCHAR    = ALPHA / DIGIT / "_" / "." / "-"
  67
  68 SCHAR    = LINE-END / WSP / %x21 / %x23-7E / %xA0-FF
  69
  70 TCHAR    = %x20-7E / %xA0-FF
  71
  72 LINE-END = CR / LF / CR LF
  73 </pre>
  74
  75
  76 <h2 class='title'><a name='ATTRIBUTES'>General Attributes</a></h2>
  77
  78 <h3>APBookFile</h3>
  79
  80 <p class='summary'>*APBookFile: "file URL"</p>
  81
  82 <p>This string attribute specifies the Apple help book file to use
  83 for this printer driver.</p>
  84
  85 <p>Example:</p>
  86
  87 <pre class='command'>
  88 *APBookFile: "file:///Library/Printers/vendor/Help/filename"
  89 </pre>
  90
  91 <h3>APDuplexRequiresFlippedMargin</h3>
  92
  93 <p class='summary'>*APDuplexRequiresFlippedMargin: boolean</p>
  94
  95 <p>This boolean attribute notifies the RIP filters that the
  96 destination printer does not require the top and bottom margins
  97 of the <tt>ImageableArea</tt> swapped for the back page. The
  98 default is <tt>true</tt> when <tt>cupsFlipDuplex</tt>  is <tt>true</tt> and <tt>false</tt> otherwise.</p>
  99
 100 <p>Example:</p>
 101
 102 <pre class='command'>
 103 <em>*% Flip the back side images</em>
 104 *cupsFlipDuplex: true
 105
 106 <em>*% Don't swap the top and bottom margins for the back side</em>
 107 *APDuplexRequiresFlippedMargin: false
 108 </pre>
 109
 110 <p>Also see the related <tt>cupsFlipDuplex</tt> attribute.</p>
 111
 112 <h3>cupsEvenDuplex</h3>
 113
 114 <p class='summary'>*cupsEvenDuplex: boolean</p>
 115
 116 <p>This boolean attribute notifies the RIP filters that the
 117 destination printer requires an even number of pages when 2-sided
 118 printing is selected. The default value is <code>false</code>.</p>
 119
 120 <p>Example:</p>
 121
 122 <pre class='command'>
 123 <em>*% Always send an even number of pages when duplexing</em>
 124 *cupsEvenDuplex: true
 125 </pre>
 126
 127 <h3>cupsFilter</h3>
 128
 129 <p class='summary'>*cupsFilter: "source/type cost program"</p>
 130
 131 <p>This string attribute provides a conversion rule from the
 132 given source type to the printer's native format using the
 133 filter "program". If a printer supports the source type directly,
 134 the special filter program "-" may be specified.</p>
 135
 136 <p>Examples:</p>
 137
 138 <pre class='command'>
 139 <em>*% Standard raster printer driver filter</em>
 140 *cupsFilter: "application/vnd.cups-raster 100 rastertofoo"
 141
 142 <em>*% Plain text filter</em>
 143 *cupsFilter: "text/plain 10 texttofoo"
 144
 145 <em>*% Pass-through filter for PostScript printers</em>
 146 *cupsFilter: "application/vnd.cups-postscript 0 -"
 147 </pre>
 148
 149 <h3>cupsFlipDuplex</h3>
 150
 151 <p class='summary'>*cupsFlipDuplex: boolean</p>
 152
 153 <p>This boolean attribute notifies the RIP filters that the
 154 destination printer requires an upside-down image for the back
 155 page. The default value is <code>false</code>.</p>
 156
 157 <p>Example:</p>
 158
 159 <pre class='command'>
 160 <em>*% Flip the page image for the back side of duplexed output</em>
 161 *cupsFlipDuplex: true
 162 </pre>
 163
 164 <p>Also see the related <tt>APDuplexRequiresFlippedMargins</tt>
 165 attribute.</p>
 166
 167 <h3>cupsIPPReason</h3>
 168
 169 <p class='summary'>*cupsIPPReason reason/Reason Text: "optional URIs"</p>
 170
 171 <p>This optional attribute maps custom
 172 <code>printer-state-reasons</code> keywords that are generated by
 173 the driver to human readable text. The optional URIs string
 174 contains zero or more URIs separated by a newline. Each URI can
 175 be a CUPS server absolute path to a help file under the
 176 scheduler's <code>DocumentRoot</code> directory, a full HTTP URL
 177 ("http://www.domain.com/path/to/help/page.html"), or any other
 178 valid URI which directs the user at additional information
 179 concerning the condition that is being reported.</p>
 180
 181 <p>Examples:</p>
 182
 183 <pre class='command'>
 184 <em>*% Map com.vendor-error to text but no page</em>
 185 *cupsIPPReason com.vendor-error/A serious error occurred: ""
 186
 187 <em>*% Map com.vendor-error to text and a local page</em>
 188 *cupsIPPReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html"
 189
 190 <em>*% Map com.vendor-error to text and a remote page</em>
 191 *cupsIPPReason com.vendor-error/A serious error occurred: "http://www.vendor.com/help"
 192
 193 <em>*% Map com.vendor-error to text and a local, Apple help book, and remote page</em>
 194 *APHelpBook: "file:///Library/Printers/vendor/Help/filename"
 195 *cupsIPPReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html
 196 help:anchor='com.vendor-error'%20bookID=Vendor%20Help
 197 http://www.vendor.com/help"
 198 *End
 199 </pre>
 200
 201 <h3>cupsLanguages</h3>
 202
 203 <p class='summary'>*cupsLanguages: "locale list"</p>
 204
 205 <p>This attribute describes which language localizations are
 206 included in the PPD. The "locale list" string is a space-delimited
 207 list of locale names ("en", "en_US", "fr_FR", etc.)</p>
 208
 209 <p>Example:</p>
 210
 211 <pre class='command'>
 212 <em>*% Specify Canadian, UK, and US English, and Candian and French French</em>
 213 *cupsLanguages: "en_CA en_UK en_US fr_CA fr_FR"
 214 </pre>
 215
 216 <h3>cupsManualCopies</h3>
 217
 218 <p class='summary'>*cupsManualCopies: boolean</p>
 219
 220 <p>This boolean attribute notifies the RIP filters that the
 221 destination printer does not support copy generation in
 222 hardware. The default value is <code>false</code>.</p>
 223
 224 <p>Example:</p>
 225
 226 <pre class='command'>
 227 <em>*% Tell the RIP filters to generate the copies for us</em>
 228 *cupsManualCopies: true
 229 </pre>
 230
 231 <h3>cupsModelNumber</h3>
 232
 233 <p class='summary'>*cupsModelNumber: number</p>
 234
 235 <p>This integer attribute specifies a printer-specific model
 236 number. This number can be used by a filter program to adjust
 237 the output for a specific model of printer.</p>
 238
 239 <p>Example:</p>
 240
 241 <pre class='command'>
 242 <em>*% Specify an integer for a driver-specific model number</em>
 243 *cupsModelNumber: 1234
 244 </pre>
 245
 246 <h3>cupsPortMonitor</h3>
 247
 248 <p class='summary'>*cupsPortMonitor urischeme/Descriptive Text: "port monitor"</p>
 249
 250 <p>This string attribute specifies printer-specific "port
 251 monitor" filters that may be used with the printer. The CUPS
 252 scheduler also looks for the <tt>Protocols</tt> attribute to see
 253 if the <tt>BCP</tt> or <tt>TBCP</tt> protocols are supported. If
 254 so, the corresponding port monitor ("bcp" and "tbcp",
 255 respectively) is listed in the printer's
 256 <tt>port-monitor-supported</tt> attribute.</p>
 257
 258 <p>The "urischeme" portion of the attribute specifies the URI scheme
 259 that this port monitor should be used for. Typically this is used to
 260 pre-select a particular port monitor for each type of connection that
 261 is supported by the printer. The "port monitor" string can be "none"
 262 to disable the port monitor for the given URI scheme.</p>
 263
 264 <p>Examples:</p>
 265
 266 <pre class='command'>
 267 <em>*% Specify a PostScript printer that supports the TBCP protocol</em>
 268 *Protocols: TBCP PJL
 269
 270 <em>*% Specify that TBCP should be used for socket connections but not USB</em>
 271 *cupsPortMonitor socket/AppSocket Printing: "tbcp"
 272 *cupsPortMonitor usb/USB Printing: "none"
 273
 274 <em>*% Specify a printer-specific port monitor for an Epson USB printer</em>
 275 *cupsPortMonitor usb/USB Status Monitor: "epson-usb"
 276 </pre>
 277
 278 <h3>cupsVersion</h3>
 279
 280 <p class='summary'>*cupsVersion: major.minor</p>
 281
 282 <p>This required attribute describes which version of the CUPS
 283 PPD file extensions was used. Currently it must be the string
 284 "1.0", "1.1", or "1.2".</p>
 285
 286 <p>Example:</p>
 287
 288 <pre class='command'>
 289 <em>*% Specify a CUPS 1.2 driver</em>
 290 *cupsVersion: "1.2"
 291 </pre>
 292
 293 <h2 class='title'><a name='OPTIONS'>Custom Options</a></h2>
 294
 295 <p>CUPS supports custom options using an extension of the
 296 <tt>CustomPageSize</tt> and <tt>ParamCustomPageSize</tt>
 297 syntax:</p>
 298
 299 <pre class='command'>
 300 *CustomFoo True: "command"
 301 *ParamCustomFoo Name1/Text 1: order type minimum maximum
 302 *ParamCustomFoo Name2/Text 2: order type minimum maximum
 303 ...
 304 *ParamCustomFoo NameN/Text N: order type minimum maximum
 305 </pre>
 306
 307 <p>When the base option is part of the <tt>JCLSetup</tt> section,
 308 the "command" string contains JCL commands with "\order"
 309 placeholders for each numbered parameter. The CUPS API handles
 310 any necessary value quoting for HP-PJL commands. For example, if
 311 the JCL command string is "@PJL SET PASSCODE=\1" and the first
 312 option value is "1234" then CUPS will output the string
 313 "@PJL SET PASSCODE=1234".</p>
 314
 315 <p>For non-<tt>JCLSetup</tt> options, the "order" value is a
 316 number from 1 to N and specifies the order of values as they are
 317 placed on the stack before the command. For example, if the
 318 PostScript command string is
 319 "&lt;&lt;/cupsReal1 2 1 roll&gt;&gt;setpagedevice" and the
 320 option value is "2.0" then CUPS will output the string
 321 "2.0 &lt;&lt;/cupsReal1 2 1 roll&gt;&gt;setpagedevice".</p>
 322
 323 <p>The "type" is one of the following keywords:</p>
 324
 325 <ul>
 326
 327         <li><tt>curve</tt> - a real value from "minimum" to
 328         "maximum" representing a gamma correction curve using the
 329         function: f(x) = x <sup>value</sup></li>
 330
 331         <li><tt>int</tt> - an integer value from "minimum" to
 332         "maximum"</li>
 333
 334         <li><tt>invcurve</tt> - a real value from "minimum" to
 335         "maximum" representing a gamma correction curve using the
 336         function: f(x) = x <sup>1 / value</sup></li>
 337
 338         <li><tt>passcode</tt> - a string of numbers value with a
 339         minimum of "minimum" numbers and a maximum of "maximum"
 340         numbers ("minimum" and "maximum" are numbers and passcode
 341         strings are not displayed in the user interface)</li>
 342
 343         <li><tt>password</tt> - a string value with a minimum of
 344         "minimum" characters and a maximum of "maximum"
 345         characters ("minimum" and "maximum" are numbers and password
 346         strings are not displayed in the user interface)</li>
 347
 348         <li><tt>points</tt> - a measurement value in points from
 349         "minimum" to "maximum"</li>
 350
 351         <li><tt>real</tt> - a real value from "minimum" to
 352         "maximum"</li>
 353
 354         <li><tt>string</tt> - a string value with a minimum of
 355         "minimum" characters and a maximum of "maximum"
 356         characters ("minimum" and "maximum" are numbers)</li>
 357
 358 </ul>
 359
 360 <p>Examples:</p>
 361
 362 <pre class='command'>
 363 <em>*% Base JCL key code option</em>
 364 *OpenUI JCLPasscode/Key Code: PickOne
 365 *OrderDependency: 10 JCLSetup *JCLPasscode
 366 *DefaultJCLPasscode: None
 367 *JCLPasscode None/No Code: ""
 368 *JCLPasscode 1111: "@PJL SET PASSCODE = 1111&lt;0A&gt;"
 369 *JCLPasscode 2222: "@PJL SET PASSCODE = 2222&lt;0A&gt;"
 370 *JCLPasscode 3333: "@PJL SET PASSCODE = 3333&lt;0A&gt;"
 371 *JCLCloseUI: *JCLPasscode
 372
 373 <em>*% Custom JCL key code option</em>
 374 *CustomJCLPasscode True: "@PJL SET PASSCODE = \1&lt;0A&gt;"
 375 *ParamCustomJCLPasscode Code/Key Code: 1 passcode 4 4
 376
 377
 378 <em>*% Base PostScript watermark option</em>
 379 *OpenUI WatermarkText/Watermark Text: PickOne
 380 *OrderDependency: 10 AnySetup *WatermarkText
 381 *DefaultWatermarkText: None
 382 *WatermarkText None: ""
 383 *WatermarkText Draft: "&lt;&lt;/cupsString1(Draft)&gt;&gt;setpagedevice"
 384 *CloseUI: *WatermarkText
 385
 386 <em>*% Custom PostScript watermark option</em>
 387 *CustomWatermarkText True: "&lt;&lt;/cupsString1 2 1 roll&gt;&gt;setpagedevice"
 388 *ParamCustomWatermarkText Text: 1 string 0 32
 389
 390
 391 <em>*% Base PostScript gamma/density option</em>
 392 *OpenUI GammaDensity/Gamma and Density: PickOne
 393 *OrderDependency: 10 AnySetup *GammaDensity
 394 *DefaultGammaDensity: Normal
 395 *GammaDensity Normal/Normal: "&lt;&lt;/cupsReal1 1.0/cupsReal2 1.0&gt;&gt;setpagedevice"
 396 *GammaDensity Light/Lighter: "&lt;&lt;/cupsReal1 0.9/cupsReal2 0.67&gt;&gt;setpagedevice"
 397 *GammaDensity Dark/Darker: "&lt;&lt;/cupsReal1 1.1/cupsReal2 1.5&gt;&gt;setpagedevice"
 398 *CloseUI: *GammaDensity
 399
 400 <em>*% Custom PostScript gamma/density option</em>
 401 *CustomGammaDensity True: "&lt;&lt;/cupsReal1 3 1 roll/cupsReal2 3 1&gt;&gt;setpagedevice"
 402 *ParamCustomGammaDensity Gamma: 1 curve 0.1 10
 403 *ParamCustomGammaDensity Density: 2 real 0 2
 404 </pre>
 405
 406
 407 <h2 class='title'><a name='PROFILES'>Color Profiles</a></h2>
 408
 409 <p>CUPS supports two types of color profiles. The first type is
 410 based on sRGB and is used by the standard CUPS raster filters and
 411 ESP Ghostscript. The second type is based on ICC profiles and is
 412 used by the Core Graphics-based filters on MacOS X.</p>
 413
 414 <blockquote><b>Note:</b> At this time, none of the CUPS raster
 415 filters support ICC profiles. This will be addressed as time
 416 and resources permit.</blockquote>
 417
 418 <h3>cupsColorProfile</h3>
 419
 420 <p class='summary'>*cupsColorProfile Resolution/MediaType: "density
 421 gamma m00 m01 m02 m10 m11 m12 m20 m21 m22"</p>
 422
 423 <p>This string attribute specifies an sRGB-based color profile
 424 consisting of gamma and density controls and a 3x3 CMY color
 425 transform matrix.</p>
 426
 427 <p>The <i>Resolution</i> and <i>MediaType</i> values may be "-"
 428 to act as a wildcard. Otherwise they must match one of the
 429 <tt>Resolution</tt> or <tt>MediaType</tt> attributes defined in
 430 the PPD file.</p>
 431
 432 <p>The <i>density</i> and <i>gamma</i> values define gamma and
 433 density adjustment function such that:</p>
 434
 435 <pre class='command'>
 436 f(x) = density * x <sup style='font-size: 100%'>gamma</sup>
 437 </pre>
 438
 439 <p>The <i>m00</i> through <i>m22</i> values define a 3x3
 440 transformation matrix for the CMY color values. The density
 441 function is applied <i>after</i> the CMY transformation:</p>
 442
 443 <pre class='command'>
 444 | m00 m01 m02 |
 445 | m10 m11 m12 |
 446 | m20 m21 m22 |
 447 </pre>
 448
 449 <p>Examples:</p>
 450
 451 <pre class='command'>
 452 <em>*% Specify a profile for printing at 360dpi on all media types</em>
 453 *cupsColorProfile 360dpi/-: "1.0 1.5 1.0 0.0 -0.2 -0.4 1.0 0.0 -0.2 0.0 1.0"
 454
 455 <em>*% Specify a profile for printing at 720dpi on Glossy media</em>
 456 *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"
 457
 458 <em>*% Specify a default profile for printing at all other resolutions and media types</em>
 459 *cupsColorProfile -/-: "0.9 2.0 1.0 0.0 -0.2 -0.4 1.0 0.0 -0.2 0.0 1.0"
 460 </pre>
 461
 462 <h3>cupsICCProfile</h3>
 463
 464 <p class='summary'>*cupsICCProfile
 465 ColorModel.MediaType.Resolution/Description: "filename"</p>
 466
 467 <p>This attribute specifies an ICC color profile that is
 468 used to convert the document colors to the device
 469 colorspace. The <tt>ColorModel</tt>, <tt>MediaType</tt>, and
 470 <tt>Resolution</tt> keywords specify a selector for color
 471 profiles. If omitted, the color profile will match any option
 472 keyword for the corresponding main keyword.</p>
 473
 474 <p>The <tt>Description</tt> specifies human-readable text that
 475 is associated with the color profile. The <tt>filename</tt>
 476 portion specifies the ICC color profile to use; if the filename
 477 is not absolute, it is loaded relative to the
 478 <var>/usr/share/cups/profiles</var> directory.</p>
 479
 480 <p>Examples:</p>
 481
 482 <pre class='command'>
 483 <em>*% Specify a profile for CMYK printing at 360dpi on all media types</em>
 484 *cupsICCProfile CMYK..360dpi/360dpi CMYK: "vendor/foo-360-cmyk.icc"
 485
 486 <em>*% Specify a profile for RGB printing at 720dpi on Glossy media</em>
 487 *cupsColorProfile RGB.Glossy.720dpi/720dpi Glossy: "vendor/foo-720-glossy-rgb.icc"
 488
 489 <em>*% Specify a default profile for printing at all other resolutions and media types</em>
 490 *cupsICCProfile ../Default: "vendor/foo-default.icc"
 491 </pre>
 492
 493 <h4>Customizing the Profile Selection Keywords</h4>
 494
 495 <p>The <tt>MediaType</tt> and <tt>Resolution</tt> keywords can be
 496 reassigned to different main keywords, allowing drivers to do
 497 color profile selection based on different parameters. The
 498 <tt>cupsICCQualifier2</tt> and <tt>cupsICCQualifier3</tt>
 499 attributes define the mapping from selector to main keyword:</p>
 500
 501 <pre class='command'>
 502 *cupsICCQualifier2: MainKeyword2
 503 *cupsICCQualifier3: MainKeyword3
 504 </pre>
 505
 506 <p>The default mapping is as follows:</p>
 507
 508 <pre class='command'>
 509 *cupsICCQualifier2: MediaType
 510 *cupsICCQualifier3: Resolution
 511 </pre>
 512
 513
 514 <h2 class='title'><a name='I18N'>Globalized PPD Support</a></h2>
 515
 516 <p>CUPS 1.2 and higher adds support for PPD files containing multiple
 517 languages by following the following additional rules:</p>
 518
 519 <ol>
 520
 521         <li>The <tt>LanguageVersion</tt> MUST be <tt>English</tt></li>
 522
 523         <li>The <tt>LanguageEncoding</tt> MUST be <tt>ISOLatin1</tt></li>
 524
 525         <li>The <tt>cupsLanguages</tt> attribute MUST be provided and
 526         list each of the supported locales in the PPD file</li>
 527
 528         <li>Main and option keywords MUST NOT exceed 34 (instead of 40)
 529         characters to allow room for the locale prefixes in translation
 530         attributes</li>
 531
 532         <li>The main keyword "Translation" MUST NOT be used</li>
 533
 534         <li>Translation strings included with the main and option
 535         keywords MUST NOT contain characters outside the ASCII
 536         subset of ISOLatin1 and UTF-8; developers wishing to use
 537         characters outside ASCII MUST provide a separate set of
 538         English localization attributes for the affected keywords.</li>
 539
 540         <li>Localizations are specified using a locale prefix of
 541         the form "ll" or "ll_CC." where "ll" is the 2-letter ISO
 542         language code and "CC" is the 2-letter ISO country
 543         code</li>
 544
 545         <li>Locale-specific translation strings MUST be encoded
 546         using UTF-8.</li>
 547
 548         <li>Main keywords MUST be localized using one of the
 549         following forms:
 550         <p><tt>*ll.Translation MainKeyword/translation
 551         text: ""</tt><br />
 552         <tt>*ll_CC.Translation MainKeyword/translation
 553         text: ""</tt></p></li>
 554
 555         <li>Option keywords MUST be localized using one of the
 556         following forms:
 557         <p><tt>*ll.MainKeyword OptionKeyword/translation
 558         text: ""</tt><br />
 559         <tt>*ll_CC.MainKeyword OptionKeyword/translation
 560         text: ""</tt></p></li>
 561
 562         <li>Localization attributes MAY appear anywhere after the
 563         first line of the PPD file</li>
 564
 565 </ol>
 566
 567 <blockquote><b>Note:</b>
 568 We use a <tt>LanguageEncoding</tt> value of <tt>ISOLatin1</tt>
 569 and limit the allowed base translation strings to ASCII to avoid
 570 character coding issues that would otherwise occur. In addition,
 571 requiring the base translation strings to be in English allows
 572 for easier fallback translation when no localization is provided
 573 in the PPD file for a given locale.</blockquote>
 574
 575 <p>Examples:</p>
 576
 577 <pre class='command'>
 578 *LanguageVersion: English
 579 *LanguageEncoding: ISOLatin1
 580 *cupsLanguages: "de_DE fr_FR"
 581 *ModelName: "Foobar Laser 9999"
 582
 583 <em>*% Localize ModelName for French and German</em>
 584 *fr_FR.Translation ModelName/La Foobar Laser 9999: ""
 585 *de_DE.Translation ModelName/Foobar LaserDrucken 9999: ""
 586
 587 *cupsIPPReason com.vendor-error/A serious error occurred: "/help/com.vendor/error.html"
 588 <em>*% Localize printer-state-reason for French and German</em>
 589 *fr_FR.cupsIPPReason com.vendor-error/Une erreur s&egrave;rieuse s'est produite: "/help/com.vendor/error.html"
 590 *de_DE.cupsIPPReason com.vendor-error/Eine ernste St&ouml;rung trat: "/help/com.vendor/error.html"
 591
 592 ...
 593
 594 *OpenUI *InputSlot/Paper Source: PickOne
 595 *OrderDependency: 10 AnySetup *InputSlot
 596 *DefaultInputSlot: Auto
 597 <em>*% Localize InputSlot for French and German</em>
 598 *fr_FR.Translation InputSlot/Papier source: ""
 599 *de_DE.Translation InputSlot/Papiereinzug: ""
 600 *InputSlot Auto/Default: "&lt;&lt;/ManualFeed false&gt;&gt;setpagedevice"
 601 <em>*% Localize InputSlot=Auto for French and German</em>
 602 *fr_FR.InputSlot Auto/Par Defaut: ""
 603 *de_DE.InputSlot Auto/Standard: ""
 604 *InputSlot Manual/Manual Feed: "&lt;&lt;/ManualFeed true&gt;&gt;setpagedevice"
 605 <em>*% Localize InputSlot=Manual for French and German</em>
 606 *fr_FR.InputSlot Manual/Manuel mecanisme de alimentation: ""
 607 *de_DE.InputSlot Manual/Manueller Einzug: ""
 608 *CloseUI: *InputSlot
 609 </pre>
 610
 611
 612 <h2 class='title'><a name='HISTORY'>Change History</a></h2>
 613
 614 <h3>Changes in CUPS 1.2</h3>
 615
 616 <ul>
 617
 618         <li>Added globalization support attributes</li>
 619
 620         <li>Added custom option values support</li>
 621
 622         <li>Added <tt>APBookFile</tt> attribute</li>
 623
 624         <li>Added <tt>APDuplexRequiresFlippedMargin</tt> attribute</li>
 625
 626         <li>Added <tt>cupsICCProfile</tt> attribute</li>
 627
 628         <li>Added <tt>cupsIPPReason</tt> attribute</li>
 629
 630         <li>Added <tt>cupsLanguages</tt> attribute</li>
 631
 632         <li>Added <tt>cupsPortMonitor</tt> attribute</li>
 633
 634         <li>Removed <tt>cupsProtocol</tt> attribute</li>
 635
 636 </ul>
 637
 638 <h3>Changes in CUPS 1.1</h3>
 639
 640 <ul>
 641
 642         <li>Added <tt>cupsFlipDuplex</tt> attribute</li>
 643
 644         <li>Added <tt>cupsProtocol</tt> attribute</li>
 645
 646 </ul>
 647
 648 </body>
 649 </html>