]>
Commit | Line | Data |
---|---|---|
bc44d920 | 1 | .\" |
84987361 | 2 | .\" cupsfilter man page for CUPS. |
bc44d920 | 3 | .\" |
84987361 | 4 | .\" Copyright 2007-2014 by Apple Inc. |
bc44d920 | 5 | .\" |
84987361 MS |
6 | .\" These coded instructions, statements, and computer programs are the |
7 | .\" property of Apple Inc. and are protected by Federal copyright | |
8 | .\" law. Distribution and use rights are outlined in the file "LICENSE.txt" | |
9 | .\" which should have been included with this file. If this file is | |
10 | .\" file is missing or damaged, see the license at "http://www.cups.org/". | |
bc44d920 | 11 | .\" |
bf1bc4c6 | 12 | .TH cupsfilter 8 "CUPS" "11 June 2014" "Apple Inc." |
bc44d920 | 13 | .SH NAME |
14 | cupsfilter \- convert a file to another format using cups filters | |
15 | .SH SYNOPSIS | |
16 | .B cupsfilter | |
bf1bc4c6 MS |
17 | [ |
18 | .B \-\-list\-filters | |
19 | ] [ | |
20 | .B \-D | |
21 | ] [ | |
22 | .B \-U | |
37e7e6e0 | 23 | .I user |
bf1bc4c6 MS |
24 | ] [ |
25 | .B \-c | |
bc44d920 | 26 | .I config-file |
bf1bc4c6 MS |
27 | ] [ |
28 | .B \-d | |
ba55dc12 | 29 | .I printer |
bf1bc4c6 MS |
30 | ] [ |
31 | .B \-e | |
32 | ] [ | |
33 | .B \-i | |
37e7e6e0 | 34 | .I mime/type |
bf1bc4c6 MS |
35 | ] [ |
36 | .B \-j | |
2e4ff8af | 37 | .I job-id[,N] |
bf1bc4c6 MS |
38 | ] [ |
39 | .B \-m | |
bc44d920 | 40 | .I mime/type |
bf1bc4c6 MS |
41 | ] [ |
42 | .B \-n | |
bc44d920 | 43 | .I copies |
bf1bc4c6 MS |
44 | ] [ |
45 | .B \-o | |
bc44d920 | 46 | .I name=value |
bf1bc4c6 MS |
47 | ] [ |
48 | .B \-p | |
bc44d920 | 49 | .I filename.ppd |
bf1bc4c6 MS |
50 | ] [ |
51 | .B \-t | |
bc44d920 | 52 | .I title |
bf1bc4c6 MS |
53 | ] [ |
54 | .B \-u | |
55 | ] | |
bc44d920 | 56 | .I filename |
57 | .SH DESCRIPTION | |
84987361 MS |
58 | .B cupsfilter |
59 | 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, | |
60 | .B cupsfilter | |
61 | generates a PDF file. The converted file is sent to the standard output. | |
bc44d920 | 62 | .SH OPTIONS |
63 | .TP 5 | |
bf1bc4c6 | 64 | .B \-\-list\-filters |
84987361 MS |
65 | Do not actually run the filters, just print the filters used to stdout. |
66 | .TP 5 | |
bf1bc4c6 | 67 | .B \-D |
37e7e6e0 MS |
68 | Delete the input file after conversion. |
69 | .TP 5 | |
bf1bc4c6 | 70 | \fB\-U \fIuser\fR |
37e7e6e0 MS |
71 | Specifies the username passed to the filters. The default is the name of the current user. |
72 | .TP 5 | |
bf1bc4c6 | 73 | \fB\-c \fIconfig-file\fR |
84987361 | 74 | Uses the named cups-files.conf configuration file. |
bc44d920 | 75 | .TP 5 |
bf1bc4c6 | 76 | \fB\-d \fIprinter\fR |
ba55dc12 MS |
77 | Uses information from the named printer. |
78 | .TP 5 | |
bf1bc4c6 | 79 | .B \-e |
1340db2d MS |
80 | Use every filter from the PPD file. |
81 | .TP 5 | |
bf1bc4c6 | 82 | \fB\-i \fImime/type\fR |
84987361 | 83 | Specifies the source file type. The default file type is guessed using the filename and contents of the file. |
37e7e6e0 | 84 | .TP 5 |
bf1bc4c6 | 85 | \fB\-j \fIjob-id[,N]\fR |
84987361 | 86 | Converts document N from the specified job. If N is omitted, document 1 is converted. |
2e4ff8af | 87 | .TP 5 |
bf1bc4c6 | 88 | \fB\-m \fImime/type\fR |
84987361 | 89 | 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. |
bc44d920 | 90 | .TP 5 |
bf1bc4c6 | 91 | \fB\-n \fIcopies\fR |
bc44d920 | 92 | Specifies the number of copies to generate. |
93 | .TP 5 | |
bf1bc4c6 | 94 | \fB\-o \fIname=value\fR |
bc44d920 | 95 | Specifies options to pass to the CUPS filters. |
96 | .TP 5 | |
bf1bc4c6 | 97 | \fB\-p \fIfilename.ppd\fR |
bc44d920 | 98 | Specifies the PPD file to use. |
99 | .TP 5 | |
bf1bc4c6 | 100 | \fB\-t \fItitle\fR |
bc44d920 | 101 | Specifies the document title. |
37e7e6e0 | 102 | .TP 5 |
bf1bc4c6 | 103 | .B \-u |
37e7e6e0 | 104 | Delete the PPD file after conversion. |
84987361 MS |
105 | .SH EXIT STATUS |
106 | .B cupsfilter | |
107 | returns a non-zero exit status on any error. | |
108 | .SH ENVIRONMENT | |
109 | All of the standard | |
110 | .BR cups (1) | |
111 | environment variables affect the operation of | |
112 | .BR cupsfilter . | |
113 | .SH FILES | |
bf1bc4c6 MS |
114 | .nf |
115 | /etc/cups/cups-files.conf | |
116 | /etc/cups/*.convs | |
117 | /etc/cups/*.types | |
118 | /usr/share/cups/mime/*.convs | |
119 | /usr/share/cups/mime/*.types | |
84987361 MS |
120 | .SH NOTES |
121 | Unlike when printing, filters run using the | |
122 | .B cupsfilter | |
123 | command use the current user and security session. This may result in different output or unexpected behavior. | |
124 | .SH EXAMPLE | |
125 | 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": | |
126 | .nf | |
bf1bc4c6 | 127 | |
84987361 MS |
128 | cupsfilter -m application/pdf -d myprinter -j 42 >preview.pdf |
129 | .fi | |
bc44d920 | 130 | .SH SEE ALSO |
bf1bc4c6 MS |
131 | .BR cups (1), |
132 | .BR cupsd.conf (5), | |
133 | .BR filter(7), | |
134 | .BR mime.convs (7), | |
135 | .BR mime.types (7), | |
136 | CUPS Online Help (http://localhost:631/help) | |
bc44d920 | 137 | .SH COPYRIGHT |
d58c2629 | 138 | Copyright \[co] 2007-2016 by Apple Inc. |