man/filter.man

   1 .\"
   2 .\" "$Id: filter.man 4493 2005-02-18 02:09:53Z mike $"
   3 .\"
   4 .\"   filter man page for the Common UNIX Printing System (CUPS).
   5 .\"
   6 .\"   Copyright 1997-2005 by Easy Software Products.
   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 .\"
  24 .TH filter 1 "Common UNIX Printing System" "22 June 2000" "Easy Software Products"
  25 .SH NAME
  26 filter \- cups file conversion filter interfaces
  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
  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
  41 standard output.
  42 .LP
  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:
  47 .TP 5
  48 CHARSET
  49 .br
  50 The default text character set (typically us-ascii or iso-8859-1).
  51 .TP 5
  52 CLASS
  53 .br
  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.
  57 .TP 5
  58 CONTENT_TYPE
  59 .br
  60 The MIME type associated with the file (e.g. application/postscript).
  61 .TP 5
  62 CUPS_DATADIR
  63 .br
  64 The directory where data files can be found.
  65 .TP 5
  66 CUPS_SERVERROOT
  67 .br
  68 The root directory of the server.
  69 .TP 5
  70 DEVICE_URI
  71 .br
  72 The device-uri associated with the printer.
  73 .TP 5
  74 LANG
  75 .br
  76 The default language locale (typically C or en).
  77 .TP 5
  78 PATH
  79 .br
  80 The standard execution path for external programs that may be run by the filter.
  81 .TP 5
  82 PPD
  83 .br
  84 The full pathname of the PostScript Printer Description (PPD) file for
  85 this printer.
  86 .TP 5
  87 PRINTER
  88 .br
  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.
  91 .TP 5
  92 RIP_CACHE
  93 .br
  94 The recommended amount of memory to use for Raster Image Processors (RIPs).
  95 .TP 5
  96 SOFTWARE
  97 .br
  98 The name and version number of the server (typically CUPS/1.1).
  99 .TP 5
 100 TZ
 101 .br
 102 The timezone of the server.
 103 .TP 5
 104 USER
 105 .br
 106 The user executing the filter, typically lp; consult the cupsd.conf file for
 107 the current setting.
 108 .SH COMPATIBILITY
 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.
 113 .SH SEE ALSO
 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
 119 .SH COPYRIGHT
 120 Copyright 1993-2005 by Easy Software Products, All Rights Reserved.
 121 .\"
 122 .\" End of "$Id: filter.man 4493 2005-02-18 02:09:53Z mike $".
 123 .\"