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).
21 The default output format is PBM (for monochrome images) or PPM for
23 non-monochrome. The -png or -tiff options change to default output to
24 PNG or TIFF respectively. If both -png and -tiff are specified, CMYK
25 images will be written as TIFF and all other images will be written as
26 PNG. In addition the -j, -jp2, and -jbig2 options will cause JPEG,
27 JPEG2000, and JBIG2, respectively, images in the PDF file to be written
28 in their native format.
29
31 -f number
32 Specifies the first page to scan.
33 -l number
35 Specifies the last page to scan.
36 -png Change the default output format to PNG.
38 -tiff Change the default output format to TIFF.
40 -j Write images in JPEG format as JPEG files instead of the default
42 format. The JPEG file is identical to the JPEG data stored in
43 the PDF.
44 -jp2 Write images in JPEG2000 format as JP2 files instead of the
46 default format. The JP2 file is identical to the JPEG2000 data
47 stored in the PDF.
48 -jbig2 Write images in JBIG2 format as JBIG2 files instead of the
50 default format. JBIG2 data in PDF is of the embedded type. The
51 embedded type of JBIG2 has an optional separate file containing
52 global data. The embedded data is written with the extension
53 .jb2e and the global data (if available) will be written to the
54 same image number with the extension .jb2g. The content of both
55 these files is identical to the JBIG2 data in the PDF.
56 -ccitt Write images in CCITT format as CCITT files instead of the
58 default format. The CCITT file is identical to the CCITT data
59 stored in the PDF. PDF files contain additional parameters spec‐
60 ifying how to decode the CCITT data. These parameters are trans‐
61 lated to fax2tiff input options and written to a .params file
62 with the same image number. The parameters are:
63 -1 1D Group 3 encoding
65 -2 2D Group 3 encoding
67 -4 Group 4 encoding
69 -A Beginning of line is aligned on a byte boundary
71 -P Beginning of line is not aligned on a byte boundary
73 -X n The image width in pixels
75 -W Encoding uses 1 for black and 0 for white
77 -B Encoding uses 0 for black and 1 for white
79 -M Input data fills from most significant bit to least sig‐
81 nificant bit.
82 -all Write JPEG, JPEG2000, JBIG2, and CCITT images in their native
84 format. CMYK files are written as TIFF files. All other images
85 are written as PNG files. This is equivalent to specifying the
86 options -png -tiff -j -jp2 -jbig2 -ccitt.
87 -list Instead of writing the images, list the images along with vari‐
89 ous information for each image. Do not specify an image-root
90 with this option.
91 The following information is listed for each image:
93 page the page number containing the image
95 num the image number
97 type the image type:
99 image - an opaque image
101 mask - a monochrome mask image
102 smask - a soft-mask image
103 stencil - a monochrome mask image used for painting a
104 color or pattern
105 Note: Tranparency in images is represented in PDF using a sepa‐
107 rate image for the image and the mask/smask. The mask/smask
108 used as part of a transparent image always immediately follows
109 the image in the image list.
110 width image width (in pixels)
112 height image height (in pixels)
114 Note: the image width/height is the size of the embedded image,
116 not the size the image will be rendered at.
117 color image color space:
119 gray - Gray
121 rgb - RGB
122 cmyk - CMYK
123 lab - L*a*b
124 icc - ICC Based
125 index - Indexed Color
126 sep - Separation
127 devn - DeviceN
128 comp number of color components
130 bpc bits per component
132 enc encoding:
134 image - raster image (may be Flate or LZW compressed but
136 does not use an image encoding)
137 jpeg - Joint Photographic Experts Group
138 jp2 - JPEG2000
139 jbig2 - Joint Bi-Level Image Experts Group
140 ccitt - CCITT Group 3 or Group 4 Fax
141 interp "yes" if the interpolation is to be performed when scal‐
143 ing up the image
144 object ID
146 the image dictionary object ID (number and generation)
147 x-ppi The horizontal resolution of the image (in pixels per
149 inch) when rendered on the pdf page.
150 y-ppi The vertical resolution of the image (in pixels per inch)
152 when rendered on the pdf page.
153 size The size of the embedded image in the pdf file. The fol‐
155 lowing suffixes are used: 'B' bytes, 'K' kilobytes, 'M'
156 megabytes, and 'G' gigabytes.
157 ratio The compression ratio of the embedded image.
159 -opw password
161 Specify the owner password for the PDF file. Providing this
162 will bypass all security restrictions.
163 -upw password
165 Specify the user password for the PDF file.
166 -p Include page numbers in output file names.
168 -q Don't print any messages or errors.
170 -v Print copyright and version information.
172 -h Print usage information. (-help and --help are equivalent.)
174
176 The Xpdf tools use the following exit codes:
177 0 No error.
179 1 Error opening a PDF file.
181 2 Error opening an output file.
183 3 Error related to PDF permissions.
185 99 Other error.
187
189 The pdfimages software and documentation are copyright 1998-2011 Glyph
190 & Cog, LLC.
191
193 pdfdetach(1), pdffonts(1), pdfinfo(1), pdftocairo(1), pdftohtml(1),
194 pdftoppm(1), pdftops(1), pdftotext(1) pdfseparate(1), pdfsig(1), pdfu‐
195 nite(1)
196 15 August 2011 pdfimages(1)