diff options
Diffstat (limited to 'man/cupsfilter.man')
-rw-r--r-- | man/cupsfilter.man | 141 |
1 files changed, 87 insertions, 54 deletions
diff --git a/man/cupsfilter.man b/man/cupsfilter.man index 4370f8f15..6e3f13368 100644 --- a/man/cupsfilter.man +++ b/man/cupsfilter.man @@ -1,5 +1,5 @@ .\" -.\" "$Id: cupsfilter.man 11772 2014-03-28 15:08:30Z msweet $" +.\" "$Id: cupsfilter.man 11920 2014-06-11 19:03:59Z msweet $" .\" .\" cupsfilter man page for CUPS. .\" @@ -11,100 +11,133 @@ .\" which should have been included with this file. If this file is .\" file is missing or damaged, see the license at "http://www.cups.org/". .\" -.TH cupsfilter 8 "CUPS" "28 March 2014" "Apple Inc." +.TH cupsfilter 8 "CUPS" "11 June 2014" "Apple Inc." .SH NAME cupsfilter \- convert a file to another format using cups filters .SH SYNOPSIS .B cupsfilter -[ -D ] [ -U +[ +.B \-\-list\-filters +] [ +.B \-D +] [ +.B \-U .I user -] [ -c +] [ +.B \-c .I config-file -] [ -d +] [ +.B \-d .I printer -] [ -e ] [ -i +] [ +.B \-e +] [ +.B \-i .I mime/type -] [ -j +] [ +.B \-j .I job-id[,N] -] [ -m +] [ +.B \-m .I mime/type -] [ -n +] [ +.B \-n .I copies -] [ -o +] [ +.B \-o .I name=value -] [ -p +] [ +.B \-p .I filename.ppd -] [ -t +] [ +.B \-t .I title -] [ -u ] +] [ +.B \-u +] .I filename .SH DESCRIPTION -\fIcupsfilter\fR 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, \fIcupsfilter\fR generates a PDF file. The converted -file is sent to the standard output. +.B cupsfilter +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 +generates a PDF file. The converted file is sent to the standard output. .SH OPTIONS .TP 5 --D -.br +.B \-\-list\-filters +Do not actually run the filters, just print the filters used to stdout. +.TP 5 +.B \-D Delete the input file after conversion. .TP 5 --U user -.br +\fB\-U \fIuser\fR Specifies the username passed to the filters. The default is the name of the current user. .TP 5 --c config-file -.br +\fB\-c \fIconfig-file\fR Uses the named cups-files.conf configuration file. .TP 5 --d printer +\fB\-d \fIprinter\fR Uses information from the named printer. .TP 5 --e -.br +.B \-e Use every filter from the PPD file. .TP 5 --i mime/type -.br -Specifies the source file type. The default file type is guessed using the -filename and contents of the file. +\fB\-i \fImime/type\fR +Specifies the source file type. The default file type is guessed using the filename and contents of the file. .TP 5 --j job-id[,N] -.br -Converts document N from the specified job. If N is omitted, document 1 is -converted. +\fB\-j \fIjob-id[,N]\fR +Converts document N from the specified job. If N is omitted, document 1 is converted. .TP 5 --m mime/type -.br -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. +\fB\-m \fImime/type\fR +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. .TP 5 --n copies -.br +\fB\-n \fIcopies\fR Specifies the number of copies to generate. .TP 5 --o name=value -.br +\fB\-o \fIname=value\fR Specifies options to pass to the CUPS filters. .TP 5 --p filename.ppd -.br +\fB\-p \fIfilename.ppd\fR Specifies the PPD file to use. .TP 5 --t title -.br +\fB\-t \fItitle\fR Specifies the document title. .TP 5 --u -.br +.B \-u Delete the PPD file after conversion. +.SH EXIT STATUS +.B cupsfilter +returns a non-zero exit status on any error. +.SH ENVIRONMENT +All of the standard +.BR cups (1) +environment variables affect the operation of +.BR cupsfilter . +.SH FILES +.nf +/etc/cups/cups-files.conf +/etc/cups/*.convs +/etc/cups/*.types +/usr/share/cups/mime/*.convs +/usr/share/cups/mime/*.types +.SH NOTES +Unlike when printing, filters run using the +.B cupsfilter +command use the current user and security session. This may result in different output or unexpected behavior. +.SH EXAMPLE +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": +.nf + + cupsfilter -m application/pdf -d myprinter -j 42 >preview.pdf +.fi .SH SEE ALSO -\fIcups-files.conf(5)\fR -.br -http://localhost:631/help +.BR cups (1), +.BR cupsd.conf (5), +.BR filter(7), +.BR mime.convs (7), +.BR mime.types (7), +CUPS Online Help (http://localhost:631/help) .SH COPYRIGHT -Copyright 2007-2014 by Apple Inc. +Copyright \[co] 2007-2014 by Apple Inc. .\" -.\" End of "$Id: cupsfilter.man 11772 2014-03-28 15:08:30Z msweet $". +.\" End of "$Id: cupsfilter.man 11920 2014-06-11 19:03:59Z msweet $". .\" |