]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - doc/help/man-cupsfilter.html
Import CUPS v2.0b1
[thirdparty/cups.git] / doc / help / man-cupsfilter.html
index 5ff9c340495d80b7356ecc0e66c73f9e0927b13d..4053c6e9c000ced29f9c57a696584d4e5ccbfd27 100644 (file)
@@ -1,4 +1,4 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!DOCTYPE HTML>
 <html>
 <!-- SECTION: Man Pages -->
 <head>
 <h2 class="title"><a name="NAME">Name</a></h2>
 cupsfilter - convert a file to another format using cups filters
 <h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
-<b>cupsfilter
-</b>[ -D ] [ -U
-<i>user
-</i>] [ -c
-<i>config-file
-</i>] [ -d
-<i>printer
-</i>] [ -e ] [ -i
-<i>mime/type
-</i>] [ -j
-<i>job-id[,N]
-</i>] [ -m
-<i>mime/type
-</i>] [ -n
-<i>copies
-</i>] [ -o
-<i>name=value
-</i>] [ -p
-<i>filename.ppd
-</i>] [ -t
-<i>title
-</i>] [ -u ]
-<i>filename
-</i><h2 class="title"><a name="DESCRIPTION">Description</a></h2>
-<i>cupsfilter</i> 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, <i>cupsfilter</i> generates a PDF file. The converted
-file is sent to the standard output.
+<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>
-<dt>-D
-</dt>
-<dd></dd>
-<dd>Delete the input file after conversion.
-</dd>
-<dt>-U user
-</dt>
-<dd></dd>
-<dd>Specifies the username passed to the filters. The default is the name of the current user.
-</dd>
-<dt>-c config-file
-</dt>
-<dd></dd>
-<dd>Uses the named cups-files.conf configuration file.
-</dd>
-<dt>-d printer
-</dt>
-<dd>Uses information from the named printer.
-</dd>
-<dt>-e
-</dt>
-<dd></dd>
-<dd>Use every filter from the PPD file.
-</dd>
-<dt>-i mime/type
-</dt>
-<dd></dd>
-<dd>Specifies the source file type. The default file type is guessed using the
-filename and contents of the file.
-</dd>
-<dt>-j job-id[,N]
-</dt>
-<dd></dd>
-<dd>Converts document N from the specified job. If N is omitted, document 1 is
-converted.
-</dd>
-<dt>-m mime/type
-</dt>
-<dd></dd>
-<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.
-</dd>
-<dt>-n copies
-</dt>
-<dd></dd>
-<dd>Specifies the number of copies to generate.
-</dd>
-<dt>-o name=value
-</dt>
-<dd></dd>
-<dd>Specifies options to pass to the CUPS filters.
-</dd>
-<dt>-p filename.ppd
-</dt>
-<dd></dd>
-<dd>Specifies the PPD file to use.
-</dd>
-<dt>-t title
-</dt>
-<dd></dd>
-<dd>Specifies the document title.
-</dd>
-<dt>-u
-</dt>
-<dd></dd>
-<dd>Delete the PPD file after conversion.
-</dd>
+<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
+<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1)</a>
+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>
+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>
-<a href='man-cups-files.conf.html?TOPIC=Man+Pages'>cups-files.conf(5)</a>
-<br>
-<a href='http://localhost:631/help'>http://localhost:631/help</a>
+<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a>
+<a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a>
+<b>filter(7),</b>
+<a href="man-mime.convs.html?TOPIC=Man+Pages"><b>mime.convs</b>(7),</a>
+<a href="man-mime.types.html?TOPIC=Man+Pages"><b>mime.types</b>(7),</a>
+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-2014 by Apple Inc.
+Copyright &copy; 2007-2014 by Apple Inc.
 
 </body>
 </html>