filter(1) Easy Software Products filter(1)
filter - cups file conversion filter interfaces
filter job user title num-copies options [ filename ]
The CUPS filter interface provides a standard method for adding support
for new document types to CUPS. Each filter is capable of converting
from one or more input formats to another format that can either be
printed directly or piped into another filter to get it to a printable
Filters must be capable of reading from a filename on the command-line
or from the standard input, copying the standard input to a temporary
file as required by the file format. All output must be sent to the
The command name (argv) is set to the name of the destination
The following environment variables are defined by the CUPS server when
executing each filter:
The default text character set (typically us-ascii or iso-8859-1).
When a job is submitted to a printer class, contains the name of
the destination printer class. Otherwise this environment variable
will not be set.
The MIME type associated with the file (e.g. applica-
The directory where data files can be found.
The root directory of the server.
The device-uri associated with the printer.
The default language locale (typically C or en).
The standard execution path for external programs that may be run
by the filter.
The full pathname of the PostScript Printer Description (PPD) file
for this printer.
The name of the printer; this is provided for shell scripts which
may not be able to get the passed argv string.
The recommended amount of memory to use for Raster Image Proces-
The name and version number of the server (typically CUPS/1.1).
The timezone of the server.
The user executing the filter, typically lp; consult the
cupsd.conf file for the current setting.
While the filter interface is compatible with System V interface
scripts, it will only work with the System V interface script as the
only filter. Typically the interface script will be provided via the
lpadmin(8) command using the -i option.
backend(1), cupsd(8), CUPS Interface Design Description, CUPS Software
Administrators Manual, CUPS Software Programmers Manual, http://local-
Copyright 1993-2005 by Easy Software Products, All Rights Reserved.
22 June 2000 Common UNIX Printing System filter(1)
Man(1) output converted with