home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 13 / AACD13.ISO / CDTools / Viewers / Apdf / doc.orig / README < prev    next >
Text File  |  1999-07-14  |  14KB  |  407 lines
  1. xpdf
  2. ====
  3.  
  4. version 0.80
  5. 98-nov-27
  6.  
  7. The xpdf software and documentation are
  8. copyright 1996-1998 Derek B. Noonburg.
  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 1995 Adobe Systems Inc.
  15.  
  16.  
  17. What is xpdf?
  18. -------------
  19.  
  20. Xpdf is a viewer for Portable Document Format (PDF) files.  (These are
  21. also sometimes also called 'Acrobat' files, from the name of Adobe's
  22. PDF software.)  Xpdf runs under the X Window System on UNIX, VMS, and
  23. OS/2.  The non-X components of the package (pdftops, pdftotext, etc.)
  24. also run on Win32 systems.
  25.  
  26. Xpdf is designed to be small and efficient.  It does not use the Motif
  27. or Xt libraries.  It uses standard X fonts.  Xpdf is quite usable on a
  28. 486-66 PC running Linux.
  29.  
  30.  
  31. Distribution
  32. ------------
  33.  
  34. Xpdf is licensed under the GNU General Public License (GPL), version
  35. 2.  In my opinion, the GPL is a convoluted, confusing, ambiguous mess.
  36. But it's also pervasive, and I'm sick of arguing.  And even if it is
  37. confusing, the basic idea is good.
  38.  
  39. In order to cut down on the confusion a little bit, here are some
  40. informal clarifications:
  41.  
  42. - I don't mind if you redistribute xpdf in source and/or binary form,
  43.   as long as you include all of the documentation: README, man pages
  44.   (or help files), and COPYING.  (Note that the README file contains a
  45.   pointer to a web page with the source code.)
  46.  
  47. - Selling a CD-ROM that contains xpdf is fine with me, as long as it
  48.   includes the documentation.  I wouldn't mind receiving a sample
  49.   copy, but it's not necessary.
  50.  
  51. - If you make useful changes to xpdf, please make the source code
  52.   available -- post it on a web site, email it to me, whatever.
  53.  
  54. If you're interested in commercial licensing, please contact me by
  55. email: derekn@foolabs.com .
  56.  
  57.  
  58. Compatibility
  59. -------------
  60.  
  61. Xpdf is developed and tested on a Linux 2.0 x86 system.
  62.  
  63. In addition, it has been compiled by others on Solaris, AIX, HP-UX,
  64. SCO UnixWare, Digital Unix, Irix, and numerous other Unix
  65. implementations, as well as VMS and OS/2.  It should work on pretty
  66. much any system which runs X11 and has Unix-like libraries.  You'll
  67. need ANSI C++ and C compilers to compile it.
  68.  
  69. The non-X components of xpdf (pdftops, pdftotext, pdfinfo, pdfimages)
  70. can also be compiled on Win32 systems.  See the xpdf web page for
  71. details.
  72.  
  73. If you compiled xpdf for a system not listed on the web page, please
  74. let me know.  If you're willing to make your binary available by ftp
  75. or on the web, I'll be happy to add a link from the xpdf web page.  I
  76. have decided not to host any binaries I didn't compile myself (for
  77. disk space and support reasons).
  78.  
  79. If you can't get xpdf to compile on your system, send me email and
  80. I'll try to help.
  81.  
  82. Ports of xpdf to the Acorn and Amiga have been made.  See the xpdf web
  83. page for links.
  84.  
  85.  
  86. Getting xpdf
  87. ------------
  88.  
  89. The latest version is available from:
  90.  
  91.   http://www.foolabs.com/xpdf/
  92.  
  93. or:
  94.  
  95.   ftp://ftp.foolabs.com/pub/xpdf/
  96.  
  97. Source code and several precompiled executables are available.
  98.  
  99. Announcements of new versions are posted to several newsgroups
  100. (comp.text.pdf, comp.os.linux.announce, and others) and emailed to a
  101. list of people.  If you'd like to receive email notification of new
  102. versions, just let me know.
  103.  
  104.  
  105. Running xpdf
  106. ------------
  107.  
  108. To run xpdf, simply type:
  109.  
  110.   xpdf file.pdf
  111.  
  112. To generate a PostScript file, hit the "print" button in xpdf, or run
  113. pdftops:
  114.  
  115.   pdftops file.pdf
  116.  
  117. To generate a plain text file, run pdftotext:
  118.  
  119.   pdftotext file.pdf
  120.  
  121. There are three additional utilities (which are fully described in
  122. their man pages):
  123.  
  124.   pdfinfo -- dumps a PDF file's Info dictionary (plus some other
  125.              useful information)
  126.   pdftopbm -- converts a PDF file to a series of PBM-format bitmaps
  127.   pdfimages -- extracts the images from a PDF file
  128.  
  129. Command line options and many other details are described in the man
  130. pages (xpdf.1, etc.) and the VMS help files (xpdf.hlp, etc.).
  131.  
  132.  
  133. Fonts
  134. -----
  135.  
  136. Xpdf uses X server fonts.  It requires the following fonts:
  137.  
  138. * Courier: medium-r, bold-r, medium-o, and bold-o
  139. * Helvetica: medium-r, bold-r, medium-o, and bold-o
  140. * Times: medium-r, bold-r, medium-i, and bold-i
  141. * Symbol: medium-r
  142. * Zapf Dingbats: medium-r
  143.  
  144. Most X installations should already have all of these fonts, except
  145. Zapf Dingbats.  You can install a Type 1 Zapf Dingbats font -- see the
  146. mkfontdir(1) man page for details.  Use this font descriptor in your
  147. fonts.scale file:
  148.  
  149.     -itc-zapfdingbats-medium-r-normal--0-0-0-0-p-0-adobe-fontspecific
  150.  
  151. You can get a Type 1 font file from the ghostscript 4.x distribution
  152. (look for d050000l.pfb).
  153.  
  154. X servers, starting at R5, support font scaling.  Xpdf will
  155. automatically take advantage of this.  There are two types of scaling.
  156. The first type uses standard bitmap fonts: if a font doesn't exist in
  157. the requested size, the server will scale the bitmapped characters.
  158. This is reasonably fast, and the results are readable but not very
  159. pretty.  X servers can also handle true scalable, e.g., Type 1, fonts.
  160. (See the mkfontdir(1) man page for details on setting these up.)
  161. Scalable fonts are slower, especially since PDF documents tend to use
  162. lots of fonts, but they look much nicer.
  163.  
  164. Some X servers also support font rotation.  Xpdf will use this feature
  165. if available.
  166.  
  167. For Japanese support, you will need a Japanese font of the form:
  168.  
  169.     -*-fixed-medium-r-normal-*-NN-*-*-*-*-*-jisx0208.1983-0
  170.  
  171. and an X server that can handle 16-bit fonts.
  172.  
  173.  
  174. The Unisys LZW Patent
  175. ---------------------
  176.  
  177. Nearly all PDF files include data which has been compressed with the
  178. LZW compression algorithm.  Unfortunately, LZW is covered by a
  179. software patent which is owned by Unisys Corporation.  Unisys refuses
  180. to license this patent for PDF-related use in software such as xpdf
  181. which is released for free and which may be freely redistributed.
  182. (This is same algorithm which is used by GIF.  However, Unisys is not
  183. doing licensing for free PDF viwers in the same way as for free GIF
  184. viewers.)
  185.  
  186. As a workaround, xpdf converts PDF-format LZW data to compress-format
  187. LZW data.  (The standard UNIX compress utility also uses LZW, but with
  188. a slightly different file format.)  This conversion does *not*
  189. decompress the data; it simply converts it to a different file format.
  190. Xpdf then calls uncompress to actually decompress the data.
  191.  
  192. I have been told by several notable people that the LZW patent covers
  193. compression only, and does not cover decompression.  This seems pretty
  194. fuzzy to me, so I'm going to stick with my workaround, at least for
  195. now.
  196.  
  197. For Unisys's slant on things (mostly regarding GIF), see
  198. <http://www.unisys.com/LeadStory/lzwterms.html> and
  199. <http://www.unisys.com/LeadStory/lzwfaq.html>.  These pages mention
  200. an email address for feedback.
  201.  
  202.  
  203. Compiling xpdf
  204. --------------
  205.  
  206. Xpdf is written in C++ (with a little bit of C).  It should work with
  207. any ANSI-compliant C++ and C compilers.  The systems and compilers
  208. it's been tested with are listed on the xpdf web page.
  209.  
  210. *** To compile xpdf for UNIX:
  211.  
  212. * Run the configure script:
  213.  
  214.     ./configure
  215.  
  216.   This should produce a set of makefiles customized for your system.
  217.   The configure script accepts the following options (in addition to
  218.   the usual things accepted by autoconf configure scripts):
  219.  
  220.     --prefix=PREFIX
  221.         Changes the directory where xpdf is installed.  The default is
  222.         /usr/local.
  223.  
  224.     --enable-a4-paper
  225.         Switches the default paper size for PostScript output (xpdf
  226.         and pdftops) to A4.  The default is Letter size.
  227.  
  228.     --enable-japanese
  229.         Enables support for 16-bit Japanese fonts.  This increases the
  230.         size of the binary (mostly with decoding tables).  The default
  231.         is no Japanese font support.
  232.  
  233.     --enable-no-text-select
  234.         With this option, xpdf will not copy text.  (This is only
  235.         useful on closed systems where the user can't get at the PDF
  236.         file directly.)
  237.  
  238.     --with-gzip
  239.         Use gzip instead of uncompress.
  240.  
  241. * Type 'make'.  This should build the executables:
  242.  
  243.     xpdf/xpdf
  244.     xpdf/pdftops
  245.     xpdf/pdftotext
  246.     xpdf/pdfinfo
  247.     xpdf/pdftopbm
  248.     xpdf/pdfimages
  249.  
  250. * If desired, type 'make install' to install the binaries and man
  251.   pages.
  252.  
  253. The old Makefile.config and Makefiles are no longer provided or
  254. supported.
  255.  
  256. *** To compile xpdf for VMS:
  257.  
  258. * The 'stddef.h' include file which comes with older versions of gcc
  259.   may be missing a definition for wchar_t.  In this case, add the
  260.   following lines:
  261.   -----
  262.   File GNU_CC:[INCLUDE]STDDEF.H;2
  263.    44   /* Wide characters, not yet supported by VAXCRTL [match VAXC's <stddef.
  264.    45   #if !defined(_WCHAR_T) && !defined(_WCHAR_T_)
  265.    46   typedef unsigned int wchar_t;
  266.    47   #endif
  267.    48   #define _WCHAR_T
  268.    49   #define _WCHAR_T_
  269.    50
  270.   -----
  271.  
  272. * Type '@vms_make' in the top-level directory.  If you have the Xpm
  273.   library and you want xpdf's color icon, type '@vms_make xpm'
  274.   instead.
  275.  
  276. * The executables will be left in '[.xpdf]'.
  277.  
  278. *** To compile xpdf for OS/2:
  279.  
  280. Xpdf is known to run under OS/2 with the EMX runtime environment and
  281. XFree86.  The configure script has not been tested on OS/2, however.
  282.  
  283. *** To compile pdftops and pdftotext for Win32:
  284.  
  285. This has been tested with the Delorie port of gcc.  You'll need to
  286. rename 'makefile.w32' (in the top-level, goo, and xpdf directories) to
  287. 'makefile' before running make.
  288.  
  289.  
  290. Bugs
  291. ----
  292.  
  293. At this point, the biggest problem with xpdf is that embedded fonts
  294. are generally not handled very well.
  295.  
  296. If you find a bug in xpdf, i.e., if it prints an error message,
  297. crashes, or incorrectly displays a document, and you don't see that
  298. bug listed here, please send me email, with a pointer (URL, ftp site,
  299. etc.) to the PDF file.
  300.  
  301.  
  302. Acknowledgments
  303. ---------------
  304.  
  305. Thanks to:
  306.  
  307. * Patrick Voigt for help with the remote server code.
  308. * Patrick Moreau and Martin P.J. Zinser for the VMS port.
  309. * David Boldt and Rick Rodgers for sample man pages.
  310. * Brendan Miller for the icon idea.
  311. * Olly Betts for help testing pdftotext.
  312. * Peter Ganten for the OS/2 port.
  313. * Michael Richmond for the Win32 port of pdftops and pdftotext.
  314. * Frank M. Siegert for improvements in the PostScript code.
  315. * Leo Smiers for the decryption patches.
  316.  
  317.  
  318. References
  319. ----------
  320.  
  321. Adobe Systems Inc., _Portable Document Format Reference Manual_.
  322. Addison-Wesley, 1993, ISBN 0-201-62628-4.
  323. [The printed manual for PDF version 1.0.]
  324.  
  325. Adobe Systems Inc., _Portable Document Format Reference Manual_,
  326. Version 1.2.  November 12, 1996.
  327. http://www.adobe.com/supportservice/devrelations/PDFS/TN/PDFSPEC.PDF
  328. [Updated manual for PDF 1.2.  Also includes the encryption spec.]
  329.  
  330. Adobe Systems Inc., _PostScript Language Reference Manual_, 2nd ed.
  331. Addison-Wesley, 1990, ISBN 0-201-18127-4.
  332. [The official PostScript manual.]
  333.  
  334. Adobe Systems, Inc., _Adobe CMap and CIDFont Files Specification_,
  335. Adobe Developer Support Technical Specification #5014.  1995.
  336. http://www.adobe.com/supportservice/devrelations/PDFS/TN/5014.CIDFont_Spec.pdf
  337. [CMap file format needed for Japanese font support.]
  338.  
  339. Adobe Systems, Inc., _Adobe-Japan1-2 Character Collection for
  340. CID-Keyed Fonts_ (Bitmap Character Image Version), Adobe Developer
  341. Support Technical Note #5078-b.  1994. 
  342. http://www.adobe.com/supportservice/devrelations/PDFS/TN/5078b.pdf
  343. [The complete Adobe Japanese character set.]
  344.  
  345. Adobe Systems Inc., _Supporting the DCT Filters in PostScript Level
  346. 2_, Adobe Developer Support Technical Note #5116.  1992.
  347. http://www.adobe.com/supportservice/devrelations/PDFS/TN/5116.PS2_DCT.PDF
  348. [Description of the DCTDecode filter parameters.]
  349.  
  350. Anonymous, RC4 source code.
  351. ftp://ftp.ox.ac.uk/pub/crypto/misc/rc4.tar.gz
  352. ftp://idea.sec.dsi.unimi.it/pub/crypt/code/rc4.tar.gz
  353. [This is the algorithm used to encrypt PDF files.]
  354.  
  355. CCITT, _Blue Book_, Volume VII Fascicle 3: "Terminal Equipment and
  356. Protocols for Telematic Services", Recommendations T.4 and T.6.
  357. ftp://ftp.uu.net/doc/standards/ccitt/1988/7_3_01.ps
  358. ftp://ftp.uu.net/doc/standards/ccitt/1988/7_3_02.ps
  359. [The official Group 3 and 4 fax standards.  The online copies are
  360. unfortunately misformatted.]
  361.  
  362. L. Peter Deutsch, "ZLIB Compressed Data Format Specification version
  363. 3.3".  RFC 1950.
  364. [Information on the general format used in FlateDecode streams.]
  365.  
  366. L. Peter Deutsch, "DEFLATE Compressed Data Format Specification
  367. version 1.3".  RFC 1951.
  368. [The definition of the compression algorithm used in FlateDecode
  369. streams.]
  370.  
  371. Jim Flowers, "X Logical Font Description Conventions", Version 1.5, X
  372. Consortium Standard, X Version 11, Release 6.1.
  373. ftp://ftp.x.org/pub/R6.1/xc/doc/hardcopy/XLFD/xlfd.PS.Z
  374. [The official specification of X font descriptors, including font
  375. transformation matrices.]
  376.  
  377. Foley, van Dam, Feiner, and Hughes, _Computer Graphics: Principles and
  378. Practice_, 2nd ed.  Addison-Wesley, 1990, ISBN 0-201-12110-7.
  379. [Colorspace conversion functions, Bezier spline math.]
  380.  
  381. Robert L. Hummel, _Programmer's Technical Reference: Data and Fax
  382. Communications_.  Ziff-Davis Press, 1993, ISBN 1-56276-077-7.
  383. [CCITT Group 3 and 4 fax decoding.]
  384.  
  385. Christoph Loeffler, Adriaan Ligtenberg, George S. Moschytz, "Practical
  386. Fast 1-D DCT Algorithms with 11 Multiplications".  IEEE Intl. Conf. on
  387. Acoustics, Speech & Signal Processing, 1989, 988-991.
  388. [The fast IDCT algorithm used in the DCTDecode filter.]
  389.  
  390. R. Rivest, "The MD5 Message-Digest Algorithm".  RFC 1321.
  391. [MD5 is used in PDF document encryption.]
  392.  
  393. Gregory K. Wallace, "The JPEG Still Picture Compression Standard".
  394. ftp://ftp.uu.net/graphics/jpeg/wallace.ps.gz
  395. [Good description of the JPEG standard.  Also published in CACM, April
  396. 1991, and submitted to IEEE Transactions on Consumer Electronics.]
  397.  
  398. W3C Recommendation, "PNG (Portable Network Graphics) Specification
  399. Version 1.0".
  400. http://www.w3.org/Graphics/PNG/
  401. [Defines the PNG image predictor.]
  402.  
  403. "ISO 8859-2 (Latin 2) Resources".
  404. http://sizif.mf.uni-lj.si/linux/cee/iso8859-2.html
  405. [This is a web page with all sorts of useful Latin-2 character set and
  406. font information.]
  407.