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" "28 March 2014" "Apple Inc."
  15 .SH NAME
  16 cupsfilter \- convert a file to another format using cups filters
  17 .SH SYNOPSIS
  18 .B cupsfilter
  19 [ --list-filters] [ -D ] [ -U
  20 .I user
  21 ] [ -c
  22 .I config-file
  23 ] [ -d
  24 .I printer
  25 ] [ -e ] [ -i
  26 .I mime/type
  27 ] [ -j
  28 .I job-id[,N]
  29 ] [ -m
  30 .I mime/type
  31 ] [ -n
  32 .I copies
  33 ] [ -o
  34 .I name=value
  35 ] [ -p
  36 .I filename.ppd
  37 ] [ -t
  38 .I title
  39 ] [ -u ]
  40 .I filename
  41 .SH DESCRIPTION
  42 .B cupsfilter
  43 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,
  44 .B cupsfilter
  45 generates a PDF file. The converted file is sent to the standard output.
  46 .SH OPTIONS
  47 .TP 5
  48 --list-filters
  49 Do not actually run the filters, just print the filters used to stdout.
  50 .TP 5
  51 -D
  52 Delete the input file after conversion.
  53 .TP 5
  54 -U user
  55 Specifies the username passed to the filters. The default is the name of the current user.
  56 .TP 5
  57 -c config-file
  58 Uses the named cups-files.conf configuration file.
  59 .TP 5
  60 -d printer
  61 Uses information from the named printer.
  62 .TP 5
  63 -e
  64 Use every filter from the PPD file.
  65 .TP 5
  66 -i mime/type
  67 Specifies the source file type. The default file type is guessed using the filename and contents of the file.
  68 .TP 5
  69 -j job-id[,N]
  70 Converts document N from the specified job. If N is omitted, document 1 is converted.
  71 .TP 5
  72 -m mime/type
  73 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.
  74 .TP 5
  75 -n copies
  76 Specifies the number of copies to generate.
  77 .TP 5
  78 -o name=value
  79 Specifies options to pass to the CUPS filters.
  80 .TP 5
  81 -p filename.ppd
  82 Specifies the PPD file to use.
  83 .TP 5
  84 -t title
  85 Specifies the document title.
  86 .TP 5
  87 -u
  88 Delete the PPD file after conversion.
  89 .SH EXIT STATUS
  90 .B cupsfilter
  91 returns a non-zero exit status on any error.
  92 .SH ENVIRONMENT
  93 All of the standard
  94 .BR cups (1)
  95 environment variables affect the operation of
  96 .BR cupsfilter .
  97 .SH FILES
  98 /etc/cups/cups-files.conf, /etc/cups/*.convs, /etc/cups/*.types, /usr/share/cups/mime/*.convs, /usr/share/cups/mime/*.types
  99 .SH NOTES
 100 Unlike when printing, filters run using the
 101 .B cupsfilter
 102 command use the current user and security session. This may result in different output or unexpected behavior.
 103 .SH EXAMPLE
 104 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":
 105 .nf
 106     cupsfilter -m application/pdf -d myprinter -j 42 >preview.pdf
 107 .fi
 108 .SH SEE ALSO
 109 .BR cups (1), cupsd.conf (5), filter(7), mime.convs (7), mime.types (7),
 110 http://localhost:631/help
 111 .SH COPYRIGHT
 112 Copyright \[co] 2007-2014 by Apple Inc.
 113 .\"
 114 .\" End of "$Id$".
 115 .\"