man/cupsfilter.man

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