3 <!-- SECTION: Programming -->
5 <title>Developing Raster Printer Drivers
</title>
6 <meta name=
"keywords" content=
"Programming">
7 <meta http-equiv=
"Content-Type" content=
"text/html;charset=utf-8">
8 <meta name=
"creator" content=
"Mini-XML v2.11">
9 <meta name=
"author" content=
"Unknown">
10 <meta name=
"copyright" content=
"Unknown">
11 <meta name=
"version" content=
"0.0">
12 <style type=
"text/css"><!--
14 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
17 H1, H2, H3, H4, H5, H6, P, TD, TH {
18 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
22 font-family: monaco, courier, monospace;
27 font-family: monaco, courier, monospace;
31 border: dotted thin #7f7f7f;
59 border: dotted thin #999999;
64 PRE.command EM, PRE.example EM {
65 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
69 font-family: monaco, courier, monospace;
80 border: solid thin #999999;
91 -moz-border-radius: 10px;
96 text-decoration: none;
99 A:link:hover, A:visited:hover, A:active {
100 text-decoration: underline;
107 TR.data, TD.data, TR.data TD {
110 border-bottom: solid 1pt #999999;
114 border-bottom: solid 1pt #999999;
121 border: solid thin #999999;
122 border-collapse: collapse;
138 border: solid thin #cccccc;
145 border-bottom: solid thin #999999;
154 caption-side: bottom;
178 border: thin solid black;
186 H2 SPAN.info, H3 SPAN.info, H4 SPAN.info {
195 border-bottom: solid 2pt #000000;
198 DIV.indent, TABLE.indent {
206 border-collapse: collapse;
209 TABLE.indent TD, TABLE.indent TH {
214 border-collapse: collapse;
222 border-bottom: solid thin #cccccc;
227 vertical-align: bottom;
236 border-bottom: solid thin #eeeeee;
241 TABLE.list TR:nth-child(even) {
245 TABLE.list TR:nth-child(odd) {
264 font-family: monaco, courier, monospace;
268 border: solid thin #999999;
269 border-collapse: collapse;
274 DIV.summary TABLE TD, DIV.summary TABLE TH {
275 border: solid thin #999999;
281 DIV.summary TABLE THEAD TH {
285 /* API documentation styles... */
292 div.body h3, div.body h4, div.body h5 {
293 margin-bottom: 0.5em;
296 .class, .enumeration, .function, .struct, .typedef, .union {
297 border-bottom: solid thin #999999;
304 code, p.code, pre, ul.code li {
305 font-family: monaco, courier, monospace;
308 ul.code, ul.contents, ul.subcontents {
309 list-style-type: none;
319 ul.contents li ul.code, ul.contents li ul.subcontents {
332 margin-bottom: 0.5em;
335 /* This is just for the HTML files generated with the framedhelp target */
338 border: solid thin black;
347 div.contents ul.contents {
350 div.contents ul.subcontents li {
358 Raster printer driver documentation for CUPS.
360 Copyright 2007-2012 by Apple Inc.
361 Copyright 1997-2007 by Easy Software Products.
363 These coded instructions, statements, and computer programs are the
364 property of Apple Inc. and are protected by Federal copyright
365 law. Distribution and use rights are outlined in the file "LICENSE.txt"
366 which should have been included with this file. If this file is
367 file is missing or damaged, see the license at "http://www.cups.org/".
370 <h1 class='title'
>Developing Raster Printer Drivers
</h1>
372 <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 macOS features
</a>.
</p>
374 <div class='summary'
><table summary='General Information'
>
378 <td>Programming:
<a href='postscript-driver.html'
>Developing PostScript Printer Drivers
</a><br>
379 Programming:
<a href='api-filter.html'
>Filter and Backend Programming
</a><br>
380 Programming:
<a href='ppd-compiler.html'
>Introduction to the PPD Compiler
</a><br>
381 Programming:
<a href='api-raster.html'
>Raster API
</a><br>
382 References:
<a href='ref-ppdcfile.html'
>PPD Compiler Driver Information File Reference
</a><br>
383 Specifications:
<a href='spec-ppd.html'
>CUPS PPD Extensions
</a></td>
387 <div class=
"contents">
388 <h2 class=
"title">Contents
</h2>
389 <ul class=
"contents">
390 <li><a href=
"#BASICS">Printer Driver Basics
</a></li>
391 <li><a href=
"#CREATING">Creating New PPD Files
</a></li>
392 <li><a href=
"#FILTERS">Using Filters
</a></li>
393 <li><a href=
"#COLOR">Implementing Color Management
</a></li>
394 <li><a href=
"#MACOSX">Adding macOS Features
</a></li>
398 <h2 class='title'
><a name='BASICS'
>Printer Driver Basics
</a></h2>
400 <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>
402 <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>
404 <div class='figure'
><table summary='Raster Filter Chain'
>
405 <caption>Figure
1:
<a name='FIGURE_1'
>Raster Filter Chain
</a></caption>
406 <tr><td><img src='../images/cups-raster-chain.png' width='
700' height='
150' alt='Raster Filter Chain'
></td></tr>
409 <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>
411 <div class='table'
><table summary='Standard CUPS Raster Filters'
>
412 <caption>Table
1:
<a name='TABLE_1'
>Standard CUPS Raster Filters
</a></caption>
414 <tr><th>Filter
</th><th>PDLs
</th><th>ppdc DriverType
</th><th>ppdc #include file
</th></tr>
417 <tr><td>rastertoepson
</td><td>ESC/P, ESC/P2
</td><td>epson
</td><td>epson.h
</td></tr>
418 <tr><td>rastertoescpx
</td><td>ESC/P, ESC/P2, EPSON Remote Mode
</td><td>escp
</td><td>escp.h
</td></tr>
419 <tr><td>rastertohp
</td><td>HP-PCL3, HP-PCL5
</td><td>hp
</td><td>hp.h
</td></tr>
420 <tr><td>rastertolabel
</td><td>CPCL, Dymo, EPL1, EPL2, Intellitech PCL, ZPL
</td><td>label
</td><td>label.h
</td></tr>
421 <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>
425 <p>The optional port monitor handles interface-specific protocol or encoding issues. For example, some raster printers use the
1284.4 communications protocol.
</p>
427 <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>
429 <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>
431 <div class='figure'
><table summary='Command Filter Chain'
>
432 <caption>Figure
2:
<a name='FIGURE_2'
>Command Filter Chain
</a></caption>
433 <tr><td><img src='../images/cups-command-chain.png' width='
575' height='
150' alt='Command Filter Chain'
></td></tr>
436 <p>Raster printer drivers must provide their own command filter.
</p>
439 <h2 class='title'
><a name='CREATING'
>Creating New PPD Files
</a></h2>
441 <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>
443 <p class='example'
>Listing
1:
<a name='LISTING_1'
>"examples/laserjet-basic.drv"</a></p>
445 <pre class='example'
>
446 <I>// Include standard font and media definitions
</I>
447 <a href='ref-ppdcfile.html#_include'
>#include
</a> <font.defs
>
448 <a href='ref-ppdcfile.html#_include'
>#include
</a> <media.defs
>
450 <I>// Include HP-PCL driver definitions
</I>
451 <a href='ref-ppdcfile.html#_include'
>#include
</a> <pcl.h
>
453 <I>// Specify that this driver uses the HP-PCL driver...
</I>
454 <a href='ref-ppdcfile.html#DriverType'
>DriverType
</a> pcl
456 <I>// Specify the driver options via the model number...
</I>
457 <a href='ref-ppdcfile.html#ModelNumber'
>ModelNumber
</a> ($PCL_PAPER_SIZE $PCL_PJL $PCL_PJL_RESOLUTION)
459 <I>// List the fonts that are supported, in this case all standard fonts...
</I>
460 <a href='ref-ppdcfile.html#Font'
>Font
</a> *
462 <I>// Manufacturer and driver version
</I>
463 <a href='ref-ppdcfile.html#Manufacturer'
>Manufacturer
</a> "HP"
464 <a href='ref-ppdcfile.html#Version'
>Version
</a> 1.0
466 <I>// Supported page sizes and their margins
</I>
467 <a href='ref-ppdcfile.html#HWMargins'
>HWMargins
</a> 18 12 18 12
468 *
<a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Letter
469 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Legal
470 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Executive
471 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Monarch
472 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Statement
473 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> FanFoldGermanLegal
475 <a href='ref-ppdcfile.html#HWMargins'
>HWMargins
</a> 18 12.72 18 12.72
476 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Env10
478 <a href='ref-ppdcfile.html#HWMargins'
>HWMargins
</a> 9.72 12 9.72 12
479 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> A4
480 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> A5
481 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> B5
482 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> EnvC5
483 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> EnvDL
484 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> EnvISOB5
485 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Postcard
486 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> DoublePostcard
488 <I>// Only black-and-white output with mode
3 compression...
</I>
489 <a href='ref-ppdcfile.html#ColorModel'
>ColorModel
</a> Gray k chunky
3
491 <I>// Supported resolutions
</I>
492 <a href='ref-ppdcfile.html#Resolution'
>Resolution
</a> -
1 0 0 0 "300dpi/300 DPI"
493 *
<a href='ref-ppdcfile.html#Resolution'
>Resolution
</a> -
8 0 0 0 "600dpi/600 DPI"
495 <I>// Supported input slots
</I>
496 *
<a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 7 "Auto/Automatic Selection"
497 <a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 2 "Manual/Tray 1 - Manual Feed"
498 <a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 4 "Upper/Tray 1"
499 <a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 1 "Lower/Tray 2"
500 <a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 5 "LargeCapacity/Tray 3"
502 <I>// Tray
3 is an option...
</I>
503 <a href='ref-ppdcfile.html#Installable'
>Installable
</a> "OptionLargeCapacity/Tray 3 Installed"
504 <a href='ref-ppdcfile.html#UIConstraints'
>UIConstraints
</a> "*OptionLargeCapacity False *InputSlot LargeCapacity"
507 <I>// HP LaserJet
2100 Series
</I>
508 <a href='ref-ppdcfile.html#Throughput'
>Throughput
</a> 10
509 <a href='ref-ppdcfile.html#ModelName'
>ModelName
</a> "LaserJet 2100 Series"
510 <a href='ref-ppdcfile.html#PCFileName'
>PCFileName
</a> "hpljt211.ppd"
514 <I>// LaserJet
2200 and
2300 series have duplexer option...
</I>
515 <a href='ref-ppdcfile.html#Duplex'
>Duplex
</a> normal
516 <a href='ref-ppdcfile.html#Installable'
>Installable
</a> "OptionDuplex/Duplexer Installed"
517 <a href='ref-ppdcfile.html#UIConstraints'
>UIConstraints
</a> "*OptionDuplex False *Duplex"
520 <I>// HP LaserJet
2200 Series
</I>
521 <a href='ref-ppdcfile.html#Throughput'
>Throughput
</a> 19
522 <a href='ref-ppdcfile.html#ModelName'
>ModelName
</a> "LaserJet 2200 Series"
523 <a href='ref-ppdcfile.html#PCFileName'
>PCFileName
</a> "hpljt221.ppd"
527 <I>// HP LaserJet
2300 Series
</I>
528 <a href='ref-ppdcfile.html#Throughput'
>Throughput
</a> 25
529 <a href='ref-ppdcfile.html#ModelName'
>ModelName
</a> "LaserJet 2300 Series"
530 <a href='ref-ppdcfile.html#PCFileName'
>PCFileName
</a> "hpljt231.ppd"
536 <h2 class='title'
><a name='FILTERS'
>Using Filters
</a></h2>
538 <p>The standard CUPS raster filters can be specified using the
539 <a href='ref-ppdcfile.html#DriverType'
><tt>DriverType
</tt></a> directive, for example:
</p>
541 <pre class='example'
>
542 <I>// Specify that this driver uses the HP-PCL driver...
</I>
543 <a href='ref-ppdcfile.html#DriverType'
>DriverType
</a> pcl
546 <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>
548 <pre class='example'
>
549 <a href='ref-ppdcfile.html#DriverType'
>DriverType
</a> custom
550 <a href='ref-ppdcfile.html#Filter'
>Filter
</a> application/vnd.cups-raster
100 /path/to/raster/filter
551 <a href='ref-ppdcfile.html#Filter'
>Filter
</a> application/vnd.cups-command
100 /path/to/command/filter
555 <h2 class='title'
><a name='COLOR'
>Implementing Color Management
</a></h2>
557 <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>
559 <pre class='example'
>
560 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> cupsICCProfile
"ColorModel.MediaType.Resolution/Description" /path/to/ICC/profile
563 <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>
565 <pre class='example'
>
566 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> cupsICCProfile
"Gray../Grayscale Profile" /path/to/ICC/gray-profile
567 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> cupsICCProfile
"RGB../Full Color Profile" /path/to/ICC/rgb-profile
570 <p>The options used for profile selection can be customized using the
<tt>cupsICCQualifier2
</tt> and
<tt>cupsICCQualifier3
</tt> attributes.
</p>
572 <h3><span class='info'
>Since macOS
10.5</span>Custom Color Matching Support
</h3>
574 <p>macOS 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>
576 <pre class='example'
>
577 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APSupportsCustomColorMatching
"" true
578 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APDefaultCustomColorMatchingProfile
"" sRGB
582 <h2 class='title'
><a name='MACOSX'
>Adding macOS Features
</a></h2>
584 <p>macOS 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>
586 <pre class='example'
>
587 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APDialogExtension
"" /Library/Printers/Vendor/filename.plugin
588 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APHelpBook
"" /Library/Printers/Vendor/filename.bundle
589 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APPrinterIconPath
"" /Library/Printers/Vendor/filename.icns
590 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APPrinterPreset
"name/text" "*option choice ..."