man/filter.man

   1 .\"
   2 .\" "$Id: filter.man,v 1.7 2002/01/02 17:59:06 mike Exp $"
   3 .\"
   4 .\"   filter man page for the Common UNIX Printing System (CUPS).
   5 .\"
   6 .\"   Copyright 1997-2002 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-3111 USA
  19 .\"
  20 .\"       Voice: (301) 373-9603
  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 CONTENT_TYPE
  53 .br
  54 The MIME type associated with the file (e.g. application/postscript).
  55 .TP 5
  56 CUPS_DATADIR
  57 .br
  58 The directory where data files can be found.
  59 .TP 5
  60 CUPS_SERVERROOT
  61 .br
  62 The root directory of the server.
  63 .TP 5
  64 DEVICE_URI
  65 .br
  66 The device-uri associated with the printer.
  67 .TP 5
  68 LANG
  69 .br
  70 The default language locale (typically C or en).
  71 .TP 5
  72 PATH
  73 .br
  74 The standard execution path for external programs that may be run by the filter.
  75 .TP 5
  76 PPD
  77 .br
  78 The full pathname of the PostScript Printer Description (PPD) file for
  79 this printer.
  80 .TP 5
  81 PRINTER
  82 .br
  83 The name of the printer; this is provided for shell scripts which may not be
  84 able to get the passed argv[0] string.
  85 .TP 5
  86 RIP_CACHE
  87 .br
  88 The recommended amount of memory to use for Raster Image Processors (RIPs).
  89 .TP 5
  90 SOFTWARE
  91 .br
  92 The name and version number of the server (typically CUPS/1.1).
  93 .TP 5
  94 TZ
  95 .br
  96 The timezone of the server.
  97 .TP 5
  98 USER
  99 .br
 100 The user executing the filter (typically lp).
 101 .SH COMPATIBILITY
 102 While the filter interface is compatible with System V interface
 103 scripts, it will only work with the System V interface script as the
 104 only filter.  Typically the interface script will be provided via the
 105 \fBlpadmin(8)\fR command using the \fI-i\fR option.
 106 .SH SEE ALSO
 107 backend(1), cupsd(8),
 108 CUPS Interface Design Description,
 109 CUPS Software Administrators Manual,
 110 CUPS Software Programmers Manual,
 111 http://localhost:631/documentation.html
 112 .SH COPYRIGHT
 113 Copyright 1993-2002 by Easy Software Products, All Rights Reserved.
 114 .\"
 115 .\" End of "$Id: filter.man,v 1.7 2002/01/02 17:59:06 mike Exp $".
 116 .\"