arospdf/doc/pdfinfo.1

   1 .\" Copyright 1999-2007 Glyph & Cog, LLC
   2 .TH pdfinfo 1 "27 February 2007"
   3 .SH NAME
   4 pdfinfo \- Portable Document Format (PDF) document information
   5 extractor (version 3.02)
   6 .SH SYNOPSIS
   7 .B pdfinfo
   8 [options]
   9 .RI [ PDF-file ]
  10 .SH DESCRIPTION
  11 .B Pdfinfo
  12 prints the contents of the \'Info' dictionary (plus some other useful
  13 information) from a Portable Document Format (PDF) file.
  14 .PP
  15 The \'Info' dictionary contains the following values:
  16 .PP
  17 .RS
  18 title
  19 .RE
  20 .RS
  21 subject
  22 .RE
  23 .RS
  24 keywords
  25 .RE
  26 .RS
  27 author
  28 .RE
  29 .RS
  30 creator
  31 .RE
  32 .RS
  33 producer
  34 .RE
  35 .RS
  36 creation date
  37 .RE
  38 .RS
  39 modification date
  40 .RE
  41 .PP
  42 In addition, the following information is printed:
  43 .PP
  44 .RS
  45 tagged (yes/no)
  46 .RE
  47 .RS
  48 page count
  49 .RE
  50 .RS
  51 encrypted flag (yes/no)
  52 .RE
  53 .RS
  54 print and copy permissions (if encrypted)
  55 .RE
  56 .RS
  57 page size
  58 .RE
  59 .RS
  60 file size
  61 .RE
  62 .RS
  63 linearized (yes/no)
  64 .RE
  65 .RS
  66 PDF version
  67 .RE
  68 .RS
  69 metadata (only if requested)
  70 .RE
  71 .SH CONFIGURATION FILE
  72 Pdfinfo reads a configuration file at startup.  It first tries to find
  73 the user's private config file, ~/.xpdfrc.  If that doesn't exist, it
  74 looks for a system-wide config file, typically /usr/local/etc/xpdfrc
  75 (but this location can be changed when pdfinfo is built).  See the
  76 .BR xpdfrc (5)
  77 man page for details.
  78 .SH OPTIONS
  79 Many of the following options can be set with configuration file
  80 commands.  These are listed in square brackets with the description of
  81 the corresponding command line option.
  82 .TP
  83 .BI \-f " number"
  84 Specifies the first page to examine.  If multiple pages are requested
  85 using the "-f" and "-l" options, the size of each requested page (and,
  86 optionally, the bounding boxes for each requested page) are printed.
  87 Otherwise, only page one is examined.
  88 .TP
  89 .BI \-l " number"
  90 Specifies the last page to examine.
  91 .TP
  92 .B \-box
  93 Prints the page box bounding boxes: MediaBox, CropBox, BleedBox,
  94 TrimBox, and ArtBox.
  95 .TP
  96 .B \-meta
  97 Prints document-level metadata.  (This is the "Metadata" stream from
  98 the PDF file's Catalog object.)
  99 .TP
 100 .BI \-enc " encoding-name"
 101 Sets the encoding to use for text output.  The
 102 .I encoding\-name
 103 must be defined with the unicodeMap command (see
 104 .BR xpdfrc (5)).
 105 This defaults to "Latin1" (which is a built-in encoding).
 106 .RB "[config file: " textEncoding ]
 107 .TP
 108 .BI \-opw " password"
 109 Specify the owner password for the PDF file.  Providing this will
 110 bypass all security restrictions.
 111 .TP
 112 .BI \-upw " password"
 113 Specify the user password for the PDF file.
 114 .TP
 115 .BI \-cfg " config-file"
 116 Read
 117 .I config-file
 118 in place of ~/.xpdfrc or the system-wide config file.
 119 .TP
 120 .B \-v
 121 Print copyright and version information.
 122 .TP
 123 .B \-h
 124 Print usage information.
 125 .RB ( \-help
 126 and
 127 .B \-\-help
 128 are equivalent.)
 129 .SH EXIT CODES
 130 The Xpdf tools use the following exit codes:
 131 .TP
 132 0
 133 No error.
 134 .TP
 135 1
 136 Error opening a PDF file.
 137 .TP
 138 2
 139 Error opening an output file.
 140 .TP
 141 3
 142 Error related to PDF permissions.
 143 .TP
 144 99
 145 Other error.
 146 .SH AUTHOR
 147 The pdfinfo software and documentation are copyright 1996-2007 Glyph &
 148 Cog, LLC.
 149 .SH "SEE ALSO"
 150 .BR xpdf (1),
 151 .BR pdftops (1),
 152 .BR pdftotext (1),
 153 .BR pdffonts (1),
 154 .BR pdftoppm (1),
 155 .BR pdfimages (1),
 156 .BR xpdfrc (5)
 157 .br
 158 .B http://www.foolabs.com/xpdf/