]> git.ipfire.org Git - thirdparty/cups.git/blame - doc/help/postscript-driver.html
Update API documentation.
[thirdparty/cups.git] / doc / help / postscript-driver.html
CommitLineData
73721e3e 1<!DOCTYPE html>
8b450588 2<html>
28b9d139 3<!-- SECTION: Programming -->
abacc52b
MS
4 <head>
5 <title>Developing PostScript Printer Drivers</title>
6 <meta name="keywords" content="Programming">
7 <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
93d79201 8 <meta name="creator" content="codedoc v3.2">
abacc52b
MS
9 <meta name="author" content="Unknown">
10 <meta name="copyright" content="Unknown">
53af7f21 11 <meta name="version" content="0.0">
abacc52b 12 <style type="text/css"><!--
8b450588
MS
13BODY {
14 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
15}
16
17H1, H2, H3, H4, H5, H6, P, TD, TH {
18 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
19}
20
73721e3e
MS
21H1 { font-size: 2em; }
22H2 { font-size: 1.75em; }
23H3 { font-size: 1.5em; }
24H4 { font-size: 1.25em; }
25
8b450588
MS
26KBD {
27 font-family: monaco, courier, monospace;
28 font-weight: bold;
29}
30
31PRE {
32 font-family: monaco, courier, monospace;
33}
34
699fe020
MS
35BLOCKQUOTE {
36 border-left: solid 2px #777;
37 margin: 1em 0;
38 padding: 10px;
39}
40
41BLOCKQUOTE OL LI {
42 margin-left: -1em;
43}
44
45PRE.command, PRE.example {
46 background: #eee;
47 margin: 0 36pt;
10d09e33 48 padding: 10px;
8b450588
MS
49}
50
f11a948a
MS
51P.compact {
52 margin: 0;
53}
54
8b450588
MS
55P.example {
56 font-style: italic;
57 margin-left: 36pt;
58}
ca6b43fc 59
240214ef
MS
60DL.man DD {
61 margin-left: 5em;
62}
63
64DL.man DT {
65 margin-left: 0;
66}
67
68PRE.man {
69 margin: 0;
70}
71
8b450588
MS
72PRE.command EM, PRE.example EM {
73 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
74}
75
76P.command {
77 font-family: monaco, courier, monospace;
78 margin-left: 36pt;
79}
80
81P.formula {
82 font-style: italic;
83 margin-left: 36pt;
84}
85
8b450588
MS
86A IMG {
87 border: none;
88}
89
90A:link:hover IMG {
91 background: #f0f0f0;
92 border-radius: 10px;
93 -moz-border-radius: 10px;
94}
95
96A:link, A:visited {
ca6b43fc 97 font-weight: inherit;
8b450588
MS
98 text-decoration: none;
99}
100
101A:link:hover, A:visited:hover, A:active {
102 text-decoration: underline;
103}
104
105SUB, SUP {
106 font-size: 50%;
107}
108
109TR.data, TD.data, TR.data TD {
110 margin-top: 10pt;
111 padding: 5pt;
112 border-bottom: solid 1pt #999999;
113}
114
115TR.data TH {
116 border-bottom: solid 1pt #999999;
117 padding-top: 10pt;
118 padding-left: 5pt;
119 text-align: left;
120}
121
122DIV.table TABLE {
123 border: solid thin #999999;
124 border-collapse: collapse;
125 border-spacing: 0;
126 margin-left: auto;
127 margin-right: auto;
128}
129
130DIV.table CAPTION {
131 caption-side: top;
132 font-size: 120%;
133 font-style: italic;
134 font-weight: bold;
135 margin-left: auto;
136 margin-right: auto;
137}
138
139DIV.table TABLE TD {
140 border: solid thin #cccccc;
699fe020 141 padding: 5pt 10pt 0;
8b450588
MS
142}
143
144DIV.table TABLE TH {
145 background: #cccccc;
146 border: none;
147 border-bottom: solid thin #999999;
148}
149
150DIV.figure TABLE {
151 margin-left: auto;
152 margin-right: auto;
153}
154
155DIV.figure CAPTION {
156 caption-side: bottom;
157 font-size: 120%;
158 font-style: italic;
159 font-weight: bold;
160 margin-left: auto;
161 margin-right: auto;
162}
163
164TH.label {
165 text-align: right;
166 vertical-align: top;
167}
168
169TH.sublabel {
170 text-align: right;
171 font-weight: normal;
172}
173
174HR {
175 border: solid thin;
176}
177
178SPAN.info {
179 background: black;
180 border: thin solid black;
181 color: white;
182 font-size: 80%;
183 font-style: italic;
184 font-weight: bold;
185 white-space: nowrap;
186}
187
188H2 SPAN.info, H3 SPAN.info, H4 SPAN.info {
189 float: right;
190 font-size: 100%;
191}
192
178cb736
MS
193H1.title {
194}
195
8b450588
MS
196H2.title, H3.title {
197 border-bottom: solid 2pt #000000;
198}
199
200DIV.indent, TABLE.indent {
201 margin-top: 2em;
202 margin-left: auto;
203 margin-right: auto;
204 width: 90%;
205}
206
207TABLE.indent {
208 border-collapse: collapse;
209}
210
211TABLE.indent TD, TABLE.indent TH {
212 padding: 0;
213}
214
215TABLE.list {
216 border-collapse: collapse;
217 margin-left: auto;
218 margin-right: auto;
219 width: 90%;
220}
221
222TABLE.list TH {
223 background: white;
224 border-bottom: solid thin #cccccc;
225 color: #444444;
226 padding-top: 10pt;
227 padding-left: 5pt;
228 text-align: left;
229 vertical-align: bottom;
230 white-space: nowrap;
231}
232
233TABLE.list TH A {
234 color: #4444cc;
235}
236
237TABLE.list TD {
238 border-bottom: solid thin #eeeeee;
239 padding-top: 5pt;
240 padding-left: 5pt;
241}
242
243TABLE.list TR:nth-child(even) {
244 background: #f8f8f8;
245}
246
247TABLE.list TR:nth-child(odd) {
248 background: #f4f4f4;
249}
250
251DT {
252 margin-left: 36pt;
253 margin-top: 12pt;
254}
255
256DD {
257 margin-left: 54pt;
258}
259
260DL.category DT {
261 font-weight: bold;
262}
263
264P.summary {
265 margin-left: 36pt;
266 font-family: monaco, courier, monospace;
267}
268
269DIV.summary TABLE {
270 border: solid thin #999999;
271 border-collapse: collapse;
272 border-spacing: 0;
273 margin: 10px;
274}
275
276DIV.summary TABLE TD, DIV.summary TABLE TH {
277 border: solid thin #999999;
278 padding: 5px;
279 text-align: left;
280 vertical-align: top;
281}
282
283DIV.summary TABLE THEAD TH {
284 background: #eeeeee;
285}
286
287/* API documentation styles... */
288div.body h1 {
699fe020
MS
289 font-size: 250%;
290 font-weight: bold;
8b450588
MS
291 margin: 0;
292}
293div.body h2 {
699fe020 294 font-size: 250%;
8b450588
MS
295 margin-top: 1.5em;
296}
699fe020
MS
297div.body h3 {
298 font-size: 150%;
8b450588
MS
299 margin-bottom: 0.5em;
300 margin-top: 1.5em;
301}
699fe020
MS
302div.body h4 {
303 font-size: 110%;
304 margin-bottom: 0.5em;
305 margin-top: 1.5em;
306}
307div.body h5 {
308 font-size: 100%;
309 margin-bottom: 0.5em;
310 margin-top: 1.5em;
311}
312div.contents {
313 background: #e8e8e8;
314 border: solid thin black;
315 padding: 10px;
316}
317div.contents h1 {
318 font-size: 110%;
319}
320div.contents h2 {
321 font-size: 100%;
322}
323div.contents ul.contents {
324 font-size: 80%;
325}
326.class {
327 border-bottom: solid 2px gray;
328}
329.constants {
8b450588
MS
330}
331.description {
332 margin-top: 0.5em;
333}
699fe020
MS
334.discussion {
335}
336.enumeration {
337 border-bottom: solid 2px gray;
338}
339.function {
340 border-bottom: solid 2px gray;
341 margin-bottom: 0;
342}
343.members {
344}
345.method {
346}
347.parameters {
348}
349.returnvalue {
350}
351.struct {
352 border-bottom: solid 2px gray;
353}
354.typedef {
355 border-bottom: solid 2px gray;
356}
357.union {
358 border-bottom: solid 2px gray;
359}
360.variable {
361}
362h1, h2, h3, h4, h5, h6 {
363 page-break-inside: avoid;
364}
365blockquote {
366 border: solid thin gray;
367 box-shadow: 3px 3px 5px rgba(0,0,0,0.5);
73721e3e 368 padding: 10px 10px 0px;
699fe020
MS
369 page-break-inside: avoid;
370}
371p 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;
699fe020
MS
375 hyphens: manual;
376 -webkit-hyphens: manual;
377 page-break-inside: avoid;
378}
379p.code, pre, ul.code li {
380 padding: 10px;
381}
382p code, li code {
383 padding: 2px 5px;
384}
385a:link, a:visited {
386 text-decoration: none;
387}
388span.info {
389 background: black;
390 border: solid thin black;
391 color: white;
392 font-size: 80%;
393 font-style: italic;
394 font-weight: bold;
395 white-space: nowrap;
396}
73721e3e
MS
397h2 span.info, h3 span.info, h4 span.info {
398 border-radius: 10px;
699fe020 399 float: right;
73721e3e 400 font-size: 80%;
699fe020 401 padding: 3px 6px;
8b450588 402}
73721e3e
MS
403h2.title span.info, h3.title span.info, h4.title span.info {
404 border-bottom-left-radius: 0px;
405 border-bottom-right-radius: 0px;
406}
407h2.title span.info {
408 padding: 4px 6px;
409}
8b450588
MS
410ul.code, ul.contents, ul.subcontents {
411 list-style-type: none;
412 margin: 0;
413 padding-left: 0;
414}
415ul.code li {
416 margin: 0;
417}
418ul.contents > li {
419 margin-top: 1em;
420}
421ul.contents li ul.code, ul.contents li ul.subcontents {
422 padding-left: 2em;
423}
699fe020
MS
424table.list {
425 border-collapse: collapse;
426 width: 100%;
427}
428table.list tr:nth-child(even) {
429 background: rgba(127,127,127,0.1);]n}
430table.list th {
431 border-right: 2px solid gray;
432 font-family: monospace;
433 padding: 5px 10px 5px 2px;
434 text-align: right;
435 vertical-align: top;
8b450588 436}
699fe020
MS
437table.list td {
438 padding: 5px 2px 5px 10px;
439 text-align: left;
440 vertical-align: top;
8b450588 441}
699fe020 442h1.title {
8b450588 443}
699fe020
MS
444h2.title {
445 border-bottom: solid 2px black;
8b450588 446}
699fe020
MS
447h3.title {
448 border-bottom: solid 2px black;
8b450588
MS
449}
450--></style>
abacc52b
MS
451 </head>
452 <body>
93d79201 453 <div class="header">
10d09e33 454<!--
10d09e33
MS
455 PostScript printer driver documentation for CUPS.
456
53f8d64f
MS
457 Copyright © 2007-2012 by Apple Inc.
458 Copyright © 1997-2007 by Easy Software Products.
459
460 Licensed under Apache License v2.0. See the file "LICENSE" for more
461 information.
10d09e33
MS
462-->
463
178cb736
MS
464<h1 class='title'>Developing PostScript Printer Drivers</h1>
465
8072030b 466<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>, and <a href='#MACOSX'>adding macOS features</a>.</p>
28b9d139
MS
467
468<div class='summary'><table summary='General Information'>
469<tbody>
470<tr>
471 <th>See Also</th>
472 <td>Programming: <a href='raster-driver.html'>Developing Raster Printer Drivers</a><br>
473 Programming: <a href='api-filter.html'>Filter and Backend Programming</a><br>
474 Programming: <a href='ppd-compiler.html'>Introduction to the PPD Compiler</a><br>
475 Programming: <a href='api-raster.html'>Raster API</a><br>
476 References: <a href='ref-ppdcfile.html'>PPD Compiler Driver Information File Reference</a><br>
477 Specifications: <a href='spec-ppd.html'>CUPS PPD Extensions</a></td>
478</tr>
479</tbody>
480</table></div>
93d79201 481 </div>
abacc52b
MS
482 <div class="contents">
483 <h2 class="title">Contents</h2>
484 <ul class="contents">
485 <li><a href="#BASICS">Printer Driver Basics</a></li>
486 <li><a href="#CREATING">Creating New PPD Files</a><ul class="subcontents">
487 <li><a href="#IMPORT">Importing Existing PPD Files</a></li>
488 </ul></li>
489 <li><a href="#FILTERS">Using Custom Filters</a></li>
490 <li><a href="#COLOR">Implementing Color Management</a></li>
491 <li><a href="#MACOSX">Adding macOS Features</a></li>
492 </ul>
493 </div>
494 <div class="body">
28b9d139
MS
495<h2 class='title'><a name='BASICS'>Printer Driver Basics</a></h2>
496
497<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>
498
499<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>
500
501<div class='figure'><table summary='PostScript Filter Chain'>
502<caption>Figure 1: <a name='FIGURE_1'>PostScript Filter Chain</a></caption>
b0f6947b 503<tr><td><img src='../images/cups-postscript-chain.png' width='700' height='150' alt='PostScript Filter Chain'></td></tr>
28b9d139
MS
504</table></div>
505
506<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>
507
508<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>
509
510<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>
511
512<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>
513
514<div class='figure'><table summary='Command Filter Chain'>
515<caption>Figure 2: <a name='FIGURE_2'>Command Filter Chain</a></caption>
b0f6947b 516<tr><td><img src='../images/cups-command-chain.png' width='575' height='150' alt='Command Filter Chain'></td></tr>
28b9d139
MS
517</table></div>
518
519<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>
520
521
522<h2 class='title'><a name='CREATING'>Creating New PPD Files</a></h2>
523
524<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>
525
526<p class='example'>Listing 1: <a name='LISTING_1'>"examples/postscript.drv"</a></p>
527
528<pre class='example'>
529// Include standard font and media definitions
530<a href='ref-ppdcfile.html#_include'>#include</a> &lt;font.defs&gt;
531<a href='ref-ppdcfile.html#_include'>#include</a> &lt;media.defs&gt;
532
533// Specify this is a PostScript printer driver
534<a href='ref-ppdcfile.html#DriverType'>DriverType</a> ps
535
536// List the fonts that are supported, in this case all standard fonts
537<a href='ref-ppdcfile.html#Font'>Font</a> *
538
539// Manufacturer, model name, and version
540<a href='ref-ppdcfile.html#Manufacturer'>Manufacturer</a> "Foo"
541<a href='ref-ppdcfile.html#ModelName'>ModelName</a> "Foo LaserProofer 2000"
542<a href='ref-ppdcfile.html#Version'>Version</a> 1.0
543
544// PostScript printer attributes
545<a href='ref-ppdcfile.html#Attribute'>Attribute</a> DefaultColorSpace "" Gray
546<a href='ref-ppdcfile.html#Attribute'>Attribute</a> LandscapeOrientation "" Minus90
547<a href='ref-ppdcfile.html#Attribute'>Attribute</a> LanguageLevel "" "3"
548<a href='ref-ppdcfile.html#Attribute'>Attribute</a> Product "" "(Foo LaserProofer 2000)"
549<a href='ref-ppdcfile.html#Attribute'>Attribute</a> PSVersion "" "(3010) 0"
550<a href='ref-ppdcfile.html#Attribute'>Attribute</a> TTRasterizer "" Type42
551
552// Supported page sizes
553*<a href='ref-ppdcfile.html#MediaSize'>MediaSize</a> Letter
554<a href='ref-ppdcfile.html#MediaSize'>MediaSize</a> Legal
555<a href='ref-ppdcfile.html#MediaSize'>MediaSize</a> A4
556
557// Query command for page size
558<a href='ref-ppdcfile.html#Attribute'>Attribute</a> "?PageSize" "" "
559 save
560 currentpagedevice /PageSize get aload pop
561 2 copy gt {exch} if (Unknown)
562 23 dict
563 dup [612 792] (Letter) put
564 dup [612 1008] (Legal) put
565 dup [595 842] (A4) put
f3c17241 566 {exch aload pop 4 index sub abs 5 le exch
28b9d139
MS
567 5 index sub abs 5 le and
568 {exch pop exit} {pop} ifelse
569 } bind forall = flush pop pop
570 restore"
571
572// Specify the name of the PPD file we want to generate
573<a href='ref-ppdcfile.html#PCFileName'>PCFileName</a> "fooproof.ppd"
574</pre>
575
576<h3>Required Attributes</h3>
577
578<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>
579
580<pre class='example'>
581<a href='ref-ppdcfile.html#Attribute'>Attribute</a> DefaultColorSpace "" Gray
582<a href='ref-ppdcfile.html#Attribute'>Attribute</a> LandscapeOrientation "" Minus90
583<a href='ref-ppdcfile.html#Attribute'>Attribute</a> LanguageLevel "" "3"
584<a href='ref-ppdcfile.html#Attribute'>Attribute</a> Product "" "(Foo LaserProofer 2000)"
585<a href='ref-ppdcfile.html#Attribute'>Attribute</a> PSVersion "" "(3010) 0"
586<a href='ref-ppdcfile.html#Attribute'>Attribute</a> TTRasterizer "" Type42
587</pre>
588
589<div class='table'><table summary='Required PostScript Printer Driver Attributes'>
590<caption>Table 1: <a name='TABLE_1'>Required PostScript Printer Driver Attributes</a></caption>
591<thead>
592<tr>
593 <th>Attribute</th>
594 <th>Description</th>
595</tr>
596</thead>
597<tbody>
598<tr>
599 <td><tt>DefaultColorSpace</tt></td>
600 <td>The default colorspace:
601 <tt>Gray</tt>, <tt>RGB</tt>, <tt>CMY</tt>, or
602 <tt>CMYK</tt>. If not specified, then <tt>RGB</tt> is
603 assumed.</td>
604</tr>
605<tr>
606 <td><tt>LandscapeOrientation</tt></td>
607 <td>The preferred landscape
608 orientation: <tt>Plus90</tt>, <tt>Minus90</tt>, or
609 <tt>Any</tt>. If not specified, <tt>Plus90</tt> is
610 assumed.</td>
611</tr>
612<tr>
613 <td><tt>LanguageLevel</tt></td>
614 <td>The PostScript language
615 level supported by the device: 1, 2, or 3. If not
616 specified, 2 is assumed.</td>
617</tr>
618<tr>
619 <td><tt>Product</tt></td>
620 <td>The string returned by
621 the PostScript <tt>product</tt> operator, which
622 <i>must</i> include parenthesis to conform with
623 PostScript syntax rules for strings. Multiple
624 <tt>Product</tt> attributes may be specified to support
625 multiple products with the same PPD file. If not
626 specified, "(ESP Ghostscript)" and "(GNU Ghostscript)"
627 are assumed.</td>
628</tr>
629<tr>
630 <td><tt>PSVersion</tt></td>
631 <td>The PostScript
632 interpreter version numbers as returned by the
633 <tt>version</tt> and <tt>revision</tt> operators. The
634 required format is "(version) revision". Multiple
635 <tt>PSVersion</tt> attributes may be specified to
636 support multiple interpreter version numbers. If not
637 specified, "(3010) 705" and "(3010) 707" are
638 assumed.</td>
639</tr>
640<tr>
641 <td><tt>TTRasterizer</tt></td>
642 <td>The type of TrueType
643 font rasterizer supported by the device, if any. The
644 supported values are <tt>None</tt>, <tt>Accept68k</tt>,
645 <tt>Type42</tt>, and <tt>TrueImage</tt>. If not
646 specified, <tt>None</tt> is assumed.</td>
647</tr>
648</table></div>
649
650<h3>Query Commands</h3>
651
652<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>
653
654<pre class='example'>
655<a href='ref-ppdcfile.html#Attribute'>Attribute</a> "?PageSize" "" "
656 save
657 currentpagedevice /PageSize get aload pop
658 2 copy gt {exch} if (Unknown)
659 23 dict
660 dup [612 792] (Letter) put
661 dup [612 1008] (Legal) put
662 dup [595 842] (A4) put
f3c17241 663 {exch aload pop 4 index sub abs 5 le exch
28b9d139
MS
664 5 index sub abs 5 le and
665 {exch pop exit} {pop} ifelse
666 } bind forall = flush pop pop
667 restore"
668</pre>
669
670<p>Query commands can span multiple lines, however no single line may contain more than 255 characters.</p>
671
672<h3><a name='IMPORT'>Importing Existing PPD Files</a></h3>
673
674<P>CUPS includes a utility called <a href='man-ppdi.html'>ppdi(1)</a>
675which allows you to import existing PPD files into the driver information file
676format used by the PPD compiler <a href='man-ppdc.html'>ppdc(1)</a>. Once
677imported, you can modify, localize, and regenerate the PPD files easily. Type
678the following command to import the PPD file <VAR>mydevice.ppd</VAR> into the
679driver information file <VAR>mydevice.drv</VAR>:</P>
680
681<pre class='command'>
682ppdi -o mydevice.drv mydevice.ppd
683</pre>
684
685<P>If you have a whole directory of PPD files that you would like to import,
686you can list multiple filenames or use shell wildcards to import more than one
687PPD file on the command-line:</P>
688
689<pre class='command'>
690ppdi -o mydevice.drv mydevice1.ppd mydevice2.ppd
691ppdi -o mydevice.drv *.ppd
692</pre>
693
694<P>If the driver information file already exists, the new PPD
695file entries are appended to the end of the file. Each PPD file
696is placed in its own group of curly braces within the driver
697information file.</P>
698
699
700<h2 class='title'><a name='FILTERS'>Using Custom Filters</a></h2>
701
702<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>
703
704<pre class='example'>
705<a href='ref-ppdcfile.html#Filter'>Filter</a> application/vnd.cups-postscript 0 -
706</pre>
707
e4572d57
MS
708<h3>Custom Command Filters</h3>
709
710<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>
711
712<pre class='example'>
713<a href='ref-ppdcfile.html#Filter'>Filter</a> application/vnd.cups-command 100 /path/to/command/filter
714</pre>
715
716<p>To use the standard PostScript command filter, specify <var>commandtops</var> as the path to the command filter.</p>
717
718<h3>Custom PDF Filters</h3>
719
720<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>
721
722<pre class='example'>
723<a href='ref-ppdcfile.html#Filter'>Filter</a> application/vnd.cups-pdf 100 /path/to/pdf/filter
724</pre>
725
726<p>For unfiltered PDF files, use:</p>
727
728<pre class='example'>
729<a href='ref-ppdcfile.html#Filter'>Filter</a> application/pdf 100 /path/to/pdf/filter
730</pre>
731
732<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>
733
734<h3>Custom PostScript Filters</h3>
735
736<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>
737
738<pre class='example'>
739<a href='ref-ppdcfile.html#Filter'>Filter</a> application/vnd.cups-postscript 100 /path/to/postscript/filter
740</pre>
741
28b9d139
MS
742
743<h2 class='title'><a name='COLOR'>Implementing Color Management</a></h2>
744
178cb736 745<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>
28b9d139 746
178cb736
MS
747<pre class='example'>
748<a href='ref-ppdcfile.html#Attribute'>Attribute</a> cupsICCProfile "ColorModel.MediaType.Resolution/Description" /path/to/ICC/profile
749</pre>
28b9d139 750
178cb736
MS
751<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>
752
753<pre class='example'>
754<a href='ref-ppdcfile.html#Attribute'>Attribute</a> cupsICCProfile "Gray../Grayscale Profile" /path/to/ICC/gray-profile
755<a href='ref-ppdcfile.html#Attribute'>Attribute</a> cupsICCProfile "RGB../Full Color Profile" /path/to/ICC/rgb-profile
756</pre>
28b9d139 757
178cb736 758<p>The options used for profile selection can be customized using the <tt>cupsICCQualifier2</tt> and <tt>cupsICCQualifier3</tt> attributes.</p>
28b9d139
MS
759
760
8072030b 761<h2 class='title'><a name='MACOSX'>Adding macOS Features</a></h2>
178cb736 762
8072030b 763<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>
28b9d139 764
178cb736
MS
765<pre class='example'>
766<a href='ref-ppdcfile.html#Attribute'>Attribute</a> APDialogExtension "" /Library/Printers/Vendor/filename.plugin
767<a href='ref-ppdcfile.html#Attribute'>Attribute</a> APHelpBook "" /Library/Printers/Vendor/filename.bundle
768<a href='ref-ppdcfile.html#Attribute'>Attribute</a> APPrinterIconPath "" /Library/Printers/Vendor/filename.icns
769<a href='ref-ppdcfile.html#Attribute'>Attribute</a> APPrinterPreset "name/text" "*option choice ..."
770</pre>
abacc52b
MS
771 </div>
772 </body>
28b9d139 773</html>