filter(7)

1filter(7)                   Easy Software Products                   filter(7)
2
3
4

NAME

6       filter - cups file conversion filter interface
7

SYNOPSIS

9       filter job user title num-copies options [ filename ]
10

DESCRIPTION

12       The CUPS filter interface provides a standard method for adding support
13       for new document types to CUPS. Each filter is  capable  of  converting
14       from  one  or  more  input formats to another format that can either be
15       printed directly or piped into another filter to get it to a  printable
16       format.
17
18       Filters  must be capable of reading from a filename on the command-line
19       or from the standard input, copying the standard input to  a  temporary
20       file  as  required  by  the file format. All output must be sent to the
21       standard output.
22
23       The command name (argv[0]) is  set  to  the  name  of  the  destination
24       printer.
25

LOG MESSAGES

27       Messages  sent  to stderr are generally logged to printer-state-message
28       attribute and the current ErrorLog.  Each line begins with  a  standard
29       prefix:
30
31
32       ALERT: message
33            Sets  the  printer-state-message  attribute and adds the specified
34            message to the current ErrorLog using the "alert" log level.
35
36
37       ATTR: attribute=value [attribute=value]
38            Sets the named job attribute(s). Typically this will  be  used  to
39            set the job-remote-id attribute.
40
41
42       CRIT: message
43            Sets  the  printer-state-message  attribute and adds the specified
44            message to the current ErrorLog using the "critical" log level.
45
46
47       DEBUG: message
48            Sets the printer-state-message attribute and  adds  the  specified
49            message to the current ErrorLog using the "debug" log level.
50
51
52       DEBUG2: message
53            Sets  the  printer-state-message  attribute and adds the specified
54            message to the current ErrorLog using the "debug2" log level.
55
56
57       EMERG: message
58            Sets the printer-state-message attribute and  adds  the  specified
59            message to the current ErrorLog using the "emergency" log level.
60
61
62       ERROR: message
63            Sets  the  printer-state-message  attribute and adds the specified
64            message to the current ErrorLog using the "error" log level.
65
66
67       INFO: message
68            Sets the printer-state-message attribute. If the current  LogLevel
69            is set to "debug2", also adds the specified message to the current
70            ErrorLog using the "info" log level.
71
72
73       NOTICE: message
74            Sets the printer-state-message attribute and  adds  the  specified
75            message to the current ErrorLog using the "notice" log level.
76
77
78       PAGE: page-number #-copies
79
80       PAGE: total #-pages
81            Adds an entry to the current PageLog. The first form adds #-copies
82            to the job-media-sheets-completed attribute. The second form  sets
83            the job-media-sheets-completed attribute to #-pages.
84
85
86       STATE: printer-state-reason [printer-state-reason ...]
87
88       STATE: + printer-state-reason [printer-state-reason ...]
89
90       STATE: - printer-state-reason [printer-state-reason ...]
91            Sets,  adds,  or removes printer-state-reason keywords to the cur‐
92            rent queue. Typically this is used to  indicate  media,  ink,  and
93            toner conditions on a printer.
94
95
96       WARNING: message
97            Sets  the  printer-state-message  attribute and adds the specified
98            message to the current ErrorLog using the "warning" log level.
99
100

ENVIRONMENT VARIABLES

102       The following environment variables are defined by the CUPS server when
103       executing the filter:
104
105
106       CHARSET
107            The default text character set, typically utf-8.
108
109
110       CLASS
111            When  a  job is submitted to a printer class, contains the name of
112            the destination printer class. Otherwise this environment variable
113            will not be set.
114
115
116       CONTENT_TYPE
117            The  MIME  type  associated with the file (e.g.  application/post‐
118            script).
119
120
121       CUPS_DATADIR
122            The directory where data files can be found.
123
124
125       CUPS_SERVERROOT
126            The root directory of the server.
127
128
129       DEVICE_URI
130            The device-uri associated with the printer.
131
132
133       FINAL_CONTENT_TYPE
134            The  MIME  type  associated  with  the  printer  (e.g.    applica‐
135            tion/vnd.cups-postscript).
136
137
138       LANG
139            The default language locale (typically C or en).
140
141
142       PATH
143            The  standard execution path for external programs that may be run
144            by the filter.
145
146
147       PPD
148            The full pathname of the PostScript Printer Description (PPD) file
149            for this printer.
150
151
152       PRINTER
153            The name of the printer.
154
155
156       RIP_CACHE
157            The  recommended  amount of memory to use for Raster Image Proces‐
158            sors (RIPs).
159
160
161       SOFTWARE
162            The name and version number of the server (typically CUPS/1.2).
163
164
165       TZ
166            The timezone of the server.
167
168
169       USER
170            The user executing the filter, typically "lp" or  "root";  consult
171            the cupsd.conf(5) file for the current setting.
172
173

COMPATIBILITY

175       While  the  filter  interface  is  compatible  with  System V interface
176       scripts, it will only work with the System V interface  script  as  the
177       only  filter.   Typically the interface script will be provided via the
178       lpadmin(8) command using the -i option.
179

COPYRIGHT

185       Copyright 1997-2006 by Easy Software Products, All Rights Reserved.
186
187
188
1896 July 2007               Common UNIX Printing System                filter(7)