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
  12 <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
  13 <b>cupsfilter</b>
  14 [ --list-filters] [ -D ] [ -U
  15 <i>user</i>
  16 ] [ -c
  17 <i>config-file</i>
  18 ] [ -d
  19 <i>printer</i>
  20 ] [ -e ] [ -i
  21 <i>mime/type</i>
  22 ] [ -j
  23 <i>job-id[,N]</i>
  24 ] [ -m
  25 <i>mime/type</i>
  26 ] [ -n
  27 <i>copies</i>
  28 ] [ -o
  29 <i>name=value</i>
  30 ] [ -p
  31 <i>filename.ppd</i>
  32 ] [ -t
  33 <i>title</i>
  34 ] [ -u ]
  35 <i>filename</i>
  36 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
  37 <b>cupsfilter</b>
  38 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,
  39 <b>cupsfilter</b>
  40 generates a PDF file. The converted file is sent to the standard output.
  41 <h2 class="title"><a name="OPTIONS">Options</a></h2>
  42 <p style="margin-left: 5.0em; text-indent: -5.0em">--list-filters
  43 <br>
  44 Do not actually run the filters, just print the filters used to stdout.
  45 <p style="margin-left: 5.0em; text-indent: -5.0em">-D
  46 <br>
  47 Delete the input file after conversion.
  48 <p style="margin-left: 5.0em; text-indent: -5.0em">-U user
  49 <br>
  50 Specifies the username passed to the filters. The default is the name of the current user.
  51 <p style="margin-left: 5.0em; text-indent: -5.0em">-c config-file
  52 <br>
  53 Uses the named cups-files.conf configuration file.
  54 <p style="margin-left: 5.0em; text-indent: -5.0em">-d printer
  55 <br>
  56 Uses information from the named printer.
  57 <p style="margin-left: 5.0em; text-indent: -5.0em">-e
  58 <br>
  59 Use every filter from the PPD file.
  60 <p style="margin-left: 5.0em; text-indent: -5.0em">-i mime/type
  61 <br>
  62 Specifies the source file type. The default file type is guessed using the filename and contents of the file.
  63 <p style="margin-left: 5.0em; text-indent: -5.0em">-j job-id[,N]
  64 <br>
  65 Converts document N from the specified job. If N is omitted, document 1 is converted.
  66 <p style="margin-left: 5.0em; text-indent: -5.0em">-m mime/type
  67 <br>
  68 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.
  69 <p style="margin-left: 5.0em; text-indent: -5.0em">-n copies
  70 <br>
  71 Specifies the number of copies to generate.
  72 <p style="margin-left: 5.0em; text-indent: -5.0em">-o name=value
  73 <br>
  74 Specifies options to pass to the CUPS filters.
  75 <p style="margin-left: 5.0em; text-indent: -5.0em">-p filename.ppd
  76 <br>
  77 Specifies the PPD file to use.
  78 <p style="margin-left: 5.0em; text-indent: -5.0em">-t title
  79 <br>
  80 Specifies the document title.
  81 <p style="margin-left: 5.0em; text-indent: -5.0em">-u
  82 <br>
  83 Delete the PPD file after conversion.
  84 <h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2>
  85 <b>cupsfilter</b>
  86 returns a non-zero exit status on any error.
  87 <h2 class="title"><a name="ENVIRONMENT">Environment</a></h2>
  88 All of the standard
  89 <b>cups</b>(1)
  90 environment variables affect the operation of
  91 <b>cupsfilter</b>.
  92 <h2 class="title"><a name="FILES">Files</a></h2>
  93 /etc/cups/cups-files.conf, /etc/cups/*.convs, /etc/cups/*.types, /usr/share/cups/mime/*.convs, /usr/share/cups/mime/*.types
  94 <h2 class="title"><a name="NOTES">Notes</a></h2>
  95 Unlike when printing, filters run using the
  96 <b>cupsfilter</b>
  97 command use the current user and security session. This may result in different output or unexpected behavior.
  98 <h2 class="title"><a name="EXAMPLE">Example</a></h2>
  99 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":
 100 <pre>
 101     cupsfilter -m application/pdf -d myprinter -j 42 >preview.pdf
 102 </pre>
 103 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
 104 <b>cups</b>(1), <a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a> <b>filter(7),</b> mime.convs<b>(7),</b> mime.types<b>(7),</b>
 105 <a href="http://localhost:631/help">http://localhost:631/help</a>
 106 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
 107 Copyright &copy; 2007-2014 by Apple Inc.
 108
 109 </body>
 110 </html>