| <!DOCTYPE HTML> |
| <html> |
| <!-- SECTION: Man Pages --> |
| <head> |
| <link rel="stylesheet" type="text/css" href="../cups-printable.css"> |
| <title>cupsfilter(8)</title> |
| </head> |
| <body> |
| <h1 class="title">cupsfilter(8)</h1> |
| <h2 class="title"><a name="NAME">Name</a></h2> |
| cupsfilter - convert a file to another format using cups filters (deprecated) |
| <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2> |
| <b>cupsfilter</b> |
| [ |
| <b>--list-filters</b> |
| ] [ |
| <b>-D</b> |
| ] [ |
| <b>-U</b> |
| <i>user</i> |
| ] [ |
| <b>-c</b> |
| <i>config-file</i> |
| ] [ |
| <b>-d</b> |
| <i>printer</i> |
| ] [ |
| <b>-e</b> |
| ] [ |
| <b>-i</b> |
| <i>mime/type</i> |
| ] [ |
| <b>-j</b> |
| <i>job-id[,N]</i> |
| ] [ |
| <b>-m</b> |
| <i>mime/type</i> |
| ] [ |
| <b>-n</b> |
| <i>copies</i> |
| ] [ |
| <b>-o</b> |
| <i>name=value</i> |
| ] [ |
| <b>-p</b> |
| <i>filename.ppd</i> |
| ] [ |
| <b>-t</b> |
| <i>title</i> |
| ] [ |
| <b>-u</b> |
| ] |
| <i>filename</i> |
| <h2 class="title"><a name="DESCRIPTION">Description</a></h2> |
| <b>cupsfilter</b> |
| 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, |
| <b>cupsfilter</b> |
| generates a PDF file. The converted file is sent to the standard output. |
| <h2 class="title"><a name="OPTIONS">Options</a></h2> |
| <dl class="man"> |
| <dt><b>--list-filters</b> |
| <dd style="margin-left: 5.0em">Do not actually run the filters, just print the filters used to stdout. |
| <dt><b>-D</b> |
| <dd style="margin-left: 5.0em">Delete the input file after conversion. |
| <dt><b>-U </b><i>user</i> |
| <dd style="margin-left: 5.0em">Specifies the username passed to the filters. The default is the name of the current user. |
| <dt><b>-c </b><i>config-file</i> |
| <dd style="margin-left: 5.0em">Uses the named cups-files.conf configuration file. |
| <dt><b>-d </b><i>printer</i> |
| <dd style="margin-left: 5.0em">Uses information from the named printer. |
| <dt><b>-e</b> |
| <dd style="margin-left: 5.0em">Use every filter from the PPD file. |
| <dt><b>-i </b><i>mime/type</i> |
| <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. |
| <dt><b>-j </b><i>job-id[,N]</i> |
| <dd style="margin-left: 5.0em">Converts document N from the specified job. If N is omitted, document 1 is converted. |
| <dt><b>-m </b><i>mime/type</i> |
| <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. |
| <dt><b>-n </b><i>copies</i> |
| <dd style="margin-left: 5.0em">Specifies the number of copies to generate. |
| <dt><b>-o </b><i>name=value</i> |
| <dd style="margin-left: 5.0em">Specifies options to pass to the CUPS filters. |
| <dt><b>-p </b><i>filename.ppd</i> |
| <dd style="margin-left: 5.0em">Specifies the PPD file to use. |
| <dt><b>-t </b><i>title</i> |
| <dd style="margin-left: 5.0em">Specifies the document title. |
| <dt><b>-u</b> |
| <dd style="margin-left: 5.0em">Delete the PPD file after conversion. |
| </dl> |
| <h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2> |
| <b>cupsfilter</b> |
| returns a non-zero exit status on any error. |
| <h2 class="title"><a name="ENVIRONMENT">Environment</a></h2> |
| All of the standard |
| <b>cups</b>(1) |
| environment variables affect the operation of |
| <b>cupsfilter</b>. |
| <h2 class="title"><a name="FILES">Files</a></h2> |
| <pre class="man"> |
| /etc/cups/cups-files.conf |
| /etc/cups/*.convs |
| /etc/cups/*.types |
| /usr/share/cups/mime/*.convs |
| /usr/share/cups/mime/*.types |
| <h2 class="title"><a name="NOTES">Notes</a></h2> |
| CUPS printer drivers, filters, and backends are deprecated and will no longer be supported in a future feature release of CUPS. |
| Printers that do not support IPP can be supported using applications such as |
| <b>ippeveprinter</b>(1). |
| <p>Unlike when printing, filters run using the |
| <b>cupsfilter</b> |
| command use the current user and security session. This may result in different output or unexpected behavior. |
| <h2 class="title"><a name="EXAMPLE">Example</a></h2> |
| 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": |
| <pre class="man"> |
| |
| cupsfilter -m application/pdf -d myprinter -j 42 >preview.pdf |
| </pre> |
| <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> |
| <b>cups</b>(1), |
| <b>cupsd.conf</b>(5), |
| <b>filter(7),</b> |
| <b>mime.convs</b>(7), |
| <b>mime.types</b>(7), |
| CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>) |
| <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> |
| Copyright © 2007-2019 by Apple Inc. |
| |
| </body> |
| </html> |