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=
"codedoc v3.1">
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;
21 H1 { font-size: 2em; }
22 H2 { font-size: 1.75em; }
23 H3 { font-size: 1.5em; }
24 H4 { font-size: 1.25em; }
27 font-family: monaco, courier, monospace;
32 font-family: monaco, courier, monospace;
36 border-left: solid 2px #777;
45 PRE.command, PRE.example {
72 PRE.command EM, PRE.example EM {
73 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
77 font-family: monaco, courier, monospace;
93 -moz-border-radius: 10px;
98 text-decoration: none;
101 A:link:hover, A:visited:hover, A:active {
102 text-decoration: underline;
109 TR.data, TD.data, TR.data TD {
112 border-bottom: solid 1pt #999999;
116 border-bottom: solid 1pt #999999;
123 border: solid thin #999999;
124 border-collapse: collapse;
140 border: solid thin #cccccc;
147 border-bottom: solid thin #999999;
156 caption-side: bottom;
180 border: thin solid black;
188 H2 SPAN.info, H3 SPAN.info, H4 SPAN.info {
197 border-bottom: solid 2pt #000000;
200 DIV.indent, TABLE.indent {
208 border-collapse: collapse;
211 TABLE.indent TD, TABLE.indent TH {
216 border-collapse: collapse;
224 border-bottom: solid thin #cccccc;
229 vertical-align: bottom;
238 border-bottom: solid thin #eeeeee;
243 TABLE.list TR:nth-child(even) {
247 TABLE.list TR:nth-child(odd) {
266 font-family: monaco, courier, monospace;
270 border: solid thin #999999;
271 border-collapse: collapse;
276 DIV.summary TABLE TD, DIV.summary TABLE TH {
277 border: solid thin #999999;
283 DIV.summary TABLE THEAD TH {
287 /* API documentation styles... */
299 margin-bottom: 0.5em;
304 margin-bottom: 0.5em;
309 margin-bottom: 0.5em;
314 border: solid thin black;
323 div.contents ul.contents {
327 border-bottom: solid 2px gray;
337 border-bottom: solid 2px gray;
340 border-bottom: solid 2px gray;
352 border-bottom: solid 2px gray;
355 border-bottom: solid 2px gray;
358 border-bottom: solid 2px gray;
362 h1, h2, h3, h4, h5, h6 {
363 page-break-inside: avoid;
366 border: solid thin gray;
367 box-shadow: 3px 3px 5px rgba(0,0,0,0.5);
368 padding: 10px 10px 0px;
369 page-break-inside: avoid;
371 p code, li code, p.code, pre, ul.code li {
372 background: rgba(127,127,127,0.1);
373 border: thin dotted gray;
374 font-family: monospace;
376 -webkit-hyphens: manual;
377 page-break-inside: avoid;
379 p.code, pre, ul.code li {
386 text-decoration: none;
390 border: solid thin black;
397 h2 span.info, h3 span.info, h4 span.info {
403 h2.title span.info, h3.title span.info, h4.title span.info {
404 border-bottom-left-radius: 0px;
405 border-bottom-right-radius: 0px;
410 ul.code, ul.contents, ul.subcontents {
411 list-style-type: none;
421 ul.contents li ul.code, ul.contents li ul.subcontents {
425 border-collapse: collapse;
428 table.list tr:nth-child(even) {
429 background: rgba(127,127,127,0.1);]n}
431 border-right: 2px solid gray;
432 font-family: monospace;
433 padding: 5px 10px 5px 2px;
438 padding: 5px 2px 5px 10px;
445 border-bottom: solid 2px black;
448 border-bottom: solid 2px black;
454 Raster printer driver documentation for CUPS.
456 Copyright © 2007-2018 by Apple Inc.
457 Copyright © 1997-2007 by Easy Software Products.
459 Licensed under Apache License v2.0. See the file "LICENSE" for more
463 <h1 class='title'
>Developing Raster Printer Drivers
</h1>
465 <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>
467 <div class='summary'
><table summary='General Information'
>
471 <td>Programming:
<a href='postscript-driver.html'
>Developing PostScript Printer Drivers
</a><br>
472 Programming:
<a href='api-filter.html'
>Filter and Backend Programming
</a><br>
473 Programming:
<a href='ppd-compiler.html'
>Introduction to the PPD Compiler
</a><br>
474 Programming:
<a href='api-raster.html'
>Raster API
</a><br>
475 References:
<a href='ref-ppdcfile.html'
>PPD Compiler Driver Information File Reference
</a><br>
476 Specifications:
<a href='spec-ppd.html'
>CUPS PPD Extensions
</a></td>
480 <div class=
"contents">
481 <h2 class=
"title">Contents
</h2>
482 <ul class=
"contents">
483 <li><a href=
"#BASICS">Printer Driver Basics
</a></li>
484 <li><a href=
"#CREATING">Creating New PPD Files
</a></li>
485 <li><a href=
"#FILTERS">Using Filters
</a></li>
486 <li><a href=
"#COLOR">Implementing Color Management
</a></li>
487 <li><a href=
"#MACOSX">Adding macOS Features
</a></li>
491 <h2 class='title'
><a name='BASICS'
>Printer Driver Basics
</a></h2>
493 <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>
495 <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>
497 <div class='figure'
><table summary='Raster Filter Chain'
>
498 <caption>Figure
1:
<a name='FIGURE_1'
>Raster Filter Chain
</a></caption>
499 <tr><td><img src='../images/cups-raster-chain.png' width='
700' height='
150' alt='Raster Filter Chain'
></td></tr>
502 <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>
504 <div class='table'
><table summary='Standard CUPS Raster Filters'
>
505 <caption>Table
1:
<a name='TABLE_1'
>Standard CUPS Raster Filters
</a></caption>
507 <tr><th>Filter
</th><th>PDLs
</th><th>ppdc DriverType
</th><th>ppdc #include file
</th></tr>
510 <tr><td>rastertoepson
</td><td>ESC/P, ESC/P2
</td><td>epson
</td><td>epson.h
</td></tr>
511 <tr><td>rastertoescpx
</td><td>ESC/P, ESC/P2, EPSON Remote Mode
</td><td>escp
</td><td>escp.h
</td></tr>
512 <tr><td>rastertohp
</td><td>HP-PCL3, HP-PCL5
</td><td>hp
</td><td>hp.h
</td></tr>
513 <tr><td>rastertolabel
</td><td>CPCL, Dymo, EPL1, EPL2, Intellitech PCL, ZPL
</td><td>label
</td><td>label.h
</td></tr>
514 <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>
518 <p>The optional port monitor handles interface-specific protocol or encoding issues. For example, some raster printers use the
1284.4 communications protocol.
</p>
520 <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>
522 <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>
524 <div class='figure'
><table summary='Command Filter Chain'
>
525 <caption>Figure
2:
<a name='FIGURE_2'
>Command Filter Chain
</a></caption>
526 <tr><td><img src='../images/cups-command-chain.png' width='
575' height='
150' alt='Command Filter Chain'
></td></tr>
529 <p>Raster printer drivers must provide their own command filter.
</p>
532 <h2 class='title'
><a name='CREATING'
>Creating New PPD Files
</a></h2>
534 <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>
536 <p class='example'
>Listing
1:
<a name='LISTING_1'
>"examples/laserjet-basic.drv"</a></p>
538 <pre class='example'
>
539 <I>// Include standard font and media definitions
</I>
540 <a href='ref-ppdcfile.html#_include'
>#include
</a> <font.defs
>
541 <a href='ref-ppdcfile.html#_include'
>#include
</a> <media.defs
>
543 <I>// Include HP-PCL driver definitions
</I>
544 <a href='ref-ppdcfile.html#_include'
>#include
</a> <pcl.h
>
546 <I>// Specify that this driver uses the HP-PCL driver...
</I>
547 <a href='ref-ppdcfile.html#DriverType'
>DriverType
</a> pcl
549 <I>// Specify the driver options via the model number...
</I>
550 <a href='ref-ppdcfile.html#ModelNumber'
>ModelNumber
</a> ($PCL_PAPER_SIZE $PCL_PJL $PCL_PJL_RESOLUTION)
552 <I>// List the fonts that are supported, in this case all standard fonts...
</I>
553 <a href='ref-ppdcfile.html#Font'
>Font
</a> *
555 <I>// Manufacturer and driver version
</I>
556 <a href='ref-ppdcfile.html#Manufacturer'
>Manufacturer
</a> "HP"
557 <a href='ref-ppdcfile.html#Version'
>Version
</a> 1.0
559 <I>// Supported page sizes and their margins
</I>
560 <a href='ref-ppdcfile.html#HWMargins'
>HWMargins
</a> 18 12 18 12
561 *
<a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Letter
562 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Legal
563 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Executive
564 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Monarch
565 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Statement
566 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> FanFoldGermanLegal
568 <a href='ref-ppdcfile.html#HWMargins'
>HWMargins
</a> 18 12.72 18 12.72
569 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Env10
571 <a href='ref-ppdcfile.html#HWMargins'
>HWMargins
</a> 9.72 12 9.72 12
572 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> A4
573 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> A5
574 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> B5
575 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> EnvC5
576 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> EnvDL
577 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> EnvISOB5
578 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Postcard
579 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> DoublePostcard
581 <I>// Only black-and-white output with mode
3 compression...
</I>
582 <a href='ref-ppdcfile.html#ColorModel'
>ColorModel
</a> Gray k chunky
3
584 <I>// Supported resolutions
</I>
585 <a href='ref-ppdcfile.html#Resolution'
>Resolution
</a> -
1 0 0 0 "300dpi/300 DPI"
586 *
<a href='ref-ppdcfile.html#Resolution'
>Resolution
</a> -
8 0 0 0 "600dpi/600 DPI"
588 <I>// Supported input slots
</I>
589 *
<a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 7 "Auto/Automatic Selection"
590 <a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 2 "Manual/Tray 1 - Manual Feed"
591 <a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 4 "Upper/Tray 1"
592 <a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 1 "Lower/Tray 2"
593 <a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 5 "LargeCapacity/Tray 3"
595 <I>// Tray
3 is an option...
</I>
596 <a href='ref-ppdcfile.html#Installable'
>Installable
</a> "OptionLargeCapacity/Tray 3 Installed"
597 <a href='ref-ppdcfile.html#UIConstraints'
>UIConstraints
</a> "*OptionLargeCapacity False *InputSlot LargeCapacity"
600 <I>// HP LaserJet
2100 Series
</I>
601 <a href='ref-ppdcfile.html#Throughput'
>Throughput
</a> 10
602 <a href='ref-ppdcfile.html#ModelName'
>ModelName
</a> "LaserJet 2100 Series"
603 <a href='ref-ppdcfile.html#PCFileName'
>PCFileName
</a> "hpljt211.ppd"
607 <I>// LaserJet
2200 and
2300 series have duplexer option...
</I>
608 <a href='ref-ppdcfile.html#Duplex'
>Duplex
</a> normal
609 <a href='ref-ppdcfile.html#Installable'
>Installable
</a> "OptionDuplex/Duplexer Installed"
610 <a href='ref-ppdcfile.html#UIConstraints'
>UIConstraints
</a> "*OptionDuplex False *Duplex"
613 <I>// HP LaserJet
2200 Series
</I>
614 <a href='ref-ppdcfile.html#Throughput'
>Throughput
</a> 19
615 <a href='ref-ppdcfile.html#ModelName'
>ModelName
</a> "LaserJet 2200 Series"
616 <a href='ref-ppdcfile.html#PCFileName'
>PCFileName
</a> "hpljt221.ppd"
620 <I>// HP LaserJet
2300 Series
</I>
621 <a href='ref-ppdcfile.html#Throughput'
>Throughput
</a> 25
622 <a href='ref-ppdcfile.html#ModelName'
>ModelName
</a> "LaserJet 2300 Series"
623 <a href='ref-ppdcfile.html#PCFileName'
>PCFileName
</a> "hpljt231.ppd"
629 <h2 class='title'
><a name='FILTERS'
>Using Filters
</a></h2>
631 <p>The standard CUPS raster filters can be specified using the
632 <a href='ref-ppdcfile.html#DriverType'
><tt>DriverType
</tt></a> directive, for example:
</p>
634 <pre class='example'
>
635 <I>// Specify that this driver uses the HP-PCL driver...
</I>
636 <a href='ref-ppdcfile.html#DriverType'
>DriverType
</a> pcl
639 <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>
641 <pre class='example'
>
642 <a href='ref-ppdcfile.html#DriverType'
>DriverType
</a> custom
643 <a href='ref-ppdcfile.html#Filter'
>Filter
</a> application/vnd.cups-raster
100 /path/to/raster/filter
644 <a href='ref-ppdcfile.html#Filter'
>Filter
</a> application/vnd.cups-command
100 /path/to/command/filter
648 <h2 class='title'
><a name='COLOR'
>Implementing Color Management
</a></h2>
650 <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>
652 <pre class='example'
>
653 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> cupsICCProfile
"ColorModel.MediaType.Resolution/Description" /path/to/ICC/profile
656 <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>
658 <pre class='example'
>
659 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> cupsICCProfile
"Gray../Grayscale Profile" /path/to/ICC/gray-profile
660 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> cupsICCProfile
"RGB../Full Color Profile" /path/to/ICC/rgb-profile
663 <p>The options used for profile selection can be customized using the
<tt>cupsICCQualifier2
</tt> and
<tt>cupsICCQualifier3
</tt> attributes.
</p>
665 <h3><span class='info'
>Since macOS
10.5</span>Custom Color Matching Support
</h3>
667 <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>
669 <pre class='example'
>
670 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APSupportsCustomColorMatching
"" true
671 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APDefaultCustomColorMatchingProfile
"" sRGB
675 <h2 class='title'
><a name='MACOSX'
>Adding macOS Features
</a></h2>
677 <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>
679 <pre class='example'
>
680 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APDialogExtension
"" /Library/Printers/Vendor/filename.plugin
681 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APHelpBook
"" /Library/Printers/Vendor/filename.bundle
682 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APPrinterIconPath
"" /Library/Printers/Vendor/filename.icns
683 <a href='ref-ppdcfile.html#Attribute'
>Attribute
</a> APPrinterPreset
"name/text" "*option choice ..."