1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/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;
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 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>,
<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='postscript-driver.html'
>Developing PostScript 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></li>
353 <li><a href=
"#FILTERS">Using Filters
</a></li>
354 <li><a href=
"#COLOR">Implementing Color Management
</a></li>
355 <li><a href=
"#MACOSX">Adding Mac OS X Features
</a></li>
356 <li><a href=
"#DEPLOY">Deploying Your Driver
</a></li>
357 <h2 class='title'
><a name='BASICS'
>Printer Driver Basics
</a></h2>
359 <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>
361 <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>
363 <div class='figure'
><table summary='Raster Filter Chain'
>
364 <caption>Figure
1:
<a name='FIGURE_1'
>Raster Filter Chain
</a></caption>
365 <tr><td><img src='/images/cups-raster-chain.png' width='
700' height='
150' alt='Raster Filter Chain'
></td></tr>
368 <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>
370 <div class='table'
><table summary='Standard CUPS Raster Filters'
>
371 <caption>Table
1:
<a name='TABLE_1'
>Standard CUPS Raster Filters
</a></caption>
373 <tr><th>Filter
</th><th>PDLs
</th><th>ppdc DriverType
</th><th>ppdc #include file
</th></tr>
376 <tr><td>rastertoepson
</td><td>ESC/P, ESC/P2
</td><td>epson
</td><td>epson.h
</td></tr>
377 <tr><td>rastertoescpx
</td><td>ESC/P, ESC/P2, EPSON Remote Mode
</td><td>escp
</td><td>escp.h
</td></tr>
378 <tr><td>rastertohp
</td><td>HP-PCL3, HP-PCL5
</td><td>hp
</td><td>hp.h
</td></tr>
379 <tr><td>rastertolabel
</td><td>CPCL, Dymo, EPL1, EPL2, Intellitech PCL, ZPL
</td><td>label
</td><td>label.h
</td></tr>
380 <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>
384 <p>The optional port monitor handles interface-specific protocol or encoding issues. For example, some raster printers use the
1284.4 communications protocol.
</p>
386 <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>
388 <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>
390 <div class='figure'
><table summary='Command Filter Chain'
>
391 <caption>Figure
2:
<a name='FIGURE_2'
>Command Filter Chain
</a></caption>
392 <tr><td><img src='/images/cups-command-chain.png' width='
575' height='
150' alt='Command Filter Chain'
></td></tr>
395 <p>Raster printer drivers must provide their own command filter.
</p>
398 <h2 class='title'
><a name='CREATING'
>Creating New PPD Files
</a></h2>
400 <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>
402 <p class='example'
>Listing
1:
<a name='LISTING_1'
>"examples/laserjet-basic.drv"</a></p>
404 <pre class='example'
>
405 <I>// Include standard font and media definitions
</I>
406 <a href='ref-ppdcfile.html#_include'
>#include
</a> <font.defs
>
407 <a href='ref-ppdcfile.html#_include'
>#include
</a> <media.defs
>
409 <I>// Include HP-PCL driver definitions
</I>
410 <a href='ref-ppdcfile.html#_include'
>#include
</a> <pcl.h
>
412 <I>// Specify that this driver uses the HP-PCL driver...
</I>
413 <a href='ref-ppdcfile.html#DriverType'
>DriverType
</a> pcl
415 <I>// Specify the driver options via the model number...
</I>
416 <a href='ref-ppdcfile.html#ModelNumber'
>ModelNumber
</a> ($PCL_PAPER_SIZE $PCL_PJL $PCL_PJL_RESOLUTION)
418 <I>// List the fonts that are supported, in this case all standard fonts...
</I>
419 <a href='ref-ppdcfile.html#Font'
>Font
</a> *
421 <I>// Manufacturer and driver version
</I>
422 <a href='ref-ppdcfile.html#Manufacturer'
>Manufacturer
</a> "HP"
423 <a href='ref-ppdcfile.html#Version'
>Version
</a> 1.0
425 <I>// Supported page sizes and their margins
</I>
426 <a href='ref-ppdcfile.html#HWMargins'
>HWMargins
</a> 18 12 18 12
427 *
<a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Letter
428 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Legal
429 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Executive
430 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Monarch
431 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Statement
432 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> FanFoldGermanLegal
434 <a href='ref-ppdcfile.html#HWMargins'
>HWMargins
</a> 18 12.72 18 12.72
435 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Env10
437 <a href='ref-ppdcfile.html#HWMargins'
>HWMargins
</a> 9.72 12 9.72 12
438 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> A4
439 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> A5
440 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> B5
441 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> EnvC5
442 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> EnvDL
443 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> EnvISOB5
444 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> Postcard
445 <a href='ref-ppdcfile.html#MediaSize'
>MediaSize
</a> DoublePostcard
447 <I>// Only black-and-white output with mode
3 compression...
</I>
448 <a href='ref-ppdcfile.html#ColorModel'
>ColorModel
</a> Gray k chunky
3
450 <I>// Supported resolutions
</I>
451 <a href='ref-ppdcfile.html#Resolution'
>Resolution
</a> -
1 0 0 0 "300dpi/300 DPI"
452 *
<a href='ref-ppdcfile.html#Resolution'
>Resolution
</a> -
8 0 0 0 "600dpi/600 DPI"
454 <I>// Supported input slots
</I>
455 *
<a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 7 "Auto/Automatic Selection"
456 <a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 2 "Manual/Tray 1 - Manual Feed"
457 <a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 4 "Upper/Tray 1"
458 <a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 1 "Lower/Tray 2"
459 <a href='ref-ppdcfile.html#InputSlot'
>InputSlot
</a> 5 "LargeCapacity/Tray 3"
461 <I>// Tray
3 is an option...
</I>
462 <a href='ref-ppdcfile.html#Installable'
>Installable
</a> "OptionLargeCapacity/Tray 3 Installed"
463 <a href='ref-ppdcfile.html#UIConstraints'
>UIConstraints
</a> "*OptionLargeCapacity False *InputSlot LargeCapacity"
466 <I>// HP LaserJet
2100 Series
</I>
467 <a href='ref-ppdcfile.html#Throughput'
>Throughput
</a> 10
468 <a href='ref-ppdcfile.html#ModelName'
>ModelName
</a> "LaserJet 2100 Series"
469 <a href='ref-ppdcfile.html#PCFileName'
>PCFileName
</a> "hpljt211.ppd"
473 <I>// LaserJet
2200 and
2300 series have duplexer option...
</I>
474 <a href='ref-ppdcfile.html#Duplex'
>Duplex
</a> normal
475 <a href='ref-ppdcfile.html#Installable'
>Installable
</a> "OptionDuplex/Duplexer Installed"
476 <a href='ref-ppdcfile.html#UIConstraints'
>UIConstraints
</a> "*OptionDuplex False *Duplex"
479 <I>// HP LaserJet
2200 Series
</I>
480 <a href='ref-ppdcfile.html#Throughput'
>Throughput
</a> 19
481 <a href='ref-ppdcfile.html#ModelName'
>ModelName
</a> "LaserJet 2200 Series"
482 <a href='ref-ppdcfile.html#PCFileName'
>PCFileName
</a> "hpljt221.ppd"
486 <I>// HP LaserJet
2300 Series
</I>
487 <a href='ref-ppdcfile.html#Throughput'
>Throughput
</a> 25
488 <a href='ref-ppdcfile.html#ModelName'
>ModelName
</a> "LaserJet 2300 Series"
489 <a href='ref-ppdcfile.html#PCFileName'
>PCFileName
</a> "hpljt231.ppd"
495 <h2 class='title'
><a name='FILTERS'
>Using Filters
</a></h2>
497 <p>The standard CUPS raster filters can be specified using the
498 <a href='ref-ppdcfile.html#DriverType'
><tt>DriverType
</tt></a> directive, for example:
</p>
500 <pre class='example'
>
501 <I>// Specify that this driver uses the HP-PCL driver...
</I>
502 <a href='ref-ppdcfile.html#DriverType'
>DriverType
</a> pcl
505 <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>
507 <pre class='example'
>
508 <a href='ref-ppdcfile.html#DriverType'
>DriverType
</a> custom
509 <a href='ref-ppdcfile.html#Filter'
>Filter
</a> application/vnd.cups-raster
100 /path/to/raster/filter
510 <a href='ref-ppdcfile.html#Filter'
>Filter
</a> application/vnd.cups-command
100 /path/to/command/filter
514 <h2 class='title'
><a name='COLOR'
>Implementing Color Management
</a></h2>
516 <p>Talk about ICC color profiles and sRGB as two best options.
</p>
519 <h2 class='title'
><a name='MACOSX'
>Adding Mac OS X Features
</a></h2>
521 <p>Talk about help books, icons, and PDEs.
</p>
524 <h2 class='title'
><a name='DEPLOY'
>Deploying Your Driver
</a></h2>
526 <p>Talk about install locations, etc.
</p>