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