apdf/doc/pdfimages.1

   1 .\" Copyright 1998-2005 Glyph & Cog, LLC
   2 .TH pdfimages 1 "17 August 2005"
   3 .SH NAME
   4 pdfimages \- Portable Document Format (PDF) image extractor
   5 (version 3.01)
   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 Bitmap (PBM), or JPEG files.
  14 .PP
  15 Pdfimages reads the PDF file, scans one or more pages,
  16 .IR PDF-file ,
  17 and writes one PPM, PBM, or JPEG file for each image,
  18 .IR image-root - nnn . xxx ,
  19 where
  20 .I nnn
  21 is the image number and
  22 .I xxx
  23 is the image type (.ppm, .pbm, .jpg).
  24 .PP
  25 NB: pdfimages extracts the raw image data from the PDF file, without
  26 performing any additional transforms.  Any rotation, clipping,
  27 color inversion, etc. done by the PDF content stream is ignored.
  28 .SH CONFIGURATION FILE
  29 Pdfimages reads a configuration file at startup.  It first tries to
  30 find the user's private config file, ~/.xpdfrc.  If that doesn't
  31 exist, it looks for a system-wide config file, typically
  32 /usr/local/etc/xpdfrc (but this location can be changed when pdfimages
  33 is built).  See the
  34 .BR xpdfrc (5)
  35 man page for details.
  36 .SH OPTIONS
  37 Many of the following options can be set with configuration file
  38 commands.  These are listed in square brackets with the description of
  39 the corresponding command line option.
  40 .TP
  41 .BI \-f " number"
  42 Specifies the first page to scan.
  43 .TP
  44 .BI \-l " number"
  45 Specifies the last page to scan.
  46 .TP
  47 .B \-j
  48 Normally, all images are written as PBM (for monochrome images) or PPM
  49 (for non-monochrome images) files.  With this option, images in DCT
  50 format are saved as JPEG files.  All non-DCT images are saved in
  51 PBM/PPM format as usual.
  52 .TP
  53 .BI \-opw " password"
  54 Specify the owner password for the PDF file.  Providing this will
  55 bypass all security restrictions.
  56 .TP
  57 .BI \-upw " password"
  58 Specify the user password for the PDF file.
  59 .TP
  60 .B \-q
  61 Don't print any messages or errors.
  62 .RB "[config file: " errQuiet ]
  63 .TP
  64 .B \-v
  65 Print copyright and version information.
  66 .TP
  67 .B \-h
  68 Print usage information.
  69 .RB ( \-help
  70 and
  71 .B \-\-help
  72 are equivalent.)
  73 .SH EXIT CODES
  74 The Xpdf tools use the following exit codes:
  75 .TP
  76 0
  77 No error.
  78 .TP
  79 1
  80 Error opening a PDF file.
  81 .TP
  82 2
  83 Error opening an output file.
  84 .TP
  85 3
  86 Error related to PDF permissions.
  87 .TP
  88 99
  89 Other error.
  90 .SH AUTHOR
  91 The pdfimages software and documentation are copyright 1998-2005 Glyph
  92 & Cog, LLC.
  93 .SH "SEE ALSO"
  94 .BR xpdf (1),
  95 .BR pdftops (1),
  96 .BR pdftotext (1),
  97 .BR pdfinfo (1),
  98 .BR pdffonts (1),
  99 .BR pdftoppm (1),
 100 .BR xpdfrc (5)
 101 .br
 102 .B http://www.foolabs.com/xpdf/