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 Raster 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;
41 border: dotted thin #999999;
46 PRE.command EM, PRE.example EM {
47 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
51 font-family: monaco, courier, monospace;
62 border: solid thin #999999;
73 -moz-border-radius: 10px;
78 text-decoration: none;
81 A:link:hover, A:visited:hover, A:active {
82 text-decoration: underline;
89 TR.data, TD.data, TR.data TD {
92 border-bottom: solid 1pt #999999;
96 border-bottom: solid 1pt #999999;
103 border: solid thin #999999;
104 border-collapse: collapse;
120 border: solid thin #cccccc;
127 border-bottom: solid thin #999999;
136 caption-side: bottom;
160 border: thin solid black;
168 H2 SPAN.info, H3 SPAN.info, H4 SPAN.info {
177 border-bottom: solid 2pt #000000;
180 DIV.indent, TABLE.indent {
188 border-collapse: collapse;
191 TABLE.indent TD, TABLE.indent TH {
196 border-collapse: collapse;
204 border-bottom: solid thin #cccccc;
209 vertical-align: bottom;
218 border-bottom: solid thin #eeeeee;
223 TABLE.list TR:nth-child(even) {
227 TABLE.list TR:nth-child(odd) {
246 font-family: monaco, courier, monospace;
250 border: solid thin #999999;
251 border-collapse: collapse;
256 DIV.summary TABLE TD, DIV.summary TABLE TH {
257 border: solid thin #999999;
263 DIV.summary TABLE THEAD TH {
267 /* API documentation styles... */
274 div.body h3, div.body h4, div.body h5 {
275 margin-bottom: 0.5em;
278 .class, .enumeration, .function, .struct, .typedef, .union {
279 border-bottom: solid thin #999999;
286 code, p.code, pre, ul.code li {
287 font-family: monaco, courier, monospace;
290 ul.code, ul.contents, ul.subcontents {
291 list-style-type: none;
301 ul.contents li ul.code, ul.contents li ul.subcontents {
314 margin-bottom: 0.5em;
317 /* This is just for the HTML files generated with the framedhelp target */
320 border: solid thin black;
329 div.contents ul.contents {
332 div.contents ul.subcontents li {
340 <h1 class='title'
>Developing Raster Printer Drivers
</h1>
342 <p>This document describes how to develop printer drivers for raster printers. Topics include:
<a href='#BASICS'
>printer driver basics
</a>,
<a href='#CREATE'
>creating new PPD files
</a>,
<a href='#FILTERS'
>using filters
</a>,
<a href='#COLOR'
>implementing color management
</a>, and
<a href='#MACOSX'
>adding Mac OS X features
</a>.
</p>
344 <div class='summary'
><table summary='General Information'
>
348 <td>Programming:
<a href='postscript-driver.html'
>Developing PostScript Printer Drivers
</a><br>
349 Programming:
<a href='api-filter.html'
>Filter and Backend Programming
</a><br>
350 Programming:
<a href='ppd-compiler.html'
>Introduction to the PPD Compiler
</a><br>
351 Programming:
<a href='api-raster.html'
>Raster API
</a><br>
352 References:
<a href='ref-ppdcfile.html'
>PPD Compiler Driver Information File Reference
</a><br>
353 Specifications:
<a href='spec-ppd.html'
>CUPS PPD Extensions
</a></td>
357 <h2 class=
"title">Contents
</h2>
358 <ul class=
"contents">
359 <ul class=
"subcontents">
360 <li><a href=
"#BASICS">Printer Driver Basics
</a></li>
361 <li><a href=
"#CREATING">Creating New PPD Files
</a></li>
362 <li><a href=
"#FILTERS">Using Filters
</a></li>
363 <li><a href=
"#COLOR">Implementing Color Management
</a></li>
364 <li><a href=
"#MACOSX">Adding Mac OS X Features
</a></li>
365 <h2 class='title'
><a name='BASICS'
>Printer Driver Basics
</a></h2>
367 <p>A CUPS raster printer driver consists of a PostScript Printer Description (PPD) file that describes the features and capabilities of the device, one 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>
369 <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 CUPS raster data.
<a href='#FIGURE_1'
>Figure
1</a> shows the data flow of a typical print job.
</p>
371 <div class='figure'
><table summary='Raster Filter Chain'
>
372 <caption>Figure
1:
<a name='FIGURE_1'
>Raster Filter Chain
</a></caption>
373 <tr><td><img src='/images/cups-raster-chain.png' width='
700' height='
150' alt='Raster Filter Chain'
></td></tr>
376 <p>The raster filter converts CUPS raster data into a format the printer understands, for example HP-PCL. CUPS includes several sample raster filters supporting standard page description languages (PDLs).
<a href='#TABLE_1'
>Table
1</a> shows the raster filters that are bundled with CUPS and the languages they support.
</p>
378 <div class='table'
><table summary='Standard CUPS Raster Filters'
>
379 <caption>Table
1:
<a name='TABLE_1'
>Standard CUPS Raster Filters
</a></caption>
381 <tr><th>Filter
</th><th>PDLs
</th><th>ppdc DriverType
</th><th>ppdc #include file
</th></tr>
384 <tr><td>rastertoepson
</td><td>ESC/P, ESC/P2
</td><td>epson
</td><td>epson.h
</td></tr>
385 <tr><td>rastertoescpx
</td><td>ESC/P, ESC/P2, EPSON Remote Mode
</td><td>escp
</td><td>escp.h
</td></tr>
386 <tr><td>rastertohp
</td><td>HP-PCL3, HP-PCL5
</td><td>hp
</td><td>hp.h
</td></tr>
387 <tr><td>rastertolabel
</td><td>CPCL, Dymo, EPL1, EPL2, Intellitech PCL, ZPL
</td><td>label
</td><td>label.h
</td></tr>
388 <tr><td>rastertopclx
</td><td>HP-RTL, HP-PCL3, HP-PCL3GUI, HP-PCL5, HP-PCL5c, HP-PCL5e
</td><td>pcl
</td><td>pcl.h
</td></tr>
392 <p>The optional port monitor handles interface-specific protocol or encoding issues. For example, some raster printers use the
1284.4 communications protocol.
</p>
394 <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>
396 <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>
398 <div class='figure'
><table summary='Command Filter Chain'
>
399 <caption>Figure
2:
<a name='FIGURE_2'
>Command Filter Chain
</a></caption>
400 <tr><td><img src='/images/cups-command-chain.png' width='
575' height='
150' alt='Command Filter Chain'
></td></tr>
403 <p>Raster printer drivers must provide their own command filter.
</p>
406 <h2 class='title'
><a name='CREATING'
>Creating New PPD Files
</a></h2>
408 <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 several similar black-and-white HP-PCL5 laser printers.
</p>
410 <p class='example'
>Listing
1:
<a name='LISTING_1'
>"examples/laserjet-basic.drv"</a></p>
412 <pre class='example'
>
413 <I>// Include standard font and media definitions
</I>
414 <a href='ref-ppdcfile.html#_include'
>#include
</a> <font.defs
>
415 <a href='ref-ppdcfile.html#_include'
>#include
</a> <media.defs
>
417 <I>// Include HP-PCL driver definitions
</I>
418 <a href='ref-ppdcfile.html#_include'
>#include
</a> <pcl.h
>
420 <I>// Specify that this driver uses the HP-PCL driver...
</I>
421 <a href='ref-ppdcfile.html#DriverType'
>DriverType
</a> pcl
423 <I>// Specify the driver options via the model number...
</I>
424 <a href='ref-ppdcfile.html#ModelNumber'
>ModelNumber
</a> ($PCL_PAPER_SIZE $PCL_PJL $PCL_PJL_RESOLUTION)
426 <I>// List the fonts that are supported, in this case all standard fonts...
</I>
427 <a href='ref-ppdcfile.html#Font'
>Font
</a> *
429 <I>// Manufacturer and driver version
</I>
430 <a href='ref-ppdcfile.html#Manufacturer'
>Manufacturer
</a> "HP"
431 <a href='ref-ppdcfile.html#Version'
>Version
</a> 1.0
433 <I>// Supported page sizes and their margins
</I>
434 <a href='ref-ppdcfile.html#HWMargins'
>HWMargins
</a> 18 12 18 12
435 *
<a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Letter
436 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Legal
437 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Executive
438 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Monarch
439 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Statement
440 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> FanFoldGermanLegal
442 <a href='ref-ppdcfile.html#HWMargins'
>HWMargins
</a> 18 12.72 18 12.72
443 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Env10
445 <a href='ref-ppdcfile.html#HWMargins'
>HWMargins
</a> 9.72 12 9.72 12
446 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> A4
447 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> A5
448 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> B5
449 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> EnvC5
450 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> EnvDL
451 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> EnvISOB5
452 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Postcard
453 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> DoublePostcard
455 <I>// Only black-and-white output with mode
3 compression...
</I>
456 <a href='ref-ppdcfile.html#ColorModel'
>ColorModel
</a> Gray k chunky
3
458 <I>// Supported resolutions
</I>
459 <a href='ref-ppdcfile.html#Resolution'
>Resolution
</a> -
1 0 0 0 "300dpi/300 DPI"
460 *
<a href='ref-ppdcfile.html#Resolution'
>Resolution
</a> -
8 0 0 0 "600dpi/600 DPI"
462 <I>// Supported input slots
</I>
463 *
<a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 7 "Auto/Automatic Selection"
464 <a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 2 "Manual/Tray 1 - Manual Feed"
465 <a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 4 "Upper/Tray 1"
466 <a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 1 "Lower/Tray 2"
467 <a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 5 "LargeCapacity/Tray 3"
469 <I>// Tray
3 is an option...
</I>
470 <a href='ref-ppdcfile.html#Installable'
>Installable
</a> "OptionLargeCapacity/Tray 3 Installed"
471 <a href='ref-ppdcfile.html#UIConstraints'
>UIConstraints
</a> "*OptionLargeCapacity False *InputSlot LargeCapacity"
474 <I>// HP LaserJet
2100 Series
</I>
475 <a href='ref-ppdcfile.html#Throughput'
>Throughput
</a> 10
476 <a href='ref-ppdcfile.html#ModelName'
>ModelName
</a> "LaserJet 2100 Series"
477 <a href='ref-ppdcfile.html#PCFileName'
>PCFileName
</a> "hpljt211.ppd"
481 <I>// LaserJet
2200 and
2300 series have duplexer option...
</I>
482 <a href='ref-ppdcfile.html#Duplex'
>Duplex
</a> normal
483 <a href='ref-ppdcfile.html#Installable'
>Installable
</a> "OptionDuplex/Duplexer Installed"
484 <a href='ref-ppdcfile.html#UIConstraints'
>UIConstraints
</a> "*OptionDuplex False *Duplex"
487 <I>// HP LaserJet
2200 Series
</I>
488 <a href='ref-ppdcfile.html#Throughput'
>Throughput
</a> 19
489 <a href='ref-ppdcfile.html#ModelName'
>ModelName
</a> "LaserJet 2200 Series"
490 <a href='ref-ppdcfile.html#PCFileName'
>PCFileName
</a> "hpljt221.ppd"
494 <I>// HP LaserJet
2300 Series
</I>
495 <a href='ref-ppdcfile.html#Throughput'
>Throughput
</a> 25
496 <a href='ref-ppdcfile.html#ModelName'
>ModelName
</a> "LaserJet 2300 Series"
497 <a href='ref-ppdcfile.html#PCFileName'
>PCFileName
</a> "hpljt231.ppd"
503 <h2 class='title'
><a name='FILTERS'
>Using Filters
</a></h2>
505 <p>The standard CUPS raster filters can be specified using the
506 <a href='ref-ppdcfile.html#DriverType'
><tt>DriverType
</tt></a> directive, for example:
</p>
508 <pre class='example'
>
509 <I>// Specify that this driver uses the HP-PCL driver...
</I>
510 <a href='ref-ppdcfile.html#DriverType'
>DriverType
</a> pcl
513 <p><a href='#TABLE_1'
>Table
1</a> shows the driver types for each of the standard CUPS raster filters. For drivers that do not use the standard raster filters, the
"custom" type is used with
<a href='ref-ppdcfile.html#Filter'
><tt>Filter
</tt></a> directives:
</p>
515 <pre class='example'
>
516 <a href='ref-ppdcfile.html#DriverType'
>DriverType
</a> custom
517 <a href='ref-ppdcfile.html#Filter'
>Filter
</a> application/vnd.cups-raster
100 /path/to/raster/filter
518 <a href='ref-ppdcfile.html#Filter'
>Filter
</a> application/vnd.cups-command
100 /path/to/command/filter
522 <h2 class='title'
><a name='COLOR'
>Implementing Color Management
</a></h2>
524 <p>CUPS uses ICC color profiles to provide more accurate color reproduction. The
<a href='spec-ppd.html#cupsICCProfile'
><tt>cupsICCProfile
</tt></a> attribute defines the color profiles that are available for a given printer, for example:
</p>
526 <pre class='example'
>
527 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> cupsICCProfile
"ColorModel.MediaType.Resolution/Description" /path/to/ICC/profile
530 <p>where
"ColorModel.MediaType.Resolution" defines a selector based on the corresponding option selections. A simple driver might only define profiles for the color models that are supported, for example a printer supporting Gray and RGB might use:
</p>
532 <pre class='example'
>
533 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> cupsICCProfile
"Gray../Grayscale Profile" /path/to/ICC/gray-profile
534 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> cupsICCProfile
"RGB../Full Color Profile" /path/to/ICC/rgb-profile
537 <p>The options used for profile selection can be customized using the
<tt>cupsICCQualifier2
</tt> and
<tt>cupsICCQualifier3
</tt> attributes.
</p>
539 <h3><span class='info'
>Since Mac OS X
10.5</span>Custom Color Matching Support
</h3>
541 <p>Mac OS X printer drivers that are based on an existing standard RGB colorspace can tell the system to use the corresponding colorspace instead of an arbitrary ICC color profile when doing color management. The
<a href='#APCustom'
><tt>APSupportsCustomColorMatching
</tt></a> and
<tt>APDefaultCustomColorMatchingProfile
</tt> attributes can be used to enable this mode:
</p>
543 <pre class='example'
>
544 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APSupportsCustomColorMatching
"" true
545 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APDefaultCustomColorMatchingProfile
"" sRGB
549 <h2 class='title'
><a name='MACOSX'
>Adding Mac OS X Features
</a></h2>
551 <p>Mac OS X printer drivers can provide
<a href='spec-ppd.html#MACOSX'
>additional attributes
</a> to specify additional option panes in the print dialog, an image of the printer, a help book, and option presets for the driver software:
</p>
553 <pre class='example'
>
554 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APDialogExtension
"" /Library/Printers/Vendor/filename.plugin
555 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APHelpBook
"" /Library/Printers/Vendor/filename.bundle
556 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APPrinterIconPath
"" /Library/Printers/Vendor/filename.icns
557 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APPrinterPreset
"name/text" "*option choice ..."