]>
Commit | Line | Data |
---|---|---|
bd7854cb | 1 | .\" |
f7faf1f5 | 2 | .\" "$Id: cups-driverd.man.in 5099 2006-02-13 02:46:10Z mike $" |
bd7854cb | 3 | .\" |
4 | .\" cups-driverd man page for the Common UNIX Printing System (CUPS). | |
5 | .\" | |
6 | .\" Copyright 1997-2006 by Easy Software Products. | |
7 | .\" | |
8 | .\" These coded instructions, statements, and computer programs are the | |
9 | .\" property of Easy Software Products and are protected by Federal | |
10 | .\" copyright law. Distribution and use rights are outlined in the file | |
11 | .\" "LICENSE.txt" which should have been included with this file. If this | |
12 | .\" file is missing or damaged please contact Easy Software Products | |
13 | .\" at: | |
14 | .\" | |
15 | .\" Attn: CUPS Licensing Information | |
16 | .\" Easy Software Products | |
17 | .\" 44141 Airport View Drive, Suite 204 | |
18 | .\" Hollywood, Maryland 20636 USA | |
19 | .\" | |
20 | .\" Voice: (301) 373-9600 | |
21 | .\" EMail: cups-info@cups.org | |
22 | .\" WWW: http://www.cups.org | |
23 | .\" | |
24 | .TH cups-driverd 8 "Common UNIX Printing System" "12 February 2006" "Easy Software Products" | |
25 | .SH NAME | |
26 | cups-driverd \- cups driver daemon | |
27 | .SH SYNOPSIS | |
28 | .B cups-driverd | |
29 | cat | |
30 | .I ppd-name | |
31 | .br | |
32 | .B cups-driverd | |
33 | list | |
34 | .I request_id limit options | |
35 | .SH DESCRIPTION | |
36 | \fIcups-driverd\fR shows or lists PPD files. It is run in | |
37 | response to CUPS-Add-Modify-Printer or CUPS-Get-Devices requests. | |
38 | The first form ("cups-driverd cat ppd-name") writes the named PPD | |
39 | file to stdout. The output format is an uncompressed PPD file. | |
40 | .LP | |
41 | The second form lists the available manufacturers or PPD files to | |
42 | stdout as indicated by the \fIoptions\fR argument. The output | |
43 | format is an IPP response message. The \fIrequest_id\fR argument | |
44 | is the request ID from the original IPP request, typically 1. The | |
45 | \Ilimit\fR argument is the limit value from the original IPP | |
46 | request - 0 means no limit. Finally, the \fIoptions\fR argument | |
47 | is a space-delimited list of attributes ("name=value name=value | |
48 | \...") that were passed in with the request. Currently | |
49 | \fIcups-driverd\fR looks for the \fIppd-make\fR and | |
50 | \fIrequested-attributes\fR attributes and tailors the output | |
51 | accordingly. | |
52 | .SH DRIVERS | |
53 | Drivers can be static PPD files under the | |
54 | \fI@CUPS_DATADIR@/model\fR directory or programs under the | |
55 | \fI@CUPS_SERVERBIN@/driver\fR directory. Static PPD files must | |
56 | conform to the Adobe PPD File Format Specification version 4.3 | |
57 | and may be compressed using the \fIgzip(1)\fR program. Driver | |
58 | programs must implement the command-line interface shown in the | |
59 | next section. | |
60 | .Sh DRIVER PROGRAMS | |
61 | Driver programs provide an interface to dynamically-generated PPD | |
62 | files. The following arguments are currently defined: | |
63 | .TP 5 | |
64 | drivername list | |
65 | .br | |
66 | Lists the supported PPD files to stdout. | |
67 | .TP 5 | |
68 | drivername cat ppdname | |
69 | .br | |
70 | Writes the named PPD file to stdout. | |
71 | .Sh LISTING FILES (drivername list) | |
72 | When run with the single argument "list", the program must list | |
73 | the available PPD files it can generate to stdout using the | |
74 | following format: | |
75 | .nf | |
76 | "drivername:ppdname" language "make" "make and model" "1284 device id" | |
77 | .fi | |
78 | .LP | |
79 | \fIDrivername\fR is the name of the driver program. \fIPpdname\fR | |
80 | is the name used to select the given driver. \fILanguage\fR is | |
81 | the locale associated with the default language of the PPD file, | |
82 | typically "en". \fIMake\fR is the Manufacturer name from the PPD | |
83 | file. \fIMake and model\fR is the NickName name from the PPD | |
84 | file. \fI1284 device id\fR is the 1284DeviceId from the PPD file, | |
85 | if any. | |
86 | .Sh WRITING FILES (drivername cat ppdname) | |
87 | When the driver program is run with the "cat ppdname" arguments, | |
88 | it must write the named PPD file to stdout, uncompressed. If the | |
89 | named PPD file does not exist, the driver program must not write | |
90 | any output to stdout and report the error to stderr instead. | |
91 | .Sh DRIVER ERROR MESSAGES | |
92 | Error messages can be relayed back to \fIcupsd\fR by writing them | |
93 | to stderr. The following prefixes are recognized: | |
94 | .TP 5 | |
95 | DEBUG: [drivername] | |
96 | .br | |
97 | Debugging messages | |
98 | .TP 5 | |
99 | ERROR: [drivername] | |
100 | .br | |
101 | Error messages | |
102 | .TP 5 | |
103 | INFO: [drivername] | |
104 | .br | |
105 | Informational messages | |
106 | .SH SEE ALSO | |
107 | cupsd(8), cupsd.conf(5), cupstestppd(1), | |
108 | .br | |
109 | http://localhost:631/help | |
110 | .SH COPYRIGHT | |
111 | Copyright 1997-2006 by Easy Software Products, All Rights Reserved. | |
112 | .\" | |
f7faf1f5 | 113 | .\" End of "$Id: cups-driverd.man.in 5099 2006-02-13 02:46:10Z mike $". |
bd7854cb | 114 | .\" |