doc/help/man-cupsfilter.html

   1 <!DOCTYPE HTML>
   2 <html>
   3 <!-- SECTION: Man Pages -->
   4 <head>
   5         <link rel="stylesheet" type="text/css" href="../cups-printable.css">
   6         <title>cupsfilter(8)</title>
   7 </head>
   8 <body>
   9 <h1 class="title">cupsfilter(8)</h1>
  10 <h2 class="title"><a name="NAME">Name</a></h2>
  11 cupsfilter - convert a file to another format using cups filters (deprecated)
  12 <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
  13 <b>cupsfilter</b>
  14 [
  15 <b>--list-filters</b>
  16 ] [
  17 <b>-D</b>
  18 ] [
  19 <b>-U</b>
  20 <i>user</i>
  21 ] [
  22 <b>-c</b>
  23 <i>config-file</i>
  24 ] [
  25 <b>-d</b>
  26 <i>printer</i>
  27 ] [
  28 <b>-e</b>
  29 ] [
  30 <b>-i</b>
  31 <i>mime/type</i>
  32 ] [
  33 <b>-j</b>
  34 <i>job-id[,N]</i>
  35 ] [
  36 <b>-m</b>
  37 <i>mime/type</i>
  38 ] [
  39 <b>-n</b>
  40 <i>copies</i>
  41 ] [
  42 <b>-o</b>
  43 <i>name=value</i>
  44 ] [
  45 <b>-p</b>
  46 <i>filename.ppd</i>
  47 ] [
  48 <b>-t</b>
  49 <i>title</i>
  50 ] [
  51 <b>-u</b>
  52 ]
  53 <i>filename</i>
  54 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
  55 <b>cupsfilter</b>
  56 is a front-end to the CUPS filter subsystem which allows you to convert a file to a specific format, just as if you had printed the file through CUPS. By default,
  57 <b>cupsfilter</b>
  58 generates a PDF file. The converted file is sent to the standard output.
  59 <h2 class="title"><a name="OPTIONS">Options</a></h2>
  60 <dl class="man">
  61 <dt><b>--list-filters</b>
  62 <dd style="margin-left: 5.0em">Do not actually run the filters, just print the filters used to stdout.
  63 <dt><b>-D</b>
  64 <dd style="margin-left: 5.0em">Delete the input file after conversion.
  65 <dt><b>-U </b><i>user</i>
  66 <dd style="margin-left: 5.0em">Specifies the username passed to the filters. The default is the name of the current user.
  67 <dt><b>-c </b><i>config-file</i>
  68 <dd style="margin-left: 5.0em">Uses the named cups-files.conf configuration file.
  69 <dt><b>-d </b><i>printer</i>
  70 <dd style="margin-left: 5.0em">Uses information from the named printer.
  71 <dt><b>-e</b>
  72 <dd style="margin-left: 5.0em">Use every filter from the PPD file.
  73 <dt><b>-i </b><i>mime/type</i>
  74 <dd style="margin-left: 5.0em">Specifies the source file type. The default file type is guessed using the filename and contents of the file.
  75 <dt><b>-j </b><i>job-id[,N]</i>
  76 <dd style="margin-left: 5.0em">Converts document N from the specified job. If N is omitted, document 1 is converted.
  77 <dt><b>-m </b><i>mime/type</i>
  78 <dd style="margin-left: 5.0em">Specifies the destination file type. The default file type is application/pdf. Use printer/foo to convert to the printer format defined by the filters in the PPD file.
  79 <dt><b>-n </b><i>copies</i>
  80 <dd style="margin-left: 5.0em">Specifies the number of copies to generate.
  81 <dt><b>-o </b><i>name=value</i>
  82 <dd style="margin-left: 5.0em">Specifies options to pass to the CUPS filters.
  83 <dt><b>-p </b><i>filename.ppd</i>
  84 <dd style="margin-left: 5.0em">Specifies the PPD file to use.
  85 <dt><b>-t </b><i>title</i>
  86 <dd style="margin-left: 5.0em">Specifies the document title.
  87 <dt><b>-u</b>
  88 <dd style="margin-left: 5.0em">Delete the PPD file after conversion.
  89 </dl>
  90 <h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2>
  91 <b>cupsfilter</b>
  92 returns a non-zero exit status on any error.
  93 <h2 class="title"><a name="ENVIRONMENT">Environment</a></h2>
  94 All of the standard
  95 <b>cups</b>(1)
  96 environment variables affect the operation of
  97 <b>cupsfilter</b>.
  98 <h2 class="title"><a name="FILES">Files</a></h2>
  99 <pre class="man">
 100 /etc/cups/cups-files.conf
 101 /etc/cups/*.convs
 102 /etc/cups/*.types
 103 /usr/share/cups/mime/*.convs
 104 /usr/share/cups/mime/*.types
 105 <h2 class="title"><a name="NOTES">Notes</a></h2>
 106 CUPS printer drivers, filters, and backends are deprecated and will no longer be supported in a future feature release of CUPS.
 107 Printers that do not support IPP can be supported using applications such as
 108 <b>ippeveprinter</b>(1).
 109 <p>Unlike when printing, filters run using the
 110 <b>cupsfilter</b>
 111 command use the current user and security session. This may result in different output or unexpected behavior.
 112 <h2 class="title"><a name="EXAMPLE">Example</a></h2>
 113 The following command will generate a PDF preview of job 42 for a printer named "myprinter" and save it to a file named "preview.pdf":
 114 <pre class="man">
 115
 116     cupsfilter -m application/pdf -d myprinter -j 42 >preview.pdf
 117 </pre>
 118 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
 119 <b>cups</b>(1),
 120 <b>cupsd.conf</b>(5),
 121 <b>filter(7),</b>
 122 <b>mime.convs</b>(7),
 123 <b>mime.types</b>(7),
 124 CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
 125 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
 126 Copyright &copy; 2007-2019 by Apple Inc.
 127
 128 </body>
 129 </html>