]>
Commit | Line | Data |
---|---|---|
c277f98c | 1 | <!DOCTYPE HTML> |
94436c5a MS |
2 | <html> |
3 | <!-- SECTION: Man Pages --> | |
4 | <head> | |
5 | <link rel="stylesheet" type="text/css" href="../cups-printable.css"> | |
6 | <title>cups-driverd(8)</title> | |
7 | </head> | |
8 | <body> | |
9 | <h1 class="title">cups-driverd(8)</h1> | |
10 | <h2 class="title"><a name="NAME">Name</a></h2> | |
11 | cups-driverd - cups driver daemon | |
12 | <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2> | |
c277f98c MS |
13 | <b>cups-driverd</b> |
14 | cat | |
15 | <i>ppd-name</i> | |
16 | <br> | |
17 | <b>cups-driverd</b> | |
18 | list | |
19 | <i>request_id</i> <i>limit</i> <i>options</i> | |
20 | <h2 class="title"><a name="DESCRIPTION">Description</a></h2> | |
94436c5a MS |
21 | <i>cups-driverd</i> shows or lists PPD files. It is run in |
22 | response to CUPS-Add-Modify-Printer or CUPS-Get-Devices requests. | |
23 | The first form ("cups-driverd cat ppd-name") writes the named PPD | |
24 | file to stdout. The output format is an uncompressed PPD file. | |
25 | <p>The second form lists the available manufacturers or PPD files to | |
26 | stdout as indicated by the <i>options</i> argument. The output | |
27 | format is an IPP response message. The <i>request_id</i> argument | |
28 | is the request ID from the original IPP request, typically 1. The | |
29 | <i>limit</i> argument is the limit value from the original IPP | |
30 | request - 0 means no limit. Finally, the <i>options</i> argument | |
31 | is a space-delimited list of attributes ("name=value name=value | |
c277f98c | 32 | &...") that were passed in with the request. Currently |
94436c5a MS |
33 | <i>cups-driverd</i> looks for the <i>ppd-make</i> and |
34 | <i>requested-attributes</i> attributes and tailors the output | |
35 | accordingly. | |
36 | <h2 class="title"><a name="DRIVERS">Drivers</a></h2> | |
37 | Drivers can be static PPD files under the | |
38 | <i>/usr/share/cups/model</i> directory or programs under the | |
ffa2ca90 MS |
39 | <i>/usr/lib/cups/driver</i> or <i>/usr/libexec/cups/driver</i> (OS X) directories. |
40 | Static PPD files must conform to the Adobe PPD File Format Specification version | |
41 | 4.3 and may be compressed using the <i>gzip(1)</i> program. Driver | |
94436c5a MS |
42 | programs must implement the command-line interface shown in the |
43 | next section. | |
44 | <h3><a name="DRIVER_PROGRAMS">Driver Programs</a></h3> | |
45 | Driver programs provide a interface to dynamically-generated PPD | |
46 | files. The following arguments are currently defined: | |
c277f98c MS |
47 | <p style="margin-left: 5.0em; text-indent: -5.0em">drivername list |
48 | <br> | |
49 | <br> | |
50 | Lists the supported PPD files to stdout. | |
51 | <p style="margin-left: 5.0em; text-indent: -5.0em">drivername cat ppdname | |
52 | <br> | |
53 | <br> | |
54 | Writes the named PPD file to stdout. | |
94436c5a MS |
55 | <p>Driver programs MUST NOT query hardware or make other long-term operations that |
56 | would delay the return of a driver list. See the NOTES section below for | |
57 | specific recommendations. | |
c277f98c | 58 | <h3><a name="LISTING_FILES__drivername_list_">Listing Files (drivername list)</a></h3> |
94436c5a MS |
59 | When run with the single argument "list", the program must list |
60 | the available PPD files it can generate to stdout using the | |
61 | following format: | |
62 | <pre> | |
63 | "drivername:ppdname" language "make" "make and model" | |
64 | "drivername:ppdname" language "make" "make and model" "1284 device id" | |
65 | "drivername:ppdname" language "make" "make and model" "1284 device id" "(PPD product)" | |
66 | "drivername:ppdname" language "make" "make and model" "1284 device id" "(PPD product)" "PostScript version" | |
67 | "drivername:ppdname" language "make" "make and model" "1284 device id" "(PPD product)" "PostScript version" "type" | |
68 | </pre> | |
69 | <p><i>Drivername</i> is the name of the driver program. <i>Ppdname</i> | |
70 | is the name used to select the given driver. <i>Language</i> is | |
71 | the locale associated with the default language of the PPD file, | |
72 | typically "en". <i>Make</i> is the Manufacturer name from the PPD | |
73 | file. <i>Make and model</i> is the NickName name from the PPD | |
74 | file. <i>1284 device id</i> is the 1284DeviceId from the PPD file, | |
75 | if any. <i>(PPD product)</i> is the Product string as it would appear in the PPD | |
76 | file or from a PostScript query. <i>PostScript version</i> is the PSVersion | |
77 | string as it would appear in the PPD file or from a PostScript query. <i>Type</i> | |
78 | is "postscript" for PostScript printers, "pdf" for PDF printers, "raster" for | |
79 | raster printers, or "fax" for facsimile devices. | |
c277f98c | 80 | <h3><a name="WRITING_FILES__drivername_cat_ppdname_">Writing Files (drivername cat ppdname)</a></h3> |
94436c5a MS |
81 | When the driver program is run with the "cat ppdname" arguments, |
82 | it must write the named PPD file to stdout, uncompressed. If the | |
83 | named PPD file does not exist, the driver program must not write | |
84 | any output to stdout and report the error to stderr instead. | |
85 | <h3><a name="DRIVER_ERROR_MESSAGES">Driver Error Messages</a></h3> | |
86 | Error messages can be relayed back to <i>cupsd</i> by writing them | |
87 | to stderr. The following prefixes are recognized: | |
c277f98c MS |
88 | <p style="margin-left: 5.0em; text-indent: -5.0em">DEBUG: [drivername] |
89 | <br> | |
90 | <br> | |
91 | Debugging messages | |
92 | <p style="margin-left: 5.0em; text-indent: -5.0em">ERROR: [drivername] | |
93 | <br> | |
94 | <br> | |
95 | Error messages | |
96 | <p style="margin-left: 5.0em; text-indent: -5.0em">INFO: [drivername] | |
97 | <br> | |
98 | <br> | |
99 | Informational messages | |
94436c5a MS |
100 | <h2 class="title"><a name="NOTES">Notes</a></h2> |
101 | Due to performance considerations, driver programs have been officially | |
102 | deprecated and should not be used for new development. Currently only the | |
c277f98c | 103 | CUPS web interface and <i>lpinfo(8)</i> command will request lists from all |
94436c5a MS |
104 | driver programs. |
105 | <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> | |
106 | cupsd(8), cupsd.conf(5), cupstestppd(1), lpinfo(8), | |
107 | <br> | |
c277f98c | 108 | <a href="http://localhost:631/help">http://localhost:631/help</a> |
94436c5a MS |
109 | <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> |
110 | Copyright 2007-2013 by Apple Inc. | |
111 | ||
112 | </body> | |
113 | </html> |