1Usage: pdf2image [<options>] file...
2
3OPTIONS:
4
5 --file... arg A list of folders and/or file names to process.
6
7 -o [ --output ] arg The output folder used to store rasterized files.
8 By default, the currently selected working folder
9 will be used to store converted image files.
10
11 --prefix arg The prefix for the output image file. The output
12 filename will be constructed by appending the
13 prefix string, the page number, and the
14 appropriate image extension (e.g. myprefix1.png,
15 myprefix2.png, etc). The prefix option should be
16 used only for conversion of individual documents.
17 By default, each input filename will be used as a
18 prefix.
19
20 --digits arg The number of digits used in the page counter
21 portion of the output filename. By default, new
22 digits are added as needed; however this parameter
23 could be used to format the page counter field to
24 a uniform width (e.g. myfile0001.jpg,
25 myfile0002.jpg, etc).
26
27 --subfolders Process all sub-directory for every directory
28 specified in the argument list. By default,
29 sub-directories are not processed.
30
31 -f [ --format ] arg (=png) Output image format. The following is a list of
32 supported export formats:
33 png
34 png8 (palettized png)
35 jpg (or jpeg)
36 tif (or tiff)
37 tif8 (palettized tiff)
38 bmp
39 raw
40 The default output image format is PNG.
41
42 --separations Output separations separately (as distinct image
43 channels). In formats that support NChannel
44 output, the output will remain in one file.
45 Otherwise, each page will be rasterized into a
46 number of 1 channel images, one for each separate
47 ink present in the document. This option
48 automatically enables overprint preview mode.
49
50 -d [ --dpi ] arg (=92) The output resolution, from 1 to 1000, in Dots Per
51 Inch (DPI). The higher the DPI, the larger the
52 image. Resolutions larger than 1000 DPI can be
53 achieved by rendering image in tiles or stripes.
54 The default resolution is 92 DPI.
55
56 --nocms Disable color management system. By default,
57 PDF2Image uses lcms
58
59 --icc_rgb arg Specifies RGB ICC profile.
60
61 --icc_cmyk arg Specifies CMYK ICC profile.
62
63 --hres arg The width of the output image, in pixels.
64
65 --vres arg The height of the output image, in pixels.
66
67 -a [ --pages ] arg (=-) Specifies the list of pages to convert. By
68 default, all pages are converted.
69
70 -b [ --box ] arg (=crop) Specifies the page box/region to rasterize.
71 Possible values are:
72 media
73 crop
74 trim
75 bleed
76 art
77 By default, page crop region will be rasterized.
78
79 -c [ --clip ] arg User definable clip box. By default, the clip
80 region is identical to current page 'box'.
81
82 -r [ --rotate ] arg (=0) Rotates all pages by a given number of degrees
83 counterclockwise. The allowed values are 0, 90,
84 180, and 270. The default value is 0.
85
86 -g [ --gray ] Render and export the image in grayscale mode.
87 Sets pixel format to 8 bits per pixel grayscale.
88 By default, the image is rendered and exported in
89 RGB color space.
90
91 --mono Export the rendered image as 1 bit per pixel
92 (monochrome) image. If the output format is TIFF,
93 the image will be compressed using G4 CCITT
94 compression algorithm. By default, the image is
95 not dithered. To enable dithering use '--dither'
96 option.
97
98 -k [ --cmyk ] Render and export the image in CMYK mode. To
99 export CMYK, the output image format must support
100 CMYK pixel format. An example of image format that
101 supports CMYK is TIFF (e.g. -f tif -k). By
102 default, the image is rendered and exported in RGB
103 color space.
104
105 --config arg Load xml file to configure font substitution for
106 missing fonts. By default, tries to load the file
107 "config.xml" in the current working directory.
108
109 --dither Enables dithering when the image is exported in
110 palletized or monochrome mode (e.g. when export
111 format is tif8, png8 or --mono).
112
113 --gamma arg (=0) Sets the gamma factor used for anti-aliased
114 rendering. Typical values are in the range from
115 0.1 to 3. Gamma correction can be used to improve
116 the quality of anti-aliased image output and can
117 (to some extent) decrease the appearance common
118 anti-aliasing artifacts (such as pixel width lines
119 between polygons).
120
121 -q [ --quality ] arg (=80) Compression quality is a number in the range from
122 1 to 100. Lower numbers usually result in better
123 compression at the expense of image quality. The
124 default setting is 80.
125
126 -m [ --multipage ] If the output image format supports multi-page or
127 multi-frame capability, store all output images in
128 one file instead of separate files. Currently,
129 this option is only relevant to TIFF output. By
130 default, images will be saved in separate files.
131
132 --printmode Renders annotations in the print mode. This option
133 can be used to render 'Print Only' annotations and
134 to hide 'Screen Only' annotations.
135
136 --transparent_page Sets the page color to transparent. By default,
137 PDF2Image assumes that the page is drawn directly
138 on an opaque white surface. Some applications may
139 need to draw the page on a different backdrop. In
140 this case any pixels that are not covered during
141 rendering will be transparent.
142
143 --op arg (=pdfx) Specifies if overprint simulation is used.
144 Overprint is a device dependent feature and the
145 results will vary depending on the output color
146 space and supported colorants (i.e. CMYK,
147 CMYK+spot, RGB, etc). Possible values are:
148 off, overprint is turned off
149 on, overprint is turned on
150 pdfx, overprint is turned on only for PDF/X
151 files
152 By default, pdfx is used.
153
154 --noannots Disables drawing of annotations.
155
156 --nosmooth Disables image smoothing.
157
158 --noprompt Disables any user input. By default, the
159 application will ask for a valid password if the
160 password is incorrect.
161
162 -p [ --pass ] arg The password for secured PDF files. Not required
163 if the input document is not secured using the
164 'open' password.
165
166 --extension arg (=.pdf) The default file extension used to process PDF
167 documents. The default extension is ".pdf".
168
169 --verb arg (=1) Set the opt.m_verbosity level to 'arg' (0-2).
170
171 -v [ --version ] Print the version information.
172
173 -h [ --help ] Print a listing of available options.
174
175
176
177Examples:
178 pdf2image -o test_out/ex1 test/tiger.pdf
179 pdf2image -o test_out/ex2 --hres 100 --vres 100 --rotate 90 test/tiger.pdf
180 pdf2image -o test_out/ex3 -f tif --multipage --gray -p secret --rotate 270 --verb 3 test/blue_secret.pdf
181 pdf2image -o test_out/ex4 --dpi 3000 -f jpg -c 216,522,330,600 test/tiger.pdf
182 pdf2image -o test_out/ex5 --dpi 200 -f tif --multipage --pass secret --verb 3 test
183 pdf2image -o test_out/ex6 --hres 100 --format jpg --pass secret --subfolders --verb 3 test
Did you find this helpful?
Trial setup questions?
Ask experts on DiscordNeed other help?
Contact SupportPricing or product questions?
Contact Sales