pdftoppm.1 5.08 KB
Newer Older
1 2
.\" Copyright 2005-2011 Glyph & Cog, LLC
.TH pdftoppm 1 "15 August 2011"
3 4
.SH NAME
pdftoppm \- Portable Document Format (PDF) to Portable Pixmap (PPM)
5
converter (version 3.03)
6 7 8 9 10 11 12 13 14 15 16 17 18 19
.SH SYNOPSIS
.B pdftoppm
[options]
.I PDF-file PPM-root
.SH DESCRIPTION
.B Pdftoppm
converts Portable Document Format (PDF) files to color image files in
Portable Pixmap (PPM) format, grayscale image files in Portable
Graymap (PGM) format, or monochrome image files in Portable Bitmap
(PBM) format.
.PP
Pdftoppm reads the PDF file,
.IR PDF-file ,
and writes one PPM file for each page,
20
.IR PPM-root - number .ppm,
21
where
22
.I number
23 24 25 26 27 28 29 30 31
is the page number.
.SH OPTIONS
.TP
.BI \-f " number"
Specifies the first page to convert.
.TP
.BI \-l " number"
Specifies the last page to convert.
.TP
32 33 34 35 36 37
.B \-o
Generates only the odd numbered pages.
.TP
.B \-e
Generates only the even numbered pages.
.TP
38 39 40
.BI \-singlefile
Writes only the first page and does not add digits.
.TP
41
.BI \-r " number"
42 43 44 45 46 47 48
Specifies the X and Y resolution, in DPI.  The default is 150 DPI.
.TP
.BI \-rx " number"
Specifies the X resolution, in DPI.  The default is 150 DPI.
.TP
.BI \-ry " number"
Specifies the Y resolution, in DPI.  The default is 150 DPI.
49
.TP
50
.BI \-scale-to " number"
51 52 53
Scales the long side of each page (width for landscape pages, height
for portrait pages) to fit in scale-to pixels. The size of the short
side will be determined by the aspect ratio of the page.
54 55
.TP
.BI \-scale-to-x " number"
56 57 58
Scales each page horizontally to fit in scale-to-x pixels. If
scale-to-y is set to -1, the vertical size will determined by the
aspect ratio of the page.
59 60
.TP
.BI \-scale-to-y " number"
61 62 63
Scales each page vertically to fit in scale-to-y pixels. If scale-to-x
is set to -1, the horizontal size will determined by the aspect ratio
of the page.
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
.TP
.BI \-x " number"
Specifies the x-coordinate of the crop area top left corner
.TP
.BI \-y " number"
Specifies the y-coordinate of the crop area top left corner
.TP
.BI \-W " number"
Specifies the width of crop area in pixels (default is 0)
.TP
.BI \-H " number"
Specifies the height of crop area in pixels (default is 0)
.TP
.BI \-sz " number"
Specifies the size of crop square in pixels (sets W and H)
.TP
80
.B \-cropbox
Albert Astals Cid's avatar
Albert Astals Cid committed
81
Uses the crop box rather than media box when generating the files
82
.TP
83 84 85 86 87 88
.B \-mono
Generate a monochrome PBM file (instead of a color PPM file).
.TP
.B \-gray
Generate a grayscale PGM file (instead of a color PPM file).
.TP
89 90 91
.B \-png
Generates a PNG file instead a PPM file.
.TP
Stefan Thomas's avatar
Stefan Thomas committed
92 93 94
.B \-jpeg
Generates a JPEG file instead a PPM file.
.TP
95 96 97 98 99
.BI \-jpegopt " jpeg-options"
When used with \-jpeg, takes a list of options to control the jpeg compression. See
.B JPEG OPTIONS
for the available options.
.TP
100 101 102 103 104 105
.B \-tiff
Generates a TIFF file instead a PPM file.
.TP
.BI \-tiffcompression " none | packbits | jpeg | lzw | deflate"
Specifies the TIFF compression type.  This defaults to "none".
.TP
106 107 108 109
.BI \-freetype " yes | no"
Enable or disable FreeType (a TrueType / Type 1 font rasterizer).
This defaults to "yes".
.TP
110 111 112 113 114 115 116 117 118 119 120 121
.BI \-thinlinemode " none | solid | shape"
Specifies the thin line mode. This defaults to "none".
.TP
"solid": 
adjust lines with a width less than one pixel to pixel boundary 
and paint it with a width of one pixel.
.TP
"shape": 
adjust lines with a width less than one pixel to pixel boundary 
and paint it with a width of one pixel but with a shape in proportion
to its width.
.TP
122 123
.BI \-aa " yes | no"
Enable or disable font anti-aliasing.  This defaults to "yes".
124 125 126
.TP
.BI \-aaVector " yes | no"
Enable or disable vector anti-aliasing.  This defaults to "yes".
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
.TP
.BI \-opw " password"
Specify the owner password for the PDF file.  Providing this will
bypass all security restrictions.
.TP
.BI \-upw " password"
Specify the user password for the PDF file.
.TP
.B \-q
Don't print any messages or errors.
.TP
.B \-v
Print copyright and version information.
.TP
.B \-h
Print usage information.
.RB ( \-help
and
.B \-\-help
are equivalent.)
.SH EXIT CODES
The Xpdf tools use the following exit codes:
.TP
0
No error.
.TP
1
Error opening a PDF file.
.TP
2
Error opening an output file.
.TP
3
Error related to PDF permissions.
.TP
99
Other error.
164 165 166 167 168 169 170 171 172 173
.SH JPEG OPTIONS
When JPEG output is specified, the \-jpegopt option can be used to control the JPEG compression parameters.
It takes a string of the form "<opt>=<val>[,<opt>=<val>]". Currently the available options are:
.TP
.BI quality
Selects the JPEG quality value. The value must be an integer between 0 and 100.
.TP
.BI progressive
Select progressive JPEG output. The possible values are "y", "n",
indicating progressive (yes) or non-progressive (no), respectively.
174 175 176 177 178 179
.TP
.BI optimize
Sets whether to compute optimal Huffman coding tables for the JPEG output, which
will create smaller files but make an extra pass over the data. The value must
be "y" or "n", with "y" performing optimization, otherwise the default Huffman
tables are used.
180
.SH AUTHOR
181
The pdftoppm software and documentation are copyright 1996-2011 Glyph
182 183
& Cog, LLC.
.SH "SEE ALSO"
184
.BR pdfdetach (1),
185 186
.BR pdffonts (1),
.BR pdfimages (1),
187 188 189 190 191
.BR pdfinfo (1),
.BR pdftocairo (1),
.BR pdftohtml (1),
.BR pdftops (1),
.BR pdftotext (1)
192 193
.BR pdfseparate (1),
.BR pdfsig (1),
194
.BR pdfunite (1)