4 .\" filter man page for the Common UNIX Printing System (CUPS).
6 .\" Copyright 1997-2005 by Easy Software Products.
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
15 .\" Attn: CUPS Licensing Information
16 .\" Easy Software Products
17 .\" 44141 Airport View Drive, Suite 204
18 .\" Hollywood, Maryland 20636 USA
20 .\" Voice: (301) 373-9600
21 .\" EMail: cups-info@cups.org
22 .\" WWW: http://www.cups.org
24 .TH filter 1 "Common UNIX Printing System" "22 June 2000" "Easy Software Products"
26 filter \- cups file conversion filter interfaces
29 job user title num-copies options [
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.
38 Filters must be capable of reading from a filename on the command-line
39 or from the standard input, copying the standard input to a temporary
40 file as required by the file format. All output must be sent to the
43 The command name (argv[0]) is set to the name of the destination printer.
44 .SH ENVIRONMENT VARIABLES
45 The following environment variables are defined by the CUPS server when
46 executing each filter:
50 The default text character set (typically us-ascii or iso-8859-1).
54 When a job is submitted to a printer class, contains the name of
55 the destination printer class. Otherwise this environment
56 variable will not be set.
60 The MIME type associated with the file (e.g. application/postscript).
64 The directory where data files can be found.
68 The root directory of the server.
72 The device-uri associated with the printer.
76 The default language locale (typically C or en).
80 The standard execution path for external programs that may be run by the filter.
84 The full pathname of the PostScript Printer Description (PPD) file for
89 The name of the printer; this is provided for shell scripts which may not be
90 able to get the passed argv[0] string.
94 The recommended amount of memory to use for Raster Image Processors (RIPs).
98 The name and version number of the server (typically CUPS/1.1).
102 The timezone of the server.
106 The user executing the filter, typically lp; consult the cupsd.conf file for
109 While the filter interface is compatible with System V interface
110 scripts, it will only work with the System V interface script as the
111 only filter. Typically the interface script will be provided via the
112 \fBlpadmin(8)\fR command using the \fI-i\fR option.
114 backend(1), cupsd(8),
115 CUPS Interface Design Description,
116 CUPS Software Administrators Manual,
117 CUPS Software Programmers Manual,
118 http://localhost:631/documentation.html
120 Copyright 1993-2005 by Easy Software Products, All Rights Reserved.