PDF to Image / Command Line Reference

Conversion from PDF to image.

usage: pdf2image [options] source
source
Source to be converted. It can be URL, path to a local file or '-' to use stdin as an input text.

Options

Conversion Format

-output-format
The format of the output file.
Allowed values:
  • png
  • jpg
  • gif
  • tiff
  • bmp
  • ico
  • ppm
  • pgm
  • pbm
  • pnm
  • psb
  • pct
  • ras
  • tga
  • sgi
  • sun
  • webp
Default: png

General Options

-pdf-password
Password to open the encrypted PDF file.
-print-page-range
Set the page range to print.
Constraint:
  • A comma separated list of page numbers or ranges.
Examples:
  • Just the second page is printed.
    "2"
  • The first and the third page are printed.
    "1,3"
  • Everything except the first page is printed.
    "2-"
  • Just first 3 pages are printed.
    "-3"
  • Pages 3, 6, 7, 8 and 9 are printed.
    "3,6-9"
-dpi
Set the output graphics DPI.
Availability: API client >= 5.16.0, converter >= 20.10. See versioning.
Default: 144
-force-zip
Enforces the zip output format.
Allowed values:
  • true, 1 or on
  • false, 0 or off
Default: False
-use-cropbox
Use the crop box rather than media box.
Allowed values:
  • true, 1 or on
  • false, 0 or off
Default: False
-crop-area-x
Set the top left X coordinate of the crop area in points.
Constraint:
  • Must be a positive integer number or 0.
Default: 0
Example:
  • 100
-crop-area-y
Set the top left Y coordinate of the crop area in points.
Constraint:
  • Must be a positive integer number or 0.
Default: 0
Example:
  • 100
-crop-area-width
Set the width of the crop area in points.
Constraint:
  • Must be a positive integer number or 0.
Default: PDF page width.
Example:
  • 100
-crop-area-height
Set the height of the crop area in points.
Constraint:
  • Must be a positive integer number or 0.
Default: PDF page height.
Example:
  • 100
-use-grayscale
Generate a grayscale image.
Allowed values:
  • true, 1 or on
  • false, 0 or off
Default: False

Miscellaneous

-debug-log
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
Allowed values:
  • true, 1 or on
  • false, 0 or off
Default: False
-tag
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
Example:
  • "client-1234"
-http-proxy
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
Constraint:
  • The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • "myproxy.com:8080"
  • "113.25.84.10:33333"
-https-proxy
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
Constraint:
  • The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • "myproxy.com:443"
  • "113.25.84.10:44333"