| 1 | .\" Copyright 1998-2017 Glyph & Cog, LLC
|
|---|
| 2 | .TH pdfimages 1 "10 Aug 2017"
|
|---|
| 3 | .SH NAME
|
|---|
| 4 | pdfimages \- Portable Document Format (PDF) image extractor
|
|---|
| 5 | (version 4.00)
|
|---|
| 6 | .SH SYNOPSIS
|
|---|
| 7 | .B pdfimages
|
|---|
| 8 | [options]
|
|---|
| 9 | .I PDF-file image-root
|
|---|
| 10 | .SH DESCRIPTION
|
|---|
| 11 | .B Pdfimages
|
|---|
| 12 | saves images from a Portable Document Format (PDF) file as Portable
|
|---|
| 13 | Pixmap (PPM), Portable Graymap (PGM), Portable Bitmap (PBM), or JPEG
|
|---|
| 14 | files.
|
|---|
| 15 | .PP
|
|---|
| 16 | Pdfimages reads the PDF file, scans one or more pages,
|
|---|
| 17 | .IR PDF-file ,
|
|---|
| 18 | and writes one PPM, PGM, PBM, or JPEG file for each image,
|
|---|
| 19 | .IR image-root - nnnn . xxx ,
|
|---|
| 20 | where
|
|---|
| 21 | .I nnnn
|
|---|
| 22 | is the image number and
|
|---|
| 23 | .I xxx
|
|---|
| 24 | is the image type (.ppm, .pgm, .pbm, .jpg).
|
|---|
| 25 | .PP
|
|---|
| 26 | NB: pdfimages extracts the raw image data from the PDF file, without
|
|---|
| 27 | performing any additional transforms. Any rotation, clipping,
|
|---|
| 28 | color inversion, etc. done by the PDF content stream is ignored.
|
|---|
| 29 | .SH CONFIGURATION FILE
|
|---|
| 30 | Pdfimages reads a configuration file at startup. It first tries to
|
|---|
| 31 | find the user's private config file, ~/.xpdfrc. If that doesn't
|
|---|
| 32 | exist, it looks for a system-wide config file, typically
|
|---|
| 33 | /usr/local/etc/xpdfrc (but this location can be changed when pdfimages
|
|---|
| 34 | is built). See the
|
|---|
| 35 | .BR xpdfrc (5)
|
|---|
| 36 | man page for details.
|
|---|
| 37 | .SH OPTIONS
|
|---|
| 38 | Many of the following options can be set with configuration file
|
|---|
| 39 | commands. These are listed in square brackets with the description of
|
|---|
| 40 | the corresponding command line option.
|
|---|
| 41 | .TP
|
|---|
| 42 | .BI \-f " number"
|
|---|
| 43 | Specifies the first page to scan.
|
|---|
| 44 | .TP
|
|---|
| 45 | .BI \-l " number"
|
|---|
| 46 | Specifies the last page to scan.
|
|---|
| 47 | .TP
|
|---|
| 48 | .B \-j
|
|---|
| 49 | Normally, all images are written as PBM (for monochrome images), PGM
|
|---|
| 50 | (for grayscale images), or PPM (for color images) files. With this
|
|---|
| 51 | option, images in DCT format are saved as JPEG files. All non-DCT
|
|---|
| 52 | images are saved in PBM/PGM/PPM format as usual. (Inline images are
|
|---|
| 53 | always saved in PBM/PGM/PPM format.)
|
|---|
| 54 | .TP
|
|---|
| 55 | .B \-raw
|
|---|
| 56 | Write all images in PDF-native formats. Most of the formats are not
|
|---|
| 57 | standard image formats, so this option is primarily useful as input to
|
|---|
| 58 | a tool that generates PDF files. (Inline images are always saved in
|
|---|
| 59 | PBM/PGM/PPM format.)
|
|---|
| 60 | .TP
|
|---|
| 61 | .B \-list
|
|---|
| 62 | Write a one-line summary to stdout for each image. The summary
|
|---|
| 63 | provides the image file name, the page number, the image width and
|
|---|
| 64 | height, the horizontal and vertical resolution (DPI) as drawn, the
|
|---|
| 65 | color space type, and the number of bits per component (BPC).
|
|---|
| 66 | .TP
|
|---|
| 67 | .BI \-opw " password"
|
|---|
| 68 | Specify the owner password for the PDF file. Providing this will
|
|---|
| 69 | bypass all security restrictions.
|
|---|
| 70 | .TP
|
|---|
| 71 | .BI \-upw " password"
|
|---|
| 72 | Specify the user password for the PDF file.
|
|---|
| 73 | .TP
|
|---|
| 74 | .B \-q
|
|---|
| 75 | Don't print any messages or errors.
|
|---|
| 76 | .RB "[config file: " errQuiet ]
|
|---|
| 77 | .TP
|
|---|
| 78 | .B \-v
|
|---|
| 79 | Print copyright and version information.
|
|---|
| 80 | .TP
|
|---|
| 81 | .B \-h
|
|---|
| 82 | Print usage information.
|
|---|
| 83 | .RB ( \-help
|
|---|
| 84 | and
|
|---|
| 85 | .B \-\-help
|
|---|
| 86 | are equivalent.)
|
|---|
| 87 | .SH EXIT CODES
|
|---|
| 88 | The Xpdf tools use the following exit codes:
|
|---|
| 89 | .TP
|
|---|
| 90 | 0
|
|---|
| 91 | No error.
|
|---|
| 92 | .TP
|
|---|
| 93 | 1
|
|---|
| 94 | Error opening a PDF file.
|
|---|
| 95 | .TP
|
|---|
| 96 | 2
|
|---|
| 97 | Error opening an output file.
|
|---|
| 98 | .TP
|
|---|
| 99 | 3
|
|---|
| 100 | Error related to PDF permissions.
|
|---|
| 101 | .TP
|
|---|
| 102 | 99
|
|---|
| 103 | Other error.
|
|---|
| 104 | .SH AUTHOR
|
|---|
| 105 | The pdfimages software and documentation are copyright 1998-2017 Glyph
|
|---|
| 106 | & Cog, LLC.
|
|---|
| 107 | .SH "SEE ALSO"
|
|---|
| 108 | .BR xpdf (1),
|
|---|
| 109 | .BR pdftops (1),
|
|---|
| 110 | .BR pdftotext (1),
|
|---|
| 111 | .BR pdftohtml (1),
|
|---|
| 112 | .BR pdfinfo (1),
|
|---|
| 113 | .BR pdffonts (1),
|
|---|
| 114 | .BR pdfdetach (1),
|
|---|
| 115 | .BR pdftoppm (1),
|
|---|
| 116 | .BR pdftopng (1),
|
|---|
| 117 | .BR xpdfrc (5)
|
|---|
| 118 | .br
|
|---|
| 119 | .B http://www.xpdfreader.com/
|
|---|
