| 1 | .\" Copyright 2005-2017 Glyph & Cog, LLC
|
|---|
| 2 | .TH pdftoppm 1 "10 Aug 2017"
|
|---|
| 3 | .SH NAME
|
|---|
| 4 | pdftoppm \- Portable Document Format (PDF) to Portable Pixmap (PPM)
|
|---|
| 5 | converter (version 4.00)
|
|---|
| 6 | .SH SYNOPSIS
|
|---|
| 7 | .B pdftoppm
|
|---|
| 8 | [options]
|
|---|
| 9 | .I PDF-file PPM-root
|
|---|
| 10 | .SH DESCRIPTION
|
|---|
| 11 | .B Pdftoppm
|
|---|
| 12 | converts Portable Document Format (PDF) files to color image files in
|
|---|
| 13 | Portable Pixmap (PPM) format, grayscale image files in Portable
|
|---|
| 14 | Graymap (PGM) format, or monochrome image files in Portable Bitmap
|
|---|
| 15 | (PBM) format.
|
|---|
| 16 | .PP
|
|---|
| 17 | Pdftoppm reads the PDF file,
|
|---|
| 18 | .IR PDF-file ,
|
|---|
| 19 | and writes one PPM file for each page,
|
|---|
| 20 | .IR PPM-root - nnnnnn .ppm,
|
|---|
| 21 | where
|
|---|
| 22 | .I nnnnnn
|
|---|
| 23 | is the page number.
|
|---|
| 24 | If
|
|---|
| 25 | .I PPM-root
|
|---|
| 26 | is \'-', the image is sent to stdout (this is probably only useful
|
|---|
| 27 | when converting a single page).
|
|---|
| 28 | .SH CONFIGURATION FILE
|
|---|
| 29 | Pdftoppm reads a configuration file at startup. It first tries to
|
|---|
| 30 | find the user's private config file, ~/.xpdfrc. If that doesn't
|
|---|
| 31 | exist, it looks for a system-wide config file, typically
|
|---|
| 32 | /usr/local/etc/xpdfrc (but this location can be changed when pdftoppm
|
|---|
| 33 | is built). See the
|
|---|
| 34 | .BR xpdfrc (5)
|
|---|
| 35 | man page for details.
|
|---|
| 36 | .SH OPTIONS
|
|---|
| 37 | Many of the following options can be set with configuration file
|
|---|
| 38 | commands. These are listed in square brackets with the description of
|
|---|
| 39 | the corresponding command line option.
|
|---|
| 40 | .TP
|
|---|
| 41 | .BI \-f " number"
|
|---|
| 42 | Specifies the first page to convert.
|
|---|
| 43 | .TP
|
|---|
| 44 | .BI \-l " number"
|
|---|
| 45 | Specifies the last page to convert.
|
|---|
| 46 | .TP
|
|---|
| 47 | .BI \-r " number"
|
|---|
| 48 | Specifies the resolution, in DPI. The default is 150 DPI.
|
|---|
| 49 | .TP
|
|---|
| 50 | .B \-mono
|
|---|
| 51 | Generate a monochrome PBM file (instead of an RGB PPM file).
|
|---|
| 52 | .TP
|
|---|
| 53 | .B \-gray
|
|---|
| 54 | Generate a grayscale PGM file (instead of an RGB PPM file).
|
|---|
| 55 | .TP
|
|---|
| 56 | .B \-cmyk
|
|---|
| 57 | Generate a CMYK PAM file (instead of an RGB PPM file).
|
|---|
| 58 | .TP
|
|---|
| 59 | .BI \-freetype " yes | no"
|
|---|
| 60 | Enable or disable FreeType (a TrueType / Type 1 font rasterizer).
|
|---|
| 61 | This defaults to "yes".
|
|---|
| 62 | .RB "[config file: " enableFreeType ]
|
|---|
| 63 | .TP
|
|---|
| 64 | .BI \-aa " yes | no"
|
|---|
| 65 | Enable or disable font anti-aliasing. This defaults to "yes".
|
|---|
| 66 | .RB "[config file: " antialias ]
|
|---|
| 67 | .TP
|
|---|
| 68 | .BI \-aaVector " yes | no"
|
|---|
| 69 | Enable or disable vector anti-aliasing. This defaults to "yes".
|
|---|
| 70 | .RB "[config file: " vectorAntialias ]
|
|---|
| 71 | .TP
|
|---|
| 72 | .BI \-opw " password"
|
|---|
| 73 | Specify the owner password for the PDF file. Providing this will
|
|---|
| 74 | bypass all security restrictions.
|
|---|
| 75 | .TP
|
|---|
| 76 | .BI \-upw " password"
|
|---|
| 77 | Specify the user password for the PDF file.
|
|---|
| 78 | .TP
|
|---|
| 79 | .B \-q
|
|---|
| 80 | Don't print any messages or errors.
|
|---|
| 81 | .RB "[config file: " errQuiet ]
|
|---|
| 82 | .TP
|
|---|
| 83 | .B \-v
|
|---|
| 84 | Print copyright and version information.
|
|---|
| 85 | .TP
|
|---|
| 86 | .B \-h
|
|---|
| 87 | Print usage information.
|
|---|
| 88 | .RB ( \-help
|
|---|
| 89 | and
|
|---|
| 90 | .B \-\-help
|
|---|
| 91 | are equivalent.)
|
|---|
| 92 | .SH EXIT CODES
|
|---|
| 93 | The Xpdf tools use the following exit codes:
|
|---|
| 94 | .TP
|
|---|
| 95 | 0
|
|---|
| 96 | No error.
|
|---|
| 97 | .TP
|
|---|
| 98 | 1
|
|---|
| 99 | Error opening a PDF file.
|
|---|
| 100 | .TP
|
|---|
| 101 | 2
|
|---|
| 102 | Error opening an output file.
|
|---|
| 103 | .TP
|
|---|
| 104 | 3
|
|---|
| 105 | Error related to PDF permissions.
|
|---|
| 106 | .TP
|
|---|
| 107 | 99
|
|---|
| 108 | Other error.
|
|---|
| 109 | .SH AUTHOR
|
|---|
| 110 | The pdftoppm software and documentation are copyright 1996-2017 Glyph
|
|---|
| 111 | & Cog, LLC.
|
|---|
| 112 | .SH "SEE ALSO"
|
|---|
| 113 | .BR xpdf (1),
|
|---|
| 114 | .BR pdftops (1),
|
|---|
| 115 | .BR pdftotext (1),
|
|---|
| 116 | .BR pdftohtml (1),
|
|---|
| 117 | .BR pdfinfo (1),
|
|---|
| 118 | .BR pdffonts (1),
|
|---|
| 119 | .BR pdfdetach (1),
|
|---|
| 120 | .BR pdftopng (1),
|
|---|
| 121 | .BR pdfimages (1),
|
|---|
| 122 | .BR xpdfrc (5)
|
|---|
| 123 | .br
|
|---|
| 124 | .B http://www.xpdfreader.com/
|
|---|
