forgotten commit. disabled until egl is adapted.
[AROS-Contrib.git] / arospdf / README
blob71fd62e319d4a99887af18b90f0b42bb56f96285
1 Xpdf
2 ====
4 version 3.02
5 2007-feb-27
7 The Xpdf software and documentation are
8 copyright 1996-2007 Glyph & Cog, LLC.
10 Email: derekn@foolabs.com
11 WWW: http://www.foolabs.com/xpdf/
13 The PDF data structures, operators, and specification are
14 copyright 1985-2006 Adobe Systems Inc.
17 What is Xpdf?
18 -------------
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.
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.
30 Xpdf is designed to be small and efficient.  It can use Type 1 or
31 TrueType fonts.
34 Distribution
35 ------------
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.
42 In order to cut down on the confusion a little bit, here are some
43 informal clarifications:
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.)
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.
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.
57 If you're interested in commercial licensing, please see the Glyph &
58 Cog web site:
60     http://www.glyphandcog.com/
63 Compatibility
64 -------------
66 Xpdf is developed and tested on a Linux 2.4 x86 system.
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.
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.
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).
84 If you can't get Xpdf to compile on your system, send me email and
85 I'll try to help.
87 Xpdf has been ported to the Acorn, Amiga, BeOS, and EPOC.  See the
88 Xpdf web page for links.
91 Getting Xpdf
92 ------------
94 The latest version is available from:
96   http://www.foolabs.com/xpdf/
98 or:
100   ftp://ftp.foolabs.com/pub/xpdf/
102 Source code and several precompiled executables are available.
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.
110 Running Xpdf
111 ------------
113 To run xpdf, simply type:
115   xpdf file.pdf
117 To generate a PostScript file, hit the "print" button in xpdf, or run
118 pdftops:
120   pdftops file.pdf
122 To generate a plain text file, run pdftotext:
124   pdftotext file.pdf
126 There are four additional utilities (which are fully described in
127 their man pages):
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
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.).
141 Upgrading from Xpdf 2.xx
142 ------------------------
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.
152 Compiling Xpdf
153 --------------
155 See the separate file, INSTALL.
158 Bugs
159 ----
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.
167 Acknowledgments
168 ---------------
170 Thanks to:
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.
197 Various people have contributed modifications made for use by the
198 pdftex project:
200 * Han The Thanh
201 * Martin Schröder of ArtCom GmbH
204 References
205 ----------
207 Adobe Systems Inc., _PDF Reference, sixth edition: Adobe Portable
208 Document Format version 1.7_.
209 http://www.adobe.com/devnet/pdf/pdf_reference.html
210 [The manual for PDF version 1.7.]
212 Adobe Systems Inc., "Errata for the PDF Reference, sixth edition,
213 version 1.7", October 16, 2006.
214 http://www.adobe.com/devnet/pdf/pdf_reference.html
215 [The errata for the PDF 1.7 spec.]
217 Adobe Systems Inc., _PostScript Language Reference_, 3rd ed.
218 Addison-Wesley, 1999, ISBN 0-201-37922-8.
219 [The official PostScript manual.]
221 Adobe Systems, Inc., _The Type 42 Font Format Specification_,
222 Adobe Developer Support Technical Specification #5012.  1998.
223 http://partners.adobe.com/asn/developer/pdfs/tn/5012.Type42_Spec.pdf
224 [Type 42 is the format used to embed TrueType fonts in PostScript
225 files.]
227 Adobe Systems, Inc., _Adobe CMap and CIDFont Files Specification_,
228 Adobe Developer Support Technical Specification #5014.  1995.
229 http://www.adobe.com/supportservice/devrelations/PDFS/TN/5014.CIDFont_Spec.pdf
230 [CMap file format needed for Japanese and Chinese font support.]
232 Adobe Systems, Inc., _Adobe-Japan1-4 Character Collection for
233 CID-Keyed Fonts_, Adobe Developer Support Technical Note #5078.
234 2000.
235 http://partners.adobe.com/asn/developer/PDFS/TN/5078.CID_Glyph.pdf
236 [The Adobe Japanese character set.]
238 Adobe Systems, Inc., _Adobe-GB1-4 Character Collection for
239 CID-Keyed Fonts_, Adobe Developer Support Technical Note #5079.
240 2000.
241 http://partners.adobe.com/asn/developer/pdfs/tn/5079.Adobe-GB1-4.pdf
242 [The Adobe Chinese GB (simplified) character set.]
244 Adobe Systems, Inc., _Adobe-CNS1-3 Character Collection for
245 CID-Keyed Fonts_, Adobe Developer Support Technical Note #5080.
246 2000.
247 http://partners.adobe.com/asn/developer/PDFS/TN/5080.CNS_CharColl.pdf
248 [The Adobe Chinese CNS (traditional) character set.]
250 Adobe Systems Inc., _Supporting the DCT Filters in PostScript Level
251 2_, Adobe Developer Support Technical Note #5116.  1992.
252 http://www.adobe.com/supportservice/devrelations/PDFS/TN/5116.PS2_DCT.PDF
253 [Description of the DCTDecode filter parameters.]
255 Adobe Systems Inc., _Open Prepress Interface (OPI) Specification -
256 Version 2.0_, Adobe Developer Support Technical Note #5660.  2000.
257 http://partners.adobe.com/asn/developer/PDFS/TN/5660.OPI_2.0.pdf
259 Adobe Systems Inc., CMap files.
260 ftp://ftp.oreilly.com/pub/examples/nutshell/cjkv/adobe/
261 [The actual CMap files for the 16-bit CJK encodings.]
263 Adobe Systems Inc., Unicode glyph lists.
264 http://partners.adobe.com/asn/developer/type/unicodegn.html
265 http://partners.adobe.com/asn/developer/type/glyphlist.txt
266 http://partners.adobe.com/asn/developer/type/corporateuse.txt
267 http://partners.adobe.com/asn/developer/type/zapfdingbats.txt
268 [Mappings between character names to Unicode.]
270 Adobe Systems Inc., OpenType Specification v. 1.4.
271 http://partners.adobe.com/public/developer/opentype/index_spec.html
272 [The OpenType font format spec.]
274 Aldus Corp., _OPI: Open Prepress Interface Specification 1.3_.  1993.
275 http://partners.adobe.com/asn/developer/PDFS/TN/OPI_13.pdf
277 Anonymous, RC4 source code.
278 ftp://ftp.ox.ac.uk/pub/crypto/misc/rc4.tar.gz
279 ftp://idea.sec.dsi.unimi.it/pub/crypt/code/rc4.tar.gz
280 [This is the algorithm used to encrypt PDF files.]
282 T. Boutell, et al., "PNG (Portable Network Graphics) Specification,
283 Version 1.0".  RFC 2083.
284 [PDF uses the PNG filter algorithms.]
286 CCITT, "Information Technology - Digital Compression and Coding of
287 Continuous-tone Still Images - Requirements and Guidelines", CCITT
288 Recommendation T.81.
289 http://www.w3.org/Graphics/JPEG/
290 [The official JPEG spec.]
292 A. Chernov, "Registration of a Cyrillic Character Set".  RFC 1489.
293 [Documentation for the KOI8-R Cyrillic encoding.]
295 Roman Czyborra, "The ISO 8859 Alphabet Soup".
296 http://czyborra.com/charsets/iso8859.html
297 [Documentation on the various ISO 859 encodings.]
299 L. Peter Deutsch, "ZLIB Compressed Data Format Specification version
300 3.3".  RFC 1950.
301 [Information on the general format used in FlateDecode streams.]
303 L. Peter Deutsch, "DEFLATE Compressed Data Format Specification
304 version 1.3".  RFC 1951.
305 [The definition of the compression algorithm used in FlateDecode
306 streams.]
308 Morris Dworkin, "Recommendation for Block Cipher Modes of Operation",
309 National Institute of Standards, NIST Special Publication 800-38A,
310 2001.
311 [The cipher block chaining (CBC) mode used with AES in PDF files.]
313 Federal Information Processing Standards Publication 197 (FIPS PUBS
314 197), "Advanced Encryption Standard (AES)", November 26, 2001.
315 [AES encryption, used in PDF 1.6.]
317 Jim Flowers, "X Logical Font Description Conventions", Version 1.5, X
318 Consortium Standard, X Version 11, Release 6.1.
319 ftp://ftp.x.org/pub/R6.1/xc/doc/hardcopy/XLFD/xlfd.PS.Z
320 [The official specification of X font descriptors, including font
321 transformation matrices.]
323 Foley, van Dam, Feiner, and Hughes, _Computer Graphics: Principles and
324 Practice_, 2nd ed.  Addison-Wesley, 1990, ISBN 0-201-12110-7.
325 [Colorspace conversion functions, Bezier spline math.]
327 Robert L. Hummel, _Programmer's Technical Reference: Data and Fax
328 Communications_.  Ziff-Davis Press, 1993, ISBN 1-56276-077-7.
329 [CCITT Group 3 and 4 fax decoding.]
331 ISO/IEC, _Information technology -- Lossy/lossless coding of bi-level
332 images_.  ISO/IEC 14492, First edition (2001-12-15).
333 http://webstore.ansi.org/
334 [The official JBIG2 standard.  The final draft of this spec is
335 available from http://www.jpeg.org/jbighomepage.html.]
337 ISO/IEC, _Information technology -- JPEG 2000 image coding system --
338 Part 1: Core coding system_.  ISO/IEC 15444-1, First edition
339 (2000-12-15).
340 http://webstore.ansi.org/
341 [The official JPEG 2000 standard.  The final committee draft of this
342 spec is available from http://www.jpeg.org/JPEG2000.html, but there
343 were changes made to the bitstream format between that draft and the
344 published spec.]
346 ITU, "Standardization of Group 3 facsimile terminals for document
347 transmission", ITU-T Recommendation T.4, 1999.
348 ITU, "Facsimile coding schemes and coding control functions for Group 4
349 facsimile apparatus", ITU-T Recommendation T.6, 1993.
350 http://www.itu.int/
351 [The official Group 3 and 4 fax standards - used by the CCITTFaxDecode
352 stream, as well as the JBIG2Decode stream.]
354 B. Kaliski, "PKCS #5: Password-Based Cryptography Specification,
355 Version 2.0".  RFC 2898.
356 [Defines the padding scheme used with AES encryption in PDF files.]
358 Christoph Loeffler, Adriaan Ligtenberg, George S. Moschytz, "Practical
359 Fast 1-D DCT Algorithms with 11 Multiplications".  IEEE Intl. Conf. on
360 Acoustics, Speech & Signal Processing, 1989, 988-991.
361 [The fast IDCT algorithm used in the DCTDecode filter.]
363 Microsoft, _TrueType 1.0 Font Files_, rev. 1.66.  1995.
364 http://www.microsoft.com/typography/tt/tt.htm
365 [The TrueType font spec (in MS Word format, naturally).]
367 V. Ostromoukhov, R.D. Hersch, "Stochastic Clustered-Dot Dithering",
368 Conf. Color Imaging: Device-Independent Color, Color Hardcopy, and
369 Graphic Arts IV, 1999, SPIE Vol. 3648, 496-505.
370 http://diwww.epfl.ch/w3lsp/publications/colour/scd.html
371 [The stochastic dithering algorithm used in Xpdf.]
373 P. Peterlin, "ISO 8859-2 (Latin 2) Resources".
374 http://sizif.mf.uni-lj.si/linux/cee/iso8859-2.html
375 [This is a web page with all sorts of useful Latin-2 character set and
376 font information.]
378 Charles Poynton, "Color FAQ".
379 http://www.inforamp.net/~poynton/ColorFAQ.html
380 [The mapping from the CIE 1931 (XYZ) color space to RGB.]
382 R. Rivest, "The MD5 Message-Digest Algorithm".  RFC 1321.
383 [MD5 is used in PDF document encryption.]
385 Thai Industrial Standard, "Standard for Thai Character Codes for
386 Computers", TIS-620-2533 (1990).
387 http://www.nectec.or.th/it-standards/std620/std620.htm
388 [The TIS-620 Thai encoding.]
390 Unicode Consortium, "Unicode Home Page".
391 http://www.unicode.org/
392 [Online copy of the Unicode spec.]
394 W3C Recommendation, "PNG (Portable Network Graphics) Specification
395 Version 1.0".
396 http://www.w3.org/Graphics/PNG/
397 [Defines the PNG image predictor.]
399 Gregory K. Wallace, "The JPEG Still Picture Compression Standard".
400 ftp://ftp.uu.net/graphics/jpeg/wallace.ps.gz
401 [Good description of the JPEG standard.  Also published in CACM, April
402 1991, and submitted to IEEE Transactions on Consumer Electronics.]
404 F. Yergeau, "UTF-8, a transformation format of ISO 10646".  RFC 2279.
405 [A commonly used Unicode encoding.]