1pdfimages(1) General Commands Manual pdfimages(1)
2
6 pdfimages - Portable Document Format (PDF) image extractor (version
7 3.03)
8
10 pdfimages [options] PDF-file image-root
11
13 Pdfimages saves images from a Portable Document Format (PDF) file as
14 Portable Pixmap (PPM), Portable Bitmap (PBM), Portable Network Graphics
15 (PNG), Tagged Image File Format (TIFF), JPEG, JPEG2000, or JBIG2 files.
16 Pdfimages reads the PDF file PDF-file, scans one or more pages, and
18 writes one file for each image, image-root-nnn.xxx, where nnn is the
19 image number and xxx is the image type (.ppm, .pbm, .png, .tif, .jpg,
20 jp2, jb2e, or jb2g). If PDF-file is ´-', it reads the PDF file from
21 stdin.
22 The default output format is PBM (for monochrome images) or PPM for
24 non-monochrome. The -png or -tiff options change to default output to
25 PNG or TIFF respectively. If both -png and -tiff are specified, CMYK
26 images will be written as TIFF and all other images will be written as
27 PNG. In addition the -j, -jp2, and -jbig2 options will cause JPEG,
28 JPEG2000, and JBIG2, respectively, images in the PDF file to be written
29 in their native format.
30
32 -f number
33 Specifies the first page to scan.
34 -l number
36 Specifies the last page to scan.
37 -png Change the default output format to PNG.
39 -tiff Change the default output format to TIFF.
41 -j Write images in JPEG format as JPEG files instead of the default
43 format. The JPEG file is identical to the JPEG data stored in
44 the PDF.
45 -jp2 Write images in JPEG2000 format as JP2 files instead of the de‐
47 fault format. The JP2 file is identical to the JPEG2000 data
48 stored in the PDF.
49 -jbig2 Write images in JBIG2 format as JBIG2 files instead of the de‐
51 fault format. JBIG2 data in PDF is of the embedded type. The em‐
52 bedded type of JBIG2 has an optional separate file containing
53 global data. The embedded data is written with the extension
54 .jb2e and the global data (if available) will be written to the
55 same image number with the extension .jb2g. The content of both
56 these files is identical to the JBIG2 data in the PDF.
57 -ccitt Write images in CCITT format as CCITT files instead of the de‐
59 fault format. The CCITT file is identical to the CCITT data
60 stored in the PDF. PDF files contain additional parameters spec‐
61 ifying how to decode the CCITT data. These parameters are trans‐
62 lated to fax2tiff input options and written to a .params file
63 with the same image number. The parameters are:
64 -1 1D Group 3 encoding
66 -2 2D Group 3 encoding
68 -4 Group 4 encoding
70 -A Beginning of line is aligned on a byte boundary
72 -P Beginning of line is not aligned on a byte boundary
74 -X n The image width in pixels
76 -W Encoding uses 1 for black and 0 for white
78 -B Encoding uses 0 for black and 1 for white
80 -M Input data fills from most significant bit to least sig‐
82 nificant bit.
83 -all Write JPEG, JPEG2000, JBIG2, and CCITT images in their native
85 format. CMYK files are written as TIFF files. All other images
86 are written as PNG files. This is equivalent to specifying the
87 options -png -tiff -j -jp2 -jbig2 -ccitt.
88 -list Instead of writing the images, list the images along with vari‐
90 ous information for each image. Do not specify an image-root
91 with this option.
92 The following information is listed for each image:
94 page the page number containing the image
96 num the image number
98 type the image type:
100 image - an opaque image
102 mask - a monochrome mask image
103 smask - a soft-mask image
104 stencil - a monochrome mask image used for painting a
105 color or pattern
106 Note: Tranparency in images is represented in PDF using a sepa‐
108 rate image for the image and the mask/smask. The mask/smask
109 used as part of a transparent image always immediately follows
110 the image in the image list.
111 width image width (in pixels)
113 height image height (in pixels)
115 Note: the image width/height is the size of the embedded image,
117 not the size the image will be rendered at.
118 color image color space:
120 gray - Gray
122 rgb - RGB
123 cmyk - CMYK
124 lab - L*a*b
125 icc - ICC Based
126 index - Indexed Color
127 sep - Separation
128 devn - DeviceN
129 comp number of color components
131 bpc bits per component
133 enc encoding:
135 image - raster image (may be Flate or LZW compressed but
137 does not use an image encoding)
138 jpeg - Joint Photographic Experts Group
139 jp2 - JPEG2000
140 jbig2 - Joint Bi-Level Image Experts Group
141 ccitt - CCITT Group 3 or Group 4 Fax
142 interp "yes" if the interpolation is to be performed when scal‐
144 ing up the image
145 object ID
147 the image dictionary object ID (number and generation)
148 x-ppi The horizontal resolution of the image (in pixels per
150 inch) when rendered on the pdf page.
151 y-ppi The vertical resolution of the image (in pixels per inch)
153 when rendered on the pdf page.
154 size The size of the embedded image in the pdf file. The fol‐
156 lowing suffixes are used: 'B' bytes, 'K' kilobytes, 'M'
157 megabytes, and 'G' gigabytes.
158 ratio The compression ratio of the embedded image.
160 -opw password
162 Specify the owner password for the PDF file. Providing this
163 will bypass all security restrictions.
164 -upw password
166 Specify the user password for the PDF file.
167 -p Include page numbers in output file names.
169 -q Don't print any messages or errors.
171 -v Print copyright and version information.
173 -h Print usage information. (-help and --help are equivalent.)
175
177 The Xpdf tools use the following exit codes:
178 0 No error.
180 1 Error opening a PDF file.
182 2 Error opening an output file.
184 3 Error related to PDF permissions.
186 99 Other error.
188
190 The pdfimages software and documentation are copyright 1998-2011 Glyph
191 & Cog, LLC.
192
194 pdfdetach(1), pdffonts(1), pdfinfo(1), pdftocairo(1), pdftohtml(1),
195 pdftoppm(1), pdftops(1), pdftotext(1) pdfseparate(1), pdfsig(1), pdfu‐
196 nite(1)
197 15 August 2011 pdfimages(1)