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