man/cupsfilter.8

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