]>
Commit | Line | Data |
---|---|---|
c277f98c | 1 | <!DOCTYPE HTML> |
94436c5a MS |
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> | |
c277f98c | 13 | <b>cupsfilter</b> |
84987361 | 14 | [ --list-filters] [ -D ] [ -U |
c277f98c MS |
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> | |
84987361 MS |
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. | |
94436c5a | 41 | <h2 class="title"><a name="OPTIONS">Options</a></h2> |
2909c66c MS |
42 | <dl class="man"> |
43 | <dt>--list-filters | |
44 | <dd style="margin-left: 5.0em">Do not actually run the filters, just print the filters used to stdout. | |
45 | <dt>-D | |
46 | <dd style="margin-left: 5.0em">Delete the input file after conversion. | |
47 | <dt>-U user | |
48 | <dd style="margin-left: 5.0em">Specifies the username passed to the filters. The default is the name of the current user. | |
49 | <dt>-c config-file | |
50 | <dd style="margin-left: 5.0em">Uses the named cups-files.conf configuration file. | |
51 | <dt>-d printer | |
52 | <dd style="margin-left: 5.0em">Uses information from the named printer. | |
53 | <dt>-e | |
54 | <dd style="margin-left: 5.0em">Use every filter from the PPD file. | |
55 | <dt>-i mime/type | |
56 | <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. | |
57 | <dt>-j job-id[,N] | |
58 | <dd style="margin-left: 5.0em">Converts document N from the specified job. If N is omitted, document 1 is converted. | |
59 | <dt>-m mime/type | |
60 | <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. | |
61 | <dt>-n copies | |
62 | <dd style="margin-left: 5.0em">Specifies the number of copies to generate. | |
63 | <dt>-o name=value | |
64 | <dd style="margin-left: 5.0em">Specifies options to pass to the CUPS filters. | |
65 | <dt>-p filename.ppd | |
66 | <dd style="margin-left: 5.0em">Specifies the PPD file to use. | |
67 | <dt>-t title | |
68 | <dd style="margin-left: 5.0em">Specifies the document title. | |
69 | <dt>-u | |
70 | <dd style="margin-left: 5.0em">Delete the PPD file after conversion. | |
71 | </dl> | |
84987361 MS |
72 | <h2 class="title"><a name="EXIT_STATUS">Exit Status</a></h2> |
73 | <b>cupsfilter</b> | |
74 | returns a non-zero exit status on any error. | |
75 | <h2 class="title"><a name="ENVIRONMENT">Environment</a></h2> | |
76 | All of the standard | |
969af935 | 77 | <a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1)</a> |
84987361 MS |
78 | environment variables affect the operation of |
79 | <b>cupsfilter</b>. | |
80 | <h2 class="title"><a name="FILES">Files</a></h2> | |
81 | /etc/cups/cups-files.conf, /etc/cups/*.convs, /etc/cups/*.types, /usr/share/cups/mime/*.convs, /usr/share/cups/mime/*.types | |
82 | <h2 class="title"><a name="NOTES">Notes</a></h2> | |
83 | Unlike when printing, filters run using the | |
84 | <b>cupsfilter</b> | |
85 | command use the current user and security session. This may result in different output or unexpected behavior. | |
86 | <h2 class="title"><a name="EXAMPLE">Example</a></h2> | |
87 | 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": | |
2909c66c | 88 | <pre class="man"> |
84987361 MS |
89 | cupsfilter -m application/pdf -d myprinter -j 42 >preview.pdf |
90 | </pre> | |
94436c5a | 91 | <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> |
2909c66c | 92 | <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>mime.convs<b>(7),</b>mime.types<b>(7),</b> |
c277f98c | 93 | <a href="http://localhost:631/help">http://localhost:631/help</a> |
94436c5a | 94 | <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> |
84987361 | 95 | Copyright © 2007-2014 by Apple Inc. |
94436c5a MS |
96 | |
97 | </body> | |
98 | </html> |