man/cupsfilter.man

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