summaryrefslogtreecommitdiff
path: root/Build/source/libs/xpdf/xpdf-src/doc/pdfimages.cat
blob: 97a0371573b43f453e9f746c008c66354119a71b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
pdfimages(1)                General Commands Manual               pdfimages(1)



NAME
       pdfimages  -  Portable  Document  Format (PDF) image extractor (version
       4.03)

SYNOPSIS
       pdfimages [options] PDF-file image-root

DESCRIPTION
       Pdfimages saves images from a Portable Document Format  (PDF)  file  as
       Portable  Pixmap  (PPM), Portable Graymap (PGM), Portable Bitmap (PBM),
       or JPEG files.

       Pdfimages reads the PDF file, scans one or more  pages,  PDF-file,  and
       writes  one  PPM,  PGM,  PBM,  or JPEG file for each image, image-root-
       nnnn.xxx, where nnnn is the image number and  xxx  is  the  image  type
       (.ppm, .pgm, .pbm, .jpg).

       NB:  pdfimages  extracts  the raw image data from the PDF file, without
       performing any additional transforms.  Any  rotation,  clipping,  color
       inversion, etc. done by the PDF content stream is ignored.

CONFIGURATION FILE
       Pdfimages  reads  a  configuration  file at startup.  It first tries to
       find the user's private config file, ~/.xpdfrc.  If that doesn't exist,
       it looks for a system-wide config file, typically /usr/local/etc/xpdfrc
       (but this location can be changed when pdfimages is  built).   See  the
       xpdfrc(5) man page for details.

OPTIONS
       Many  of  the following options can be set with configuration file com-
       mands.  These are listed in square brackets with the description of the
       corresponding command line option.

       -f number
              Specifies the first page to scan.

       -l number
              Specifies the last page to scan.

       -j     Normally, all images are written as PBM (for monochrome images),
              PGM (for grayscale images), or PPM  (for  color  images)  files.
              With  this option, images in DCT format are saved as JPEG files.
              All non-DCT images are saved in  PBM/PGM/PPM  format  as  usual.
              (Inline images are always saved in PBM/PGM/PPM format.)

       -raw   Write all images in PDF-native formats.  Most of the formats are
              not standard image formats, so this option is  primarily  useful
              as input to a tool that generates PDF files.  (Inline images are
              always saved in PBM/PGM/PPM format.)

       -list  Write a one-line summary to stdout for each image.  The  summary
              provides  the  image file name, the page number, the image width
              and height, the horizontal  and  vertical  resolution  (DPI)  as
              drawn,  the  color space type, and the number of bits per compo-
              nent (BPC).

       -opw password
              Specify the owner password for the  PDF  file.   Providing  this
              will bypass all security restrictions.

       -upw password
              Specify the user password for the PDF file.

       -q     Don't print any messages or errors.  [config file: errQuiet]

       -v     Print copyright and version information.

       -h     Print usage information.  (-help and --help are equivalent.)

EXIT CODES
       The Xpdf tools use the following exit codes:

       0      No error.

       1      Error opening a PDF file.

       2      Error opening an output file.

       3      Error related to PDF permissions.

       99     Other error.

AUTHOR
       The  pdfimages software and documentation are copyright 1998-2021 Glyph
       & Cog, LLC.

SEE ALSO
       xpdf(1),  pdftops(1),  pdftotext(1),  pdftohtml(1),  pdfinfo(1),   pdf-
       fonts(1), pdfdetach(1), pdftoppm(1), pdftopng(1), xpdfrc(5)
       http://www.xpdfreader.com/



                                  28 Jan 2021                     pdfimages(1)