1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
3 <!-- SECTION: Programming -->
5 <title>Developing PostScript Printer Drivers
</title>
6 <meta name=
"keywords" content=
"Programming">
7 <meta name=
"creator" content=
"Mini-XML v2.6">
8 <style type=
"text/css"><!--
10 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
13 H1, H2, H3, H4, H5, H6, P, TD, TH {
14 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
18 font-family: monaco, courier, monospace;
23 font-family: monaco, courier, monospace;
37 border: dotted thin #999999;
42 PRE.command EM, PRE.example EM {
43 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
47 font-family: monaco, courier, monospace;
58 border: solid thin #999999;
69 -moz-border-radius: 10px;
74 text-decoration: none;
77 A:link:hover, A:visited:hover, A:active {
78 text-decoration: underline;
85 TR.data, TD.data, TR.data TD {
88 border-bottom: solid 1pt #999999;
92 border-bottom: solid 1pt #999999;
99 border: solid thin #999999;
100 border-collapse: collapse;
116 border: solid thin #cccccc;
123 border-bottom: solid thin #999999;
132 caption-side: bottom;
156 border: thin solid black;
164 H2 SPAN.info, H3 SPAN.info, H4 SPAN.info {
170 border-bottom: solid 2pt #000000;
173 DIV.indent, TABLE.indent {
181 border-collapse: collapse;
184 TABLE.indent TD, TABLE.indent TH {
189 border-collapse: collapse;
197 border-bottom: solid thin #cccccc;
202 vertical-align: bottom;
211 border-bottom: solid thin #eeeeee;
216 TABLE.list TR:nth-child(even) {
220 TABLE.list TR:nth-child(odd) {
239 font-family: monaco, courier, monospace;
243 border: solid thin #999999;
244 border-collapse: collapse;
249 DIV.summary TABLE TD, DIV.summary TABLE TH {
250 border: solid thin #999999;
256 DIV.summary TABLE THEAD TH {
260 /* API documentation styles... */
267 div.body h3, div.body h4, div.body h5 {
268 margin-bottom: 0.5em;
271 .class, .enumeration, .function, .struct, .typedef, .union {
272 border-bottom: solid thin #999999;
279 code, p.code, pre, ul.code li {
280 font-family: monaco, courier, monospace;
283 ul.code, ul.contents, ul.subcontents {
284 list-style-type: none;
294 ul.contents li ul.code, ul.contents li ul.subcontents {
307 margin-bottom: 0.5em;
310 /* This is just for the HTML files generated with the framedhelp target */
313 border: solid thin black;
322 div.contents ul.contents {
325 div.contents ul.subcontents li {
333 <p>This document describes how to develop printer drivers for PostScript printers. Topics include:
<a href='#BASICS'
>printer driver basics
</a>,
<a href='#CREATE'
>creating new PPD files
</a>,
<a href='#IMPORT'
>importing existing PPD files
</a>,
<a href='#FILTERS'
>using custom filters
</a>,
<a href='#COLOR'
>implementing color management
</a>,
<a href='#MACOSX'
>adding Mac OS X features
</a>, and
<a href='#DEPLOY'
>deploying your driver
</a>.
</p>
335 <div class='summary'
><table summary='General Information'
>
339 <td>Programming:
<a href='raster-driver.html'
>Developing Raster Printer Drivers
</a><br>
340 Programming:
<a href='api-filter.html'
>Filter and Backend Programming
</a><br>
341 Programming:
<a href='ppd-compiler.html'
>Introduction to the PPD Compiler
</a><br>
342 Programming:
<a href='api-raster.html'
>Raster API
</a><br>
343 References:
<a href='ref-ppdcfile.html'
>PPD Compiler Driver Information File Reference
</a><br>
344 Specifications:
<a href='spec-ppd.html'
>CUPS PPD Extensions
</a></td>
348 <h2 class=
"title">Contents
</h2>
349 <ul class=
"contents">
350 <ul class=
"subcontents">
351 <li><a href=
"#BASICS">Printer Driver Basics
</a></li>
352 <li><a href=
"#CREATING">Creating New PPD Files
</a><ul class=
"subcontents">
353 <li><a href=
"#IMPORT">Importing Existing PPD Files
</a></li>
355 <li><a href=
"#FILTERS">Using Custom Filters
</a></li>
356 <li><a href=
"#COLOR">Implementing Color Management
</a></li>
357 <li><a href=
"#MACOSX">Adding Mac OS X Features
</a></li>
358 <li><a href=
"#DEPLOY">Deploying Your Driver
</a></li>
359 <h2 class='title'
><a name='BASICS'
>Printer Driver Basics
</a></h2>
361 <p>A CUPS PostScript printer driver consists of a PostScript Printer Description (PPD) file that describes the features and capabilities of the device, zero or more
<em>filter
</em> programs that prepare print data for the device, and zero or more support files for color management, online help, and so forth. The PPD file includes references to all of the filters and support files used by the driver.
</p>
363 <p>Every time a user prints something the scheduler program,
<a href='man-cupsd.html'
>cupsd(
8)
</a>, determines the format of the print job and the programs required to convert that job into something the printer understands. CUPS includes filter programs for many common formats, for example to convert Portable Document Format (PDF) files into device-independent PostScript, and then from device-independent PostScript to device-dependent PostScript.
<a href='#FIGURE_1'
>Figure
1</a> shows the data flow of a typical print job.
</p>
365 <div class='figure'
><table summary='PostScript Filter Chain'
>
366 <caption>Figure
1:
<a name='FIGURE_1'
>PostScript Filter Chain
</a></caption>
367 <tr><td><img src='/images/cups-postscript-chain.png' width='
700' height='
150' alt='PostScript Filter Chain'
></td></tr>
370 <p>The optional PostScript filter can be provided to add printer-specific commands to the PostScript output that cannot be represented in the PPD file or to reorganize the output for special printer features. Typically this is used to support advanced job management or finishing functions on the printer. CUPS includes a generic PostScript filter that handles all PPD-defined commands.
</p>
372 <p>The optional port monitor handles interface-specific protocol or encoding issues. For example, many PostScript printers support the Binary Communications Protocol (BCP) and Tagged Binary Communications Protocol (TBCP) to allow applications to print
8-bit (
"binary") PostScript jobs. CUPS includes port monitors for BCP and TBCP, and you can supply your own port monitors as needed.
</p>
374 <p>The backend handles communications with the printer, sending print data from the last filter to the printer and relaying back-channel data from the printer to the upstream filters. CUPS includes backend programs for common direct-connect interfaces and network protocols, and you can provide your own backend to support custom interfaces and protocols.
</p>
376 <p>The scheduler also supports a special
"command" file format for sending maintenance commands and status queries to a printer or printer driver. Command print jobs typically use a single command filter program defined in the PPD file to generate the appropriate printer commands and handle any responses from the printer.
<a href='#FIGURE_2'
>Figure
2</a> shows the data flow of a typical command job.
</p>
378 <div class='figure'
><table summary='Command Filter Chain'
>
379 <caption>Figure
2:
<a name='FIGURE_2'
>Command Filter Chain
</a></caption>
380 <tr><td><img src='/images/cups-command-chain.png' width='
575' height='
150' alt='Command Filter Chain'
></td></tr>
383 <p>PostScript printer drivers typically do not require their own command filter since CUPS includes a generic PostScript command filter that supports all of the standard functions using PPD-defined commands.
</p>
386 <h2 class='title'
><a name='CREATING'
>Creating New PPD Files
</a></h2>
388 <p>We recommend using the CUPS PPD compiler,
<a href='man-ppdc.html'
>ppdc(
1)
</a>, to create new PPD files since it manages many of the tedious (and error-prone!) details of paper sizes and localization for you. It also allows you to easily support multiple devices from a single source file. For more information see the
"<a href='ppd-compiler.html'>Introduction to the PPD Compiler</a>" document.
<a href='#LISTING_1'
>Listing
1</a> shows a driver information file for a black-and-white PostScript printer.
</p>
390 <p class='example'
>Listing
1:
<a name='LISTING_1'
>"examples/postscript.drv"</a></p>
392 <pre class='example'
>
393 // Include standard font and media definitions
394 <a href='ref-ppdcfile.html#_include'
>#include
</a> <font.defs
>
395 <a href='ref-ppdcfile.html#_include'
>#include
</a> <media.defs
>
397 // Specify this is a PostScript printer driver
398 <a href='ref-ppdcfile.html#DriverType'
>DriverType
</a> ps
400 // List the fonts that are supported, in this case all standard fonts
401 <a href='ref-ppdcfile.html#Font'
>Font
</a> *
403 // Manufacturer, model name, and version
404 <a href='ref-ppdcfile.html#Manufacturer'
>Manufacturer
</a> "Foo"
405 <a href='ref-ppdcfile.html#ModelName'
>ModelName
</a> "Foo LaserProofer 2000"
406 <a href='ref-ppdcfile.html#Version'
>Version
</a> 1.0
408 // PostScript printer attributes
409 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> DefaultColorSpace
"" Gray
410 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> LandscapeOrientation
"" Minus90
411 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> LanguageLevel
"" "3"
412 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> Product
"" "(Foo LaserProofer 2000)"
413 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> PSVersion
"" "(3010) 0"
414 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> TTRasterizer
"" Type42
416 // Supported page sizes
417 *
<a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Letter
418 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Legal
419 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> A4
421 // Query command for page size
422 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> "?PageSize" "" "
424 currentpagedevice /PageSize get aload pop
425 2 copy gt {exch} if (Unknown)
427 dup [612 792] (Letter) put
428 dup [612 1008] (Legal) put
429 dup [595 842] (A4) put
430 {exch aload pop 4 index sub abs 5 le exch
431 5 index sub abs 5 le and
432 {exch pop exit} {pop} ifelse
433 } bind forall = flush pop pop
436 // Specify the name of the PPD file we want to generate
437 <a href='ref-ppdcfile.html#PCFileName'
>PCFileName
</a> "fooproof.ppd"
440 <h3>Required Attributes
</h3>
442 <p>PostScript drivers require the attributes listed in
<a href='#TABLE_1'
>Table
1</a>. If not specified, the defaults for CUPS drivers are used. A typical PostScript driver information file would include the following attributes:
</p>
444 <pre class='example'
>
445 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> DefaultColorSpace
"" Gray
446 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> LandscapeOrientation
"" Minus90
447 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> LanguageLevel
"" "3"
448 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> Product
"" "(Foo LaserProofer 2000)"
449 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> PSVersion
"" "(3010) 0"
450 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> TTRasterizer
"" Type42
453 <div class='table'
><table summary='Required PostScript Printer Driver Attributes'
>
454 <caption>Table
1:
<a name='TABLE_1'
>Required PostScript Printer Driver Attributes
</a></caption>
463 <td><tt>DefaultColorSpace
</tt></td>
464 <td>The default colorspace:
465 <tt>Gray
</tt>,
<tt>RGB
</tt>,
<tt>CMY
</tt>, or
466 <tt>CMYK
</tt>. If not specified, then
<tt>RGB
</tt> is
470 <td><tt>LandscapeOrientation
</tt></td>
471 <td>The preferred landscape
472 orientation:
<tt>Plus90
</tt>,
<tt>Minus90
</tt>, or
473 <tt>Any
</tt>. If not specified,
<tt>Plus90
</tt> is
477 <td><tt>LanguageLevel
</tt></td>
478 <td>The PostScript language
479 level supported by the device:
1,
2, or
3. If not
480 specified,
2 is assumed.
</td>
483 <td><tt>Product
</tt></td>
484 <td>The string returned by
485 the PostScript
<tt>product
</tt> operator, which
486 <i>must
</i> include parenthesis to conform with
487 PostScript syntax rules for strings. Multiple
488 <tt>Product
</tt> attributes may be specified to support
489 multiple products with the same PPD file. If not
490 specified,
"(ESP Ghostscript)" and
"(GNU Ghostscript)"
494 <td><tt>PSVersion
</tt></td>
496 interpreter version numbers as returned by the
497 <tt>version
</tt> and
<tt>revision
</tt> operators. The
498 required format is
"(version) revision". Multiple
499 <tt>PSVersion
</tt> attributes may be specified to
500 support multiple interpreter version numbers. If not
501 specified,
"(3010) 705" and
"(3010) 707" are
505 <td><tt>TTRasterizer
</tt></td>
506 <td>The type of TrueType
507 font rasterizer supported by the device, if any. The
508 supported values are
<tt>None
</tt>,
<tt>Accept68k
</tt>,
509 <tt>Type42
</tt>, and
<tt>TrueImage
</tt>. If not
510 specified,
<tt>None
</tt> is assumed.
</td>
514 <h3>Query Commands
</h3>
516 <p>Most PostScript printer PPD files include query commands (
<tt>?PageSize
</tt>, etc.) that allow applications to query the printer for its current settings and configuration. Query commands are included in driver information files as attributes. For example, the example in
<a href='#LISTING_1'
>Listing
1</a> uses the following definition for the
<tt>PageSize
</tt> query command:
</p>
518 <pre class='example'
>
519 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> "?PageSize" "" "
521 currentpagedevice /PageSize get aload pop
522 2 copy gt {exch} if (Unknown)
524 dup [612 792] (Letter) put
525 dup [612 1008] (Legal) put
526 dup [595 842] (A4) put
527 {exch aload pop 4 index sub abs 5 le exch
528 5 index sub abs 5 le and
529 {exch pop exit} {pop} ifelse
530 } bind forall = flush pop pop
534 <p>Query commands can span multiple lines, however no single line may contain more than
255 characters.
</p>
536 <h3><a name='IMPORT'
>Importing Existing PPD Files
</a></h3>
538 <P>CUPS includes a utility called
<a href='man-ppdi.html'
>ppdi(
1)
</a>
539 which allows you to import existing PPD files into the driver information file
540 format used by the PPD compiler
<a href='man-ppdc.html'
>ppdc(
1)
</a>. Once
541 imported, you can modify, localize, and regenerate the PPD files easily. Type
542 the following command to import the PPD file
<VAR>mydevice.ppd
</VAR> into the
543 driver information file
<VAR>mydevice.drv
</VAR>:
</P>
545 <pre class='command'
>
546 ppdi -o mydevice.drv mydevice.ppd
549 <P>If you have a whole directory of PPD files that you would like to import,
550 you can list multiple filenames or use shell wildcards to import more than one
551 PPD file on the command-line:
</P>
553 <pre class='command'
>
554 ppdi -o mydevice.drv mydevice1.ppd mydevice2.ppd
555 ppdi -o mydevice.drv *.ppd
558 <P>If the driver information file already exists, the new PPD
559 file entries are appended to the end of the file. Each PPD file
560 is placed in its own group of curly braces within the driver
561 information file.
</P>
564 <h2 class='title'
><a name='FILTERS'
>Using Custom Filters
</a></h2>
566 <p>Normally a PostScript printer driver will not utilize any additional print filters. For drivers that provide additional filters such as a CUPS command file filter for doing printer maintenance, you must also list the following
<tt>Filter
</tt> directive to handle printing PostScript files:
</p>
568 <pre class='example'
>
569 <a href='ref-ppdcfile.html#Filter'
>Filter
</a> application/vnd.cups-postscript
0 -
572 <h3>Custom Command Filters
</h3>
574 <p>The
<tt>application/vnd.cups-command
</tt> file type is used for CUPS command files. Use the following
<tt>Filter
</tt> directive to handle CUPS command files:
</p>
576 <pre class='example'
>
577 <a href='ref-ppdcfile.html#Filter'
>Filter
</a> application/vnd.cups-command
100 /path/to/command/filter
580 <p>To use the standard PostScript command filter, specify
<var>commandtops
</var> as the path to the command filter.
</p>
582 <h3>Custom PDF Filters
</h3>
584 <p>The
<tt>application/pdf
</tt> file type is used for unfiltered PDF files while the
<tt>application/vnd.cups-pdf
</tt> file type is used for filtered PDF files. Use the following
<tt>Filter
</tt> directive to handle filtered PDF files:
</p>
586 <pre class='example'
>
587 <a href='ref-ppdcfile.html#Filter'
>Filter
</a> application/vnd.cups-pdf
100 /path/to/pdf/filter
590 <p>For unfiltered PDF files, use:
</p>
592 <pre class='example'
>
593 <a href='ref-ppdcfile.html#Filter'
>Filter
</a> application/pdf
100 /path/to/pdf/filter
596 <p>Custom PDF filters that accept filtered data do not need to perform number-up processing and other types of page imposition, while those that accept unfiltered data MUST do the number-up processing themselves.
</p>
598 <h3>Custom PostScript Filters
</h3>
600 <p>The
<tt>application/vnd.cups-postscript
</tt> file type is used for filtered PostScript files. Use the following
<tt>Filter
</tt> directive to handle PostScript files:
</p>
602 <pre class='example'
>
603 <a href='ref-ppdcfile.html#Filter'
>Filter
</a> application/vnd.cups-postscript
100 /path/to/postscript/filter
607 <h2 class='title'
><a name='COLOR'
>Implementing Color Management
</a></h2>
609 <p>Talk about ICC color profiles and sRGB as two best options.
</p>
612 <h2 class='title'
><a name='MACOSX'
>Adding Mac OS X Features
</a></h2>
614 <p>Talk about help books, icons, and PDEs.
</p>
617 <h2 class='title'
><a name='DEPLOY'
>Deploying Your Driver
</a></h2>
619 <p>Talk about install locations, etc.
</p>