| .\" Copyright 1998-2011 Glyph & Cog, LLC |
| .TH pdfimages 1 "15 August 2011" |
| .SH NAME |
| pdfimages \- Portable Document Format (PDF) image extractor |
| (version 3.03) |
| .SH SYNOPSIS |
| .B pdfimages |
| [options] |
| .I PDF-file image-root |
| .SH DESCRIPTION |
| .B Pdfimages |
| saves images from a Portable Document Format (PDF) file as Portable |
| Pixmap (PPM), Portable Bitmap (PBM), or JPEG files. |
| .PP |
| Pdfimages reads the PDF file |
| .IR PDF-file , |
| scans one or more pages, and writes one PPM, PBM, or JPEG file for each image, |
| .IR image-root - nnn . xxx , |
| where |
| .I nnn |
| is the image number and |
| .I xxx |
| is the image type (.ppm, .pbm, .jpg). |
| .SH OPTIONS |
| .TP |
| .BI \-f " number" |
| Specifies the first page to scan. |
| .TP |
| .BI \-l " number" |
| Specifies the last page to scan. |
| .TP |
| .B \-j |
| Normally, all images are written as PBM (for monochrome images) or PPM |
| (for non-monochrome images) files. With this option, images in DCT |
| format are saved as JPEG files. All non-DCT images are saved in |
| PBM/PPM format as usual. |
| .TP |
| .B \-list |
| Instead of writing the images, list the images along with various information for each image. Do not specify an |
| .IR image-root |
| with this option. |
| .IP |
| The following information is listed for each font: |
| .RS |
| .TP |
| .B page |
| the page number containing the image |
| .TP |
| .B num |
| the image number |
| .TP |
| .B type |
| the image type: |
| .PP |
| .RS |
| image - an opaque image |
| .RE |
| .RS |
| mask - a monochrome mask image |
| .RE |
| .RS |
| smask - a soft-mask image |
| .RE |
| .RS |
| stencil - a monochrome mask image used for painting a color or pattern |
| .RE |
| .PP |
| Note: Tranparency in images is represented in PDF using a separate image for the image and the mask/smask. |
| The mask/smask used as part of a transparent image always immediately follows the image in the image list. |
| .TP |
| .B width |
| image width (in pixels) |
| .TP |
| .B height |
| image height (in pixels) |
| .PP |
| Note: the image width/height is the size of the embedded image, not the size the image will be rendered at. |
| .TP |
| .B color |
| image color space: |
| .PP |
| .RS |
| gray - Gray |
| .RE |
| .RS |
| rgb - RGB |
| .RE |
| .RS |
| cmyk - CMYK |
| .RE |
| .RS |
| lab - L*a*b |
| .RE |
| .RS |
| icc - ICC Based |
| .RE |
| .RS |
| index - Indexed Color |
| .RE |
| .RS |
| sep - Separation |
| .RE |
| .RS |
| devn - DeviceN |
| .RE |
| .TP |
| .B comp |
| number of color components |
| .TP |
| .B bpc |
| bits per component |
| .TP |
| .B enc |
| encoding: |
| .PP |
| .RS |
| image - raster image (may be Flate or LZW compressed but does not use an image encoding) |
| .RE |
| .RS |
| jpeg - Joint Photographic Experts Group |
| .RE |
| .RS |
| jp2 - JPEG2000 |
| .RE |
| .RS |
| jbig2 - Joint Bi-Level Image Experts Group |
| .RE |
| .RS |
| ccitt - CCITT Group 3 or Group 4 Fax |
| .RE |
| .TP |
| .B interp |
| "yes" if the interpolation is to be performed when scaling up the image |
| .TP |
| .B object ID |
| the font dictionary object ID (number and generation) |
| .RE |
| .TP |
| .BI \-opw " password" |
| Specify the owner password for the PDF file. Providing this will |
| bypass all security restrictions. |
| .TP |
| .BI \-upw " password" |
| Specify the user password for the PDF file. |
| .TP |
| .B \-p |
| Include page numbers in output file names. |
| .TP |
| .B \-q |
| Don't print any messages or errors. |
| .TP |
| .B \-v |
| Print copyright and version information. |
| .TP |
| .B \-h |
| Print usage information. |
| .RB ( \-help |
| and |
| .B \-\-help |
| are equivalent.) |
| .SH EXIT CODES |
| The Xpdf tools use the following exit codes: |
| .TP |
| 0 |
| No error. |
| .TP |
| 1 |
| Error opening a PDF file. |
| .TP |
| 2 |
| Error opening an output file. |
| .TP |
| 3 |
| Error related to PDF permissions. |
| .TP |
| 99 |
| Other error. |
| .SH AUTHOR |
| The pdfimages software and documentation are copyright 1998-2011 Glyph |
| & Cog, LLC. |
| .SH "SEE ALSO" |
| .BR pdfdetach (1) |
| .BR pdffonts (1), |
| .BR pdfinfo (1), |
| .BR pdftocairo (1), |
| .BR pdftohtml (1), |
| .BR pdftoppm (1), |
| .BR pdftops (1), |
| .BR pdftotext (1) |