apdf/README

   1 Xpdf
   2 ====
   3
   4 version 3.01
   5 2005-aug-17
   6
   7 The Xpdf software and documentation are
   8 copyright 1996-2005 Glyph & Cog, LLC.
   9
  10 Email: derekn@foolabs.com
  11 WWW: http://www.foolabs.com/xpdf/
  12
  13 The PDF data structures, operators, and specification are
  14 copyright 1985-2004 Adobe Systems Inc.
  15
  16
  17 What is Xpdf?
  18 -------------
  19
  20 Xpdf is an open source viewer for Portable Document Format (PDF)
  21 files.  (These are also sometimes also called 'Acrobat' files, from
  22 the name of Adobe's PDF software.)  The Xpdf project also includes a
  23 PDF text extractor, PDF-to-PostScript converter, and various other
  24 utilities.
  25
  26 Xpdf runs under the X Window System on UNIX, VMS, and OS/2.  The non-X
  27 components (pdftops, pdftotext, etc.) also run on Win32 systems and
  28 should run on pretty much any system with a decent C++ compiler.
  29
  30 Xpdf is designed to be small and efficient.  It can use Type 1 or
  31 TrueType fonts.
  32
  33
  34 Distribution
  35 ------------
  36
  37 Xpdf is licensed under the GNU General Public License (GPL), version
  38 2.  In my opinion, the GPL is a convoluted, confusing, ambiguous mess.
  39 But it's also pervasive, and I'm sick of arguing.  And even if it is
  40 confusing, the basic idea is good.
  41
  42 In order to cut down on the confusion a little bit, here are some
  43 informal clarifications:
  44
  45 - I don't mind if you redistribute Xpdf in source and/or binary form,
  46   as long as you include all of the documentation: README, man pages
  47   (or help files), and COPYING.  (Note that the README file contains a
  48   pointer to a web page with the source code.)
  49
  50 - Selling a CD-ROM that contains Xpdf is fine with me, as long as it
  51   includes the documentation.  I wouldn't mind receiving a sample
  52   copy, but it's not necessary.
  53
  54 - If you make useful changes to Xpdf, please make the source code
  55   available -- post it on a web site, email it to me, whatever.
  56
  57 If you're interested in commercial licensing, please see the Glyph &
  58 Cog web site:
  59
  60     http://www.glyphandcog.com/
  61
  62
  63 Compatibility
  64 -------------
  65
  66 Xpdf is developed and tested on a Linux 2.4 x86 system.
  67
  68 In addition, it has been compiled by others on Solaris, AIX, HP-UX,
  69 Digital Unix, Irix, and numerous other Unix implementations, as well
  70 as VMS and OS/2.  It should work on pretty much any system which runs
  71 X11 and has Unix-like libraries.  You'll need ANSI C++ and C compilers
  72 to compile it.
  73
  74 The non-X components of Xpdf (pdftops, pdftotext, pdfinfo, pdffonts,
  75 pdftoppm, and pdfimages) can also be compiled on Win32 systems.  See
  76 the Xpdf web page for details.
  77
  78 If you compile Xpdf for a system not listed on the web page, please
  79 let me know.  If you're willing to make your binary available by ftp
  80 or on the web, I'll be happy to add a link from the Xpdf web page.  I
  81 have decided not to host any binaries I didn't compile myself (for
  82 disk space and support reasons).
  83
  84 If you can't get Xpdf to compile on your system, send me email and
  85 I'll try to help.
  86
  87 Xpdf has been ported to the Acorn, Amiga, BeOS, and EPOC.  See the
  88 Xpdf web page for links.
  89
  90
  91 Getting Xpdf
  92 ------------
  93
  94 The latest version is available from:
  95
  96   http://www.foolabs.com/xpdf/
  97
  98 or:
  99
 100   ftp://ftp.foolabs.com/pub/xpdf/
 101
 102 Source code and several precompiled executables are available.
 103
 104 Announcements of new versions are posted to several newsgroups
 105 (comp.text.pdf, comp.os.linux.announce, and others) and emailed to a
 106 list of people.  If you'd like to receive email notification of new
 107 versions, just let me know.
 108
 109
 110 Running Xpdf
 111 ------------
 112
 113 To run xpdf, simply type:
 114
 115   xpdf file.pdf
 116
 117 To generate a PostScript file, hit the "print" button in xpdf, or run
 118 pdftops:
 119
 120   pdftops file.pdf
 121
 122 To generate a plain text file, run pdftotext:
 123
 124   pdftotext file.pdf
 125
 126 There are four additional utilities (which are fully described in
 127 their man pages):
 128
 129   pdfinfo -- dumps a PDF file's Info dictionary (plus some other
 130              useful information)
 131   pdffonts -- lists the fonts used in a PDF file along with various
 132               information for each font
 133   pdftoppm -- converts a PDF file to a series of PPM/PGM/PBM-format
 134               bitmaps
 135   pdfimages -- extracts the images from a PDF file
 136
 137 Command line options and many other details are described in the man
 138 pages (xpdf.1, etc.) and the VMS help files (xpdf.hlp, etc.).
 139
 140
 141 Upgrading from Xpdf 2.xx
 142 ------------------------
 143
 144 WARNING: Xpdf 3.00 switched to a new PDF rasterizer, which no longer
 145 uses X fonts.  You'll need a set of Base-14 fonts -- the URW fonts
 146 distributed with ghostscript can be used for this.  Xpdf will search
 147 for the URW fonts, but if you have them installed in a non-standard
 148 directory, you'll need to set up an xpdfrc config file to point to
 149 them.  For full details, please see the xpdfrc(5) man page.
 150
 151
 152 Compiling Xpdf
 153 --------------
 154
 155 See the separate file, INSTALL.
 156
 157
 158 Bugs
 159 ----
 160
 161 If you find a bug in Xpdf, i.e., if it prints an error message,
 162 crashes, or incorrectly displays a document, and you don't see that
 163 bug listed here, please send me email, with a pointer (URL, ftp site,
 164 etc.) to the PDF file.
 165
 166
 167 Acknowledgments
 168 ---------------
 169
 170 Thanks to:
 171
 172 * Patrick Voigt for help with the remote server code.
 173 * Patrick Moreau, Martin P.J. Zinser, and David Mathog for the VMS
 174   port.
 175 * David Boldt and Rick Rodgers for sample man pages.
 176 * Brendan Miller for the icon idea.
 177 * Olly Betts for help testing pdftotext.
 178 * Peter Ganten for the OS/2 port.
 179 * Michael Richmond for the Win32 port of pdftops and pdftotext and the
 180   xpdf/cygwin/XFree86 build instructions.
 181 * Frank M. Siegert for improvements in the PostScript code.
 182 * Leo Smiers for the decryption patches.
 183 * Rainer Menzner for creating t1lib, and for helping me adapt it to
 184   xpdf.
 185 * Pine Tree Systems A/S for funding the OPI and EPS support in
 186   pdftops.
 187 * Easy Software Products for funding several improvements to the
 188   PostScript output code.
 189 * Tom Kacvinsky for help with FreeType and for being my interface to
 190   the FreeType team.
 191 * Theppitak Karoonboonyanan for help with Thai support.
 192 * Leonard Rosenthol for help and contributions on a bunch of things.
 193 * Alexandros Diamantidis and Maria Adaloglou for help with Greek
 194   support.
 195 * Lawrence Lai for help with the CJK Unicode maps.
 196
 197 Various people have contributed modifications made for use by the
 198 pdftex project:
 199
 200 * Han The Thanh
 201 * Martin Schröder of ArtCom GmbH
 202
 203
 204 References
 205 ----------
 206
 207 Adobe Systems Inc., _PDF Reference: Adobe Portable Document Format
 208 Version 1.6_.
 209 http://partners.adobe.com/public/developer/pdf/index_reference.html
 210 [The manual for PDF version 1.6.]
 211
 212 Adobe Systems Inc., _PostScript Language Reference_, 3rd ed.
 213 Addison-Wesley, 1999, ISBN 0-201-37922-8.
 214 [The official PostScript manual.]
 215
 216 Adobe Systems, Inc., _The Type 42 Font Format Specification_,
 217 Adobe Developer Support Technical Specification #5012.  1998.
 218 http://partners.adobe.com/asn/developer/pdfs/tn/5012.Type42_Spec.pdf
 219 [Type 42 is the format used to embed TrueType fonts in PostScript
 220 files.]
 221
 222 Adobe Systems, Inc., _Adobe CMap and CIDFont Files Specification_,
 223 Adobe Developer Support Technical Specification #5014.  1995.
 224 http://www.adobe.com/supportservice/devrelations/PDFS/TN/5014.CIDFont_Spec.pdf
 225 [CMap file format needed for Japanese and Chinese font support.]
 226
 227 Adobe Systems, Inc., _Adobe-Japan1-4 Character Collection for
 228 CID-Keyed Fonts_, Adobe Developer Support Technical Note #5078.
 229 2000.
 230 http://partners.adobe.com/asn/developer/PDFS/TN/5078.CID_Glyph.pdf
 231 [The Adobe Japanese character set.]
 232
 233 Adobe Systems, Inc., _Adobe-GB1-4 Character Collection for
 234 CID-Keyed Fonts_, Adobe Developer Support Technical Note #5079.
 235 2000.
 236 http://partners.adobe.com/asn/developer/pdfs/tn/5079.Adobe-GB1-4.pdf
 237 [The Adobe Chinese GB (simplified) character set.]
 238
 239 Adobe Systems, Inc., _Adobe-CNS1-3 Character Collection for
 240 CID-Keyed Fonts_, Adobe Developer Support Technical Note #5080.
 241 2000.
 242 http://partners.adobe.com/asn/developer/PDFS/TN/5080.CNS_CharColl.pdf
 243 [The Adobe Chinese CNS (traditional) character set.]
 244
 245 Adobe Systems Inc., _Supporting the DCT Filters in PostScript Level
 246 2_, Adobe Developer Support Technical Note #5116.  1992.
 247 http://www.adobe.com/supportservice/devrelations/PDFS/TN/5116.PS2_DCT.PDF
 248 [Description of the DCTDecode filter parameters.]
 249
 250 Adobe Systems Inc., _Open Prepress Interface (OPI) Specification -
 251 Version 2.0_, Adobe Developer Support Technical Note #5660.  2000.
 252 http://partners.adobe.com/asn/developer/PDFS/TN/5660.OPI_2.0.pdf
 253
 254 Adobe Systems Inc., CMap files.
 255 ftp://ftp.oreilly.com/pub/examples/nutshell/cjkv/adobe/
 256 [The actual CMap files for the 16-bit CJK encodings.]
 257
 258 Adobe Systems Inc., Unicode glyph lists.
 259 http://partners.adobe.com/asn/developer/type/unicodegn.html
 260 http://partners.adobe.com/asn/developer/type/glyphlist.txt
 261 http://partners.adobe.com/asn/developer/type/corporateuse.txt
 262 http://partners.adobe.com/asn/developer/type/zapfdingbats.txt
 263 [Mappings between character names to Unicode.]
 264
 265 Aldus Corp., _OPI: Open Prepress Interface Specification 1.3_.  1993.
 266 http://partners.adobe.com/asn/developer/PDFS/TN/OPI_13.pdf
 267
 268 Anonymous, RC4 source code.
 269 ftp://ftp.ox.ac.uk/pub/crypto/misc/rc4.tar.gz
 270 ftp://idea.sec.dsi.unimi.it/pub/crypt/code/rc4.tar.gz
 271 [This is the algorithm used to encrypt PDF files.]
 272
 273 T. Boutell, et al., "PNG (Portable Network Graphics) Specification,
 274 Version 1.0.  RFC 2083.
 275 [PDF uses the PNG filter algorithms.]
 276
 277 CCITT, "Information Technology - Digital Compression and Coding of
 278 Continuous-tone Still Images - Requirements and Guidelines", CCITT
 279 Recommendation T.81.
 280 http://www.w3.org/Graphics/JPEG/
 281 [The official JPEG spec.]
 282
 283 A. Chernov, "Registration of a Cyrillic Character Set".  RFC 1489.
 284 [Documentation for the KOI8-R Cyrillic encoding.]
 285
 286 Roman Czyborra, "The ISO 8859 Alphabet Soup".
 287 http://czyborra.com/charsets/iso8859.html
 288 [Documentation on the various ISO 859 encodings.]
 289
 290 L. Peter Deutsch, "ZLIB Compressed Data Format Specification version
 291 3.3".  RFC 1950.
 292 [Information on the general format used in FlateDecode streams.]
 293
 294 L. Peter Deutsch, "DEFLATE Compressed Data Format Specification
 295 version 1.3".  RFC 1951.
 296 [The definition of the compression algorithm used in FlateDecode
 297 streams.]
 298
 299 Jim Flowers, "X Logical Font Description Conventions", Version 1.5, X
 300 Consortium Standard, X Version 11, Release 6.1.
 301 ftp://ftp.x.org/pub/R6.1/xc/doc/hardcopy/XLFD/xlfd.PS.Z
 302 [The official specification of X font descriptors, including font
 303 transformation matrices.]
 304
 305 Foley, van Dam, Feiner, and Hughes, _Computer Graphics: Principles and
 306 Practice_, 2nd ed.  Addison-Wesley, 1990, ISBN 0-201-12110-7.
 307 [Colorspace conversion functions, Bezier spline math.]
 308
 309 Robert L. Hummel, _Programmer's Technical Reference: Data and Fax
 310 Communications_.  Ziff-Davis Press, 1993, ISBN 1-56276-077-7.
 311 [CCITT Group 3 and 4 fax decoding.]
 312
 313 ISO/IEC, _Information technology -- Lossy/lossless coding of bi-level
 314 images_.  ISO/IEC 14492, First edition (2001-12-15).
 315 http://webstore.ansi.org/
 316 [The official JBIG2 standard.  The final draft of this spec is
 317 available from http://www.jpeg.org/jbighomepage.html.]
 318
 319 ISO/IEC, _Information technology -- JPEG 2000 image coding system --
 320 Part 1: Core coding system_.  ISO/IEC 15444-1, First edition
 321 (2000-12-15).
 322 http://webstore.ansi.org/
 323 [The official JPEG 2000 standard.  The final committee draft of this
 324 spec is available from http://www.jpeg.org/JPEG2000.html, but there
 325 were changes made to the bitstream format between that draft and the
 326 published spec.]
 327
 328 ITU, "Standardization of Group 3 facsimile terminals for document
 329 transmission", ITU-T Recommendation T.4, 1999.
 330 ITU, "Facsimile coding schemes and coding control functions for Group 4
 331 facsimile apparatus", ITU-T Recommendation T.6, 1993.
 332 http://www.itu.int/
 333 [The official Group 3 and 4 fax standards - used by the CCITTFaxDecode
 334 stream, as well as the JBIG2Decode stream.]
 335
 336 Christoph Loeffler, Adriaan Ligtenberg, George S. Moschytz, "Practical
 337 Fast 1-D DCT Algorithms with 11 Multiplications".  IEEE Intl. Conf. on
 338 Acoustics, Speech & Signal Processing, 1989, 988-991.
 339 [The fast IDCT algorithm used in the DCTDecode filter.]
 340
 341 Microsoft, _TrueType 1.0 Font Files_, rev. 1.66.  1995.
 342 http://www.microsoft.com/typography/tt/tt.htm
 343 [The TrueType font spec (in MS Word format, naturally).]
 344
 345 Thai Industrial Standard, "Standard for Thai Character Codes for
 346 Computers", TIS-620-2533 (1990).
 347 http://www.nectec.or.th/it-standards/std620/std620.htm
 348 [The TIS-620 Thai encoding.]
 349
 350 P. Peterlin, "ISO 8859-2 (Latin 2) Resources".
 351 http://sizif.mf.uni-lj.si/linux/cee/iso8859-2.html
 352 [This is a web page with all sorts of useful Latin-2 character set and
 353 font information.]
 354
 355 Charles Poynton, "Color FAQ".
 356 http://www.inforamp.net/~poynton/ColorFAQ.html
 357 [The mapping from the CIE 1931 (XYZ) color space to RGB.]
 358
 359 R. Rivest, "The MD5 Message-Digest Algorithm".  RFC 1321.
 360 [MD5 is used in PDF document encryption.]
 361
 362 Unicode Consortium, "Unicode Home Page".
 363 http://www.unicode.org/
 364 [Online copy of the Unicode spec.]
 365
 366 W3C Recommendation, "PNG (Portable Network Graphics) Specification
 367 Version 1.0".
 368 http://www.w3.org/Graphics/PNG/
 369 [Defines the PNG image predictor.]
 370
 371 Gregory K. Wallace, "The JPEG Still Picture Compression Standard".
 372 ftp://ftp.uu.net/graphics/jpeg/wallace.ps.gz
 373 [Good description of the JPEG standard.  Also published in CACM, April
 374 1991, and submitted to IEEE Transactions on Consumer Electronics.]
 375
 376 F. Yergeau, "UTF-8, a transformation format of ISO 10646".  RFC 2279.
 377 [A commonly used Unicode encoding.]