man-pages/man8/cupsfilter.8.html
2021-03-31 01:06:50 +01:00

221 lines
5.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of cupsfilter</TITLE>
</HEAD><BODY>
<H1>cupsfilter</H1>
Section: Apple Inc. (8)<BR>Updated: CUPS<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
cupsfilter - convert a file to another format using cups filters (deprecated)
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</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>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</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.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<DL COMPACT>
<DT id="1"><B>--list-filters</B>
<DD>
Do not actually run the filters, just print the filters used to stdout.
<DT id="2"><B>-D</B>
<DD>
Delete the input file after conversion.
<DT id="3"><B>-U </B><I>user</I><DD>
Specifies the username passed to the filters. The default is the name of the current user.
<DT id="4"><B>-c </B><I>config-file</I><DD>
Uses the named cups-files.conf configuration file.
<DT id="5"><B>-d </B><I>printer</I><DD>
Uses information from the named printer.
<DT id="6"><B>-e</B>
<DD>
Use every filter from the PPD file.
<DT id="7"><B>-i </B><I>mime/type</I><DD>
Specifies the source file type. The default file type is guessed using the filename and contents of the file.
<DT id="8"><B>-j </B><I>job-id[,N]</I><DD>
Converts document N from the specified job. If N is omitted, document 1 is converted.
<DT id="9"><B>-m </B><I>mime/type</I><DD>
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 id="10"><B>-n </B><I>copies</I><DD>
Specifies the number of copies to generate.
<DT id="11"><B>-o </B><I>name=value</I><DD>
Specifies options to pass to the CUPS filters.
<DT id="12"><B>-p </B><I>filename.ppd</I><DD>
Specifies the PPD file to use.
<DT id="13"><B>-t </B><I>title</I><DD>
Specifies the document title.
<DT id="14"><B>-u</B>
<DD>
Delete the PPD file after conversion.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>EXIT STATUS</H2>
<B>cupsfilter</B>
returns a non-zero exit status on any error.
<A NAME="lbAG">&nbsp;</A>
<H2>ENVIRONMENT</H2>
All of the standard
<B><A HREF="/cgi-bin/man/man2html?1+cups">cups</A></B>(1)
environment variables affect the operation of
<B>cupsfilter</B>.
<A NAME="lbAH">&nbsp;</A>
<H2>FILES</H2>
<PRE>
/etc/cups/cups-files.conf
/etc/cups/*.convs
/etc/cups/*.types
/usr/share/cups/mime/*.convs
/usr/share/cups/mime/*.types
</PRE><A NAME="lbAI">&nbsp;</A>
<H2>NOTES</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><A HREF="/cgi-bin/man/man2html?1+ippeveprinter">ippeveprinter</A></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.
<A NAME="lbAJ">&nbsp;</A>
<H2>EXAMPLE</H2>
The following command will generate a PDF preview of job 42 for a printer named &quot;myprinter&quot; and save it to a file named &quot;preview.pdf&quot;:
<PRE>
cupsfilter -m application/pdf -d myprinter -j 42 &gt;preview.pdf
</PRE>
<A NAME="lbAK">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?1+cups">cups</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?5+cupsd.conf">cupsd.conf</A></B>(5),
<B><A HREF="/cgi-bin/man/man2html?7+filter">filter</A>(7),</B>
<B><A HREF="/cgi-bin/man/man2html?7+mime.convs">mime.convs</A></B>(7),
<B><A HREF="/cgi-bin/man/man2html?7+mime.types">mime.types</A></B>(7),
CUPS Online Help (<A HREF="http://localhost:631/help)">http://localhost:631/help)</A>
<A NAME="lbAL">&nbsp;</A>
<H2>COPYRIGHT</H2>
Copyright &#169; 2007-2019 by Apple Inc.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="15"><A HREF="#lbAB">NAME</A><DD>
<DT id="16"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="17"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="18"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="19"><A HREF="#lbAF">EXIT STATUS</A><DD>
<DT id="20"><A HREF="#lbAG">ENVIRONMENT</A><DD>
<DT id="21"><A HREF="#lbAH">FILES</A><DD>
<DT id="22"><A HREF="#lbAI">NOTES</A><DD>
<DT id="23"><A HREF="#lbAJ">EXAMPLE</A><DD>
<DT id="24"><A HREF="#lbAK">SEE ALSO</A><DD>
<DT id="25"><A HREF="#lbAL">COPYRIGHT</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:06:11 GMT, March 31, 2021
</BODY>
</HTML>