]>
Commit | Line | Data |
---|---|---|
ef416fc2 | 1 | .\" |
bd7854cb | 2 | .\" "$Id: filter.man 5099 2006-02-13 02:46:10Z mike $" |
ef416fc2 | 3 | .\" |
4 | .\" filter man page for the Common UNIX Printing System (CUPS). | |
5 | .\" | |
bd7854cb | 6 | .\" Copyright 1997-2006 by Easy Software Products. |
ef416fc2 | 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 | .\" | |
bd7854cb | 24 | .TH filter 7 "Common UNIX Printing System" "12 February 2006" "Easy Software Products" |
ef416fc2 | 25 | .SH NAME |
bd7854cb | 26 | filter \- cups file conversion filter interface |
ef416fc2 | 27 | .SH SYNOPSIS |
28 | .B filter | |
29 | job user title num-copies options [ | |
30 | .I filename | |
31 | ] | |
32 | .SH DESCRIPTION | |
33 | The CUPS filter interface provides a standard method for adding support for | |
34 | new document types to CUPS. Each filter is capable of converting from one | |
35 | or more input formats to another format that can either be printed directly | |
36 | or piped into another filter to get it to a printable format. | |
37 | .LP | |
bd7854cb | 38 | Filters \fBmust\fR be capable of reading from a filename on the command-line |
ef416fc2 | 39 | or from the standard input, copying the standard input to a temporary |
bd7854cb | 40 | file as required by the file format. All output \fBmust\fR be sent to the |
ef416fc2 | 41 | standard output. |
42 | .LP | |
43 | The command name (argv[0]) is set to the name of the destination printer. | |
bd7854cb | 44 | .SH LOG MESSAGES |
45 | Messages sent to stderr are generally logged to | |
46 | printer-state-message attribute and the current \fIErrorLog\fR. | |
47 | Each line begins with a standard prefix: | |
48 | ||
49 | .TP 5 | |
50 | ALERT: message | |
51 | .br | |
52 | Sets the printer-state-message attribute and adds the specified | |
53 | message to the current \fIErrorLog\fR using the "alert" log level. | |
54 | ||
55 | .TP 5 | |
56 | ATTR: attribute=value [attribute=value] | |
57 | .br | |
58 | Sets the named job attribute(s). Typically this will be used to | |
59 | set the job-remote-id attribute. | |
60 | ||
61 | .TP 5 | |
62 | CRIT: message | |
63 | .br | |
64 | Sets the printer-state-message attribute and adds the specified | |
65 | message to the current \fIErrorLog\fR using the "critical" log level. | |
66 | ||
67 | .TP 5 | |
68 | DEBUG: message | |
69 | .br | |
70 | Sets the printer-state-message attribute and adds the specified | |
71 | message to the current \fIErrorLog\fR using the "debug" log level. | |
72 | ||
73 | .TP 5 | |
74 | DEBUG2: message | |
75 | .br | |
76 | Sets the printer-state-message attribute and adds the specified | |
77 | message to the current \fIErrorLog\fR using the "debug2" log level. | |
78 | ||
79 | .TP 5 | |
80 | EMERG: message | |
81 | .br | |
82 | Sets the printer-state-message attribute and adds the specified | |
83 | message to the current \fIErrorLog\fR using the "emergency" log level. | |
84 | ||
85 | .TP 5 | |
86 | ERROR: message | |
87 | .br | |
88 | Sets the printer-state-message attribute and adds the specified | |
89 | message to the current \fIErrorLog\fR using the "error" log level. | |
90 | ||
91 | .TP 5 | |
92 | INFO: message | |
93 | .br | |
94 | Sets the printer-state-message attribute. If the current \fILogLevel\fR | |
95 | is set to "debug2", also adds the specified message to the | |
96 | current \fIErrorLog\fR using the "info" log level. | |
97 | ||
98 | .TP 5 | |
99 | NOTICE: message | |
100 | .br | |
101 | Sets the printer-state-message attribute and adds the specified | |
102 | message to the current \fIErrorLog\fR using the "notice" log level. | |
103 | ||
104 | .TP 5 | |
105 | PAGE: page-number #-copies | |
106 | .TP 5 | |
107 | PAGE: #-pages total | |
108 | .br | |
109 | Adds an entry to the current \fIPageLog\fR. The first form adds | |
110 | #-copies to the job-media-sheets-completed attribute. The second | |
111 | form sets the job-media-sheets-completed attribute to #-pages. | |
112 | ||
113 | .TP 5 | |
114 | STATE: printer-state-reason [printer-state-reason ...] | |
115 | .TP 5 | |
116 | STATE: + printer-state-reason [printer-state-reason ...] | |
117 | .TP 5 | |
118 | STATE: - printer-state-reason [printer-state-reason ...] | |
119 | .br | |
120 | Sets, adds, or removes printer-state-reason keywords to the | |
121 | current queue. Typically this is used to indicate media, ink, and | |
122 | toner conditions on a printer. | |
123 | ||
124 | .TP 5 | |
125 | WARNING: message | |
126 | .br | |
127 | Sets the printer-state-message attribute and adds the specified | |
128 | message to the current \fIErrorLog\fR using the "warning" log level. | |
129 | ||
ef416fc2 | 130 | .SH ENVIRONMENT VARIABLES |
bd7854cb | 131 | The following environment variables are defined by the CUPS |
132 | server when executing the backend: | |
133 | ||
ef416fc2 | 134 | .TP 5 |
135 | CHARSET | |
136 | .br | |
bd7854cb | 137 | The default text character set, typically utf-8. |
138 | ||
ef416fc2 | 139 | .TP 5 |
140 | CLASS | |
141 | .br | |
142 | When a job is submitted to a printer class, contains the name of | |
143 | the destination printer class. Otherwise this environment | |
144 | variable will not be set. | |
bd7854cb | 145 | |
ef416fc2 | 146 | .TP 5 |
147 | CONTENT_TYPE | |
148 | .br | |
bd7854cb | 149 | The MIME type associated with the file (e.g. |
150 | application/postscript). | |
151 | ||
ef416fc2 | 152 | .TP 5 |
153 | CUPS_DATADIR | |
154 | .br | |
155 | The directory where data files can be found. | |
bd7854cb | 156 | |
ef416fc2 | 157 | .TP 5 |
158 | CUPS_SERVERROOT | |
159 | .br | |
160 | The root directory of the server. | |
bd7854cb | 161 | |
ef416fc2 | 162 | .TP 5 |
163 | DEVICE_URI | |
164 | .br | |
bd7854cb | 165 | The device-uri associated with the printer; this is provided for |
166 | shell scripts which may not be able to get the passed argv[0] | |
167 | string and for backends that require any authentication | |
168 | information which is not included in argv[0]. | |
169 | ||
170 | .TP 5 | |
171 | FINAL_CONTENT_TYPE | |
172 | .br | |
173 | The MIME type associated with the printer (e.g. | |
174 | application/vnd.cups-postscript). | |
175 | ||
ef416fc2 | 176 | .TP 5 |
177 | LANG | |
178 | .br | |
179 | The default language locale (typically C or en). | |
bd7854cb | 180 | |
ef416fc2 | 181 | .TP 5 |
182 | PATH | |
183 | .br | |
bd7854cb | 184 | The standard execution path for external programs that may be run by |
185 | the backend. | |
186 | ||
ef416fc2 | 187 | .TP 5 |
188 | PPD | |
189 | .br | |
bd7854cb | 190 | The full pathname of the PostScript Printer Description (PPD) |
191 | file for this printer. | |
192 | ||
ef416fc2 | 193 | .TP 5 |
194 | PRINTER | |
195 | .br | |
bd7854cb | 196 | The name of the printer. |
197 | ||
ef416fc2 | 198 | .TP 5 |
199 | RIP_CACHE | |
200 | .br | |
bd7854cb | 201 | The recommended amount of memory to use for Raster Image |
202 | Processors (RIPs). | |
203 | ||
ef416fc2 | 204 | .TP 5 |
205 | SOFTWARE | |
206 | .br | |
bd7854cb | 207 | The name and version number of the server (typically CUPS/1.2). |
208 | ||
ef416fc2 | 209 | .TP 5 |
210 | TZ | |
211 | .br | |
212 | The timezone of the server. | |
bd7854cb | 213 | |
ef416fc2 | 214 | .TP 5 |
215 | USER | |
216 | .br | |
bd7854cb | 217 | The user executing the backend, typically root; consult the |
218 | \fIcupsd.conf(5)\fR file for the current setting. | |
219 | ||
ef416fc2 | 220 | .SH COMPATIBILITY |
221 | While the filter interface is compatible with System V interface | |
222 | scripts, it will only work with the System V interface script as the | |
223 | only filter. Typically the interface script will be provided via the | |
bd7854cb | 224 | \fIlpadmin(8)\fR command using the \fI-i\fR option. |
ef416fc2 | 225 | .SH SEE ALSO |
bd7854cb | 226 | \fIbackend(1)\fR, \fIcupsd(8)\fR, |
227 | .br | |
228 | http://localhost:631/help | |
ef416fc2 | 229 | .SH COPYRIGHT |
bd7854cb | 230 | Copyright 1997-2006 by Easy Software Products, All Rights Reserved. |
ef416fc2 | 231 | .\" |
bd7854cb | 232 | .\" End of "$Id: filter.man 5099 2006-02-13 02:46:10Z mike $". |
ef416fc2 | 233 | .\" |