2 .\" "$Id: filter.man 6649 2007-07-11 21:46:42Z mike $"
4 .\" filter man page for the Common UNIX Printing System (CUPS).
6 .\" Copyright 2007-2008 by Apple Inc.
7 .\" Copyright 1997-2007 by Easy Software Products.
9 .\" These coded instructions, statements, and computer programs are the
10 .\" property of Apple Inc. and are protected by Federal copyright
11 .\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 .\" which should have been included with this file. If this file is
13 .\" file is missing or damaged, see the license at "http://www.cups.org/".
15 .TH filter 7 "Common UNIX Printing System" "14 May 2008" "Apple Inc."
17 filter \- cups file conversion filter interface
20 job user title num-copies options [
24 The CUPS filter interface provides a standard method for adding support for
25 new document types to CUPS. Each filter is capable of converting from one
26 or more input formats to another format that can either be printed directly
27 or piped into another filter to get it to a printable format.
29 Filters \fBmust\fR be capable of reading from a filename on the command-line
30 or from the standard input, copying the standard input to a temporary
31 file as required by the file format. All output \fBmust\fR be sent to the
34 The command name (argv[0]) is set to the name of the destination printer.
36 Messages sent to stderr are generally logged to
37 printer-state-message attribute and the current \fIErrorLog\fR.
38 Each line begins with a standard prefix:
43 Sets the printer-state-message attribute and adds the specified
44 message to the current \fIErrorLog\fR using the "alert" log level.
47 ATTR: attribute=value [attribute=value]
49 Sets the named job attribute(s). Typically this will be used to
50 set the job-remote-id attribute.
55 Sets the printer-state-message attribute and adds the specified
56 message to the current \fIErrorLog\fR using the "critical" log level.
61 Sets the printer-state-message attribute and adds the specified
62 message to the current \fIErrorLog\fR using the "debug" log level.
67 Sets the printer-state-message attribute and adds the specified
68 message to the current \fIErrorLog\fR using the "debug2" log level.
73 Sets the printer-state-message attribute and adds the specified
74 message to the current \fIErrorLog\fR using the "emergency" log level.
79 Sets the printer-state-message attribute and adds the specified
80 message to the current \fIErrorLog\fR using the "error" log level.
85 Sets the printer-state-message attribute. If the current \fILogLevel\fR
86 is set to "debug2", also adds the specified message to the
87 current \fIErrorLog\fR using the "info" log level.
92 Sets the printer-state-message attribute and adds the specified
93 message to the current \fIErrorLog\fR using the "notice" log level.
96 PAGE: page-number #-copies
100 Adds an entry to the current \fIPageLog\fR. The first form adds
101 #-copies to the job-media-sheets-completed attribute. The second
102 form sets the job-media-sheets-completed attribute to #-pages.
105 PPD: Keyword=Value ... KeywordN=Value
107 Sets the named keywords in the printer's PPD file. This is typically
108 used to update default option keywords such as DefaultPageSize and
109 the various installable options in the PPD file.
112 STATE: printer-state-reason [printer-state-reason ...]
114 STATE: + printer-state-reason [printer-state-reason ...]
116 STATE: - printer-state-reason [printer-state-reason ...]
118 Sets, adds, or removes printer-state-reason keywords to the
119 current queue. Typically this is used to indicate media, ink, and
120 toner conditions on a printer.
125 Sets the printer-state-message attribute and adds the specified
126 message to the current \fIErrorLog\fR using the "warning" log level.
128 .SH ENVIRONMENT VARIABLES
129 The following environment variables are defined by the CUPS
130 server when executing the filter:
135 The default text character set, typically utf-8.
140 When a job is submitted to a printer class, contains the name of
141 the destination printer class. Otherwise this environment
142 variable will not be set.
147 The MIME type associated with the file (e.g.
148 application/postscript).
153 The directory where data files can be found.
158 The root directory of the server.
163 The device-uri associated with the printer.
168 The MIME type associated with the printer (e.g.
169 application/vnd.cups-postscript).
174 The default language locale (typically C or en).
179 The standard execution path for external programs that may be run by
185 The full pathname of the PostScript Printer Description (PPD)
186 file for this printer.
191 The name of the printer.
196 The recommended amount of memory to use for Raster Image
202 The name and version number of the server (typically CUPS/1.2).
207 The timezone of the server.
212 The user executing the filter, typically "lp" or "root"; consult the
213 \fIcupsd.conf(5)\fR file for the current setting.
216 While the filter interface is compatible with System V interface
217 scripts, it will only work with the System V interface script as the
218 only filter. Typically the interface script will be provided via the
219 \fIlpadmin(8)\fR command using the \fI-i\fR option.
221 \fIbackend(1)\fR, \fIcupsd(8)\fR,
223 http://localhost:631/help
225 Copyright 2007 by Apple Inc.
227 .\" End of "$Id: filter.man 6649 2007-07-11 21:46:42Z mike $".