man/cupsfilter.man

   1 .\"
   2 .\" cupsfilter man page for CUPS.
   3 .\"
   4 .\" Copyright 2007-2014 by Apple Inc.
   5 .\"
   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/".
  11 .\"
  12 .TH cupsfilter 8 "CUPS" "11 June 2014" "Apple Inc."
  13 .SH NAME
  14 cupsfilter \- convert a file to another format using cups filters
  15 .SH SYNOPSIS
  16 .B cupsfilter
  17 [
  18 .B \-\-list\-filters
  19 ] [
  20 .B \-D
  21 ] [
  22 .B \-U
  23 .I user
  24 ] [
  25 .B \-c
  26 .I config-file
  27 ] [
  28 .B \-d
  29 .I printer
  30 ] [
  31 .B \-e
  32 ] [
  33 .B \-i
  34 .I mime/type
  35 ] [
  36 .B \-j
  37 .I job-id[,N]
  38 ] [
  39 .B \-m
  40 .I mime/type
  41 ] [
  42 .B \-n
  43 .I copies
  44 ] [
  45 .B \-o
  46 .I name=value
  47 ] [
  48 .B \-p
  49 .I filename.ppd
  50 ] [
  51 .B \-t
  52 .I title
  53 ] [
  54 .B \-u
  55 ]
  56 .I filename
  57 .SH DESCRIPTION
  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.
  62 .SH OPTIONS
  63 .TP 5
  64 .B \-\-list\-filters
  65 Do not actually run the filters, just print the filters used to stdout.
  66 .TP 5
  67 .B \-D
  68 Delete the input file after conversion.
  69 .TP 5
  70 \fB\-U \fIuser\fR
  71 Specifies the username passed to the filters. The default is the name of the current user.
  72 .TP 5
  73 \fB\-c \fIconfig-file\fR
  74 Uses the named cups-files.conf configuration file.
  75 .TP 5
  76 \fB\-d \fIprinter\fR
  77 Uses information from the named printer.
  78 .TP 5
  79 .B \-e
  80 Use every filter from the PPD file.
  81 .TP 5
  82 \fB\-i \fImime/type\fR
  83 Specifies the source file type. The default file type is guessed using the filename and contents of the file.
  84 .TP 5
  85 \fB\-j \fIjob-id[,N]\fR
  86 Converts document N from the specified job. If N is omitted, document 1 is converted.
  87 .TP 5
  88 \fB\-m \fImime/type\fR
  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.
  90 .TP 5
  91 \fB\-n \fIcopies\fR
  92 Specifies the number of copies to generate.
  93 .TP 5
  94 \fB\-o \fIname=value\fR
  95 Specifies options to pass to the CUPS filters.
  96 .TP 5
  97 \fB\-p \fIfilename.ppd\fR
  98 Specifies the PPD file to use.
  99 .TP 5
 100 \fB\-t \fItitle\fR
 101 Specifies the document title.
 102 .TP 5
 103 .B \-u
 104 Delete the PPD file after conversion.
 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
 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
 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
 127
 128     cupsfilter -m application/pdf -d myprinter -j 42 >preview.pdf
 129 .fi
 130 .SH SEE ALSO
 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)
 137 .SH COPYRIGHT
 138 Copyright \[co] 2007-2015 by Apple Inc.