home *** CD-ROM | disk | FTP | other *** search
/ back2roots/padua / padua.7z / padua / ftp.vapor.com / voyager / vpdf / Apdf_common.lha / Apdf / doc.orig / README < prev    next >
Encoding:
Text File  |  2000-04-06  |  12.4 KB  |  349 lines
  1. xpdf
  2. ====
  3.  
  4. version 0.90
  5. 99-aug-02
  6.  
  7. The xpdf software and documentation are
  8. copyright 1996-1999 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 and should run on pretty much any system
  25. with a decent C++ compiler.
  26.  
  27. Xpdf is designed to be small and efficient.  It does not use the Motif
  28. or Xt libraries.  It can use standard X fonts.
  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. Xpdf has been ported to the Acorn, Amiga, and BeOS.  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. If compiled with t1lib support, xpdf will use t1lib to render embedded
  174. Type 1 and Type 1C fonts.  In addition, xpdf can be configured to use
  175. t1lib for the base 14 fonts and for substituted fonts.  To enable this
  176. feature, you must set an X resource for each Type 1 font file.  For
  177. example:
  178.  
  179.     xpdf.t1TimesRoman:           /usr/local/fonts/Times-Roman.pfa
  180.     xpdf.t1TimesItalic:          /usr/local/fonts/Times-Italic.pfa
  181.     xpdf.t1TimesBold:            /usr/local/fonts/Times-Bold.pfa
  182.     xpdf.t1TimesBoldItalic:      /usr/local/fonts/Times-BoldItalic.pfa
  183.     xpdf.t1Helvetica:            /usr/local/fonts/Helvetica.pfa
  184.     xpdf.t1HelveticaOblique:     /usr/local/fonts/Helvetica-Oblique.pfa
  185.     xpdf.t1HelveticaBold:        /usr/local/fonts/Helvetica-Bold.pfa
  186.     xpdf.t1HelveticaBoldOblique: /usr/local/fonts/Helvetica-BoldOblique.pfa
  187.     xpdf.t1Courier:              /usr/local/fonts/Courier.pfa
  188.     xpdf.t1CourierOblique:       /usr/local/fonts/Courier-Oblique.pfa
  189.     xpdf.t1CourierBold:          /usr/local/fonts/Courier-Bold.pfa
  190.     xpdf.t1CourierBoldOblique:   /usr/local/fonts/Courier-BoldOblique.pfa
  191.     xpdf.t1Symbol:               /usr/local/fonts/Symbol.pfa
  192.     xpdf.t1ZapfDingbats:         /usr/local/fonts/ZapfDingbats.pfa
  193.  
  194.  
  195. The Unisys LZW Patent
  196. ---------------------
  197.  
  198. Nearly all PDF files include data which has been compressed with the
  199. LZW compression algorithm.  Unfortunately, LZW is covered by a
  200. software patent which is owned by Unisys Corporation.  Unisys refuses
  201. to license this patent for PDF-related use in software such as xpdf
  202. which is released for free and which may be freely redistributed.
  203. (This is same algorithm which is used by GIF.  However, Unisys is not
  204. doing licensing for free PDF viwers in the same way as for free GIF
  205. viewers.)
  206.  
  207. As a workaround, xpdf converts PDF-format LZW data to compress-format
  208. LZW data.  (The standard UNIX compress utility also uses LZW, but with
  209. a slightly different file format.)  This conversion does *not*
  210. decompress the data; it simply converts it to a different file format.
  211. Xpdf then calls uncompress to actually decompress the data.
  212.  
  213. I have been told by several notable people that the LZW patent covers
  214. compression only, and does not cover decompression.  This seems pretty
  215. fuzzy to me, so I'm going to stick with my workaround, at least for
  216. now.
  217.  
  218. For Unisys's slant on things (mostly regarding GIF), see
  219. <http://www.unisys.com/LeadStory/lzwterms.html> and
  220. <http://www.unisys.com/LeadStory/lzwfaq.html>.  These pages mention
  221. an email address for feedback.
  222.  
  223.  
  224. Compiling xpdf
  225. --------------
  226.  
  227. See the separate file, INSTALL.
  228.  
  229.  
  230. Bugs
  231. ----
  232.  
  233. This release of xpdf should improve the situation with embedded
  234. fonts.  However, Type 3 and TrueType fonts are still not handled.
  235.  
  236. If you find a bug in xpdf, i.e., if it prints an error message,
  237. crashes, or incorrectly displays a document, and you don't see that
  238. bug listed here, please send me email, with a pointer (URL, ftp site,
  239. etc.) to the PDF file.
  240.  
  241.  
  242. Acknowledgments
  243. ---------------
  244.  
  245. Thanks to:
  246.  
  247. * Patrick Voigt for help with the remote server code.
  248. * Patrick Moreau and Martin P.J. Zinser for the VMS port.
  249. * David Boldt and Rick Rodgers for sample man pages.
  250. * Brendan Miller for the icon idea.
  251. * Olly Betts for help testing pdftotext.
  252. * Peter Ganten for the OS/2 port.
  253. * Michael Richmond for the Win32 port of pdftops and pdftotext.
  254. * Frank M. Siegert for improvements in the PostScript code.
  255. * Leo Smiers for the decryption patches.
  256. * Rainer Menzner for creating t1lib, and for helping me adapt it to
  257.   xpdf.
  258.  
  259.  
  260. References
  261. ----------
  262.  
  263. Adobe Systems Inc., _Portable Document Format Reference Manual_.
  264. Addison-Wesley, 1993, ISBN 0-201-62628-4.
  265. [The printed manual for PDF version 1.0.]
  266.  
  267. Adobe Systems Inc., _Portable Document Format Reference Manual_,
  268. Version 1.3.  March 11, 1999.
  269. http://partners.adobe.com/asn/developer/PDFS/TN/PDFSPEC.PDF
  270. [Updated manual for PDF 1.3.]
  271.  
  272. Adobe Systems Inc., _PostScript Language Reference Manual_, 2nd ed.
  273. Addison-Wesley, 1990, ISBN 0-201-18127-4.
  274. [The official PostScript manual.]
  275.  
  276. Adobe Systems, Inc., _Adobe CMap and CIDFont Files Specification_,
  277. Adobe Developer Support Technical Specification #5014.  1995.
  278. http://www.adobe.com/supportservice/devrelations/PDFS/TN/5014.CIDFont_Spec.pdf
  279. [CMap file format needed for Japanese font support.]
  280.  
  281. Adobe Systems, Inc., _Adobe-Japan1-2 Character Collection for
  282. CID-Keyed Fonts_ (Bitmap Character Image Version), Adobe Developer
  283. Support Technical Note #5078-b.  1994. 
  284. http://www.adobe.com/supportservice/devrelations/PDFS/TN/5078b.pdf
  285. [The complete Adobe Japanese character set.]
  286.  
  287. Adobe Systems Inc., _Supporting the DCT Filters in PostScript Level
  288. 2_, Adobe Developer Support Technical Note #5116.  1992.
  289. http://www.adobe.com/supportservice/devrelations/PDFS/TN/5116.PS2_DCT.PDF
  290. [Description of the DCTDecode filter parameters.]
  291.  
  292. Anonymous, RC4 source code.
  293. ftp://ftp.ox.ac.uk/pub/crypto/misc/rc4.tar.gz
  294. ftp://idea.sec.dsi.unimi.it/pub/crypt/code/rc4.tar.gz
  295. [This is the algorithm used to encrypt PDF files.]
  296.  
  297. CCITT, _Blue Book_, Volume VII Fascicle 3: "Terminal Equipment and
  298. Protocols for Telematic Services", Recommendations T.4 and T.6.
  299. ftp://ftp.uu.net/doc/standards/ccitt/1988/7_3_01.ps
  300. ftp://ftp.uu.net/doc/standards/ccitt/1988/7_3_02.ps
  301. [The official Group 3 and 4 fax standards.  The online copies are
  302. unfortunately misformatted.]
  303.  
  304. L. Peter Deutsch, "ZLIB Compressed Data Format Specification version
  305. 3.3".  RFC 1950.
  306. [Information on the general format used in FlateDecode streams.]
  307.  
  308. L. Peter Deutsch, "DEFLATE Compressed Data Format Specification
  309. version 1.3".  RFC 1951.
  310. [The definition of the compression algorithm used in FlateDecode
  311. streams.]
  312.  
  313. Jim Flowers, "X Logical Font Description Conventions", Version 1.5, X
  314. Consortium Standard, X Version 11, Release 6.1.
  315. ftp://ftp.x.org/pub/R6.1/xc/doc/hardcopy/XLFD/xlfd.PS.Z
  316. [The official specification of X font descriptors, including font
  317. transformation matrices.]
  318.  
  319. Foley, van Dam, Feiner, and Hughes, _Computer Graphics: Principles and
  320. Practice_, 2nd ed.  Addison-Wesley, 1990, ISBN 0-201-12110-7.
  321. [Colorspace conversion functions, Bezier spline math.]
  322.  
  323. Robert L. Hummel, _Programmer's Technical Reference: Data and Fax
  324. Communications_.  Ziff-Davis Press, 1993, ISBN 1-56276-077-7.
  325. [CCITT Group 3 and 4 fax decoding.]
  326.  
  327. Christoph Loeffler, Adriaan Ligtenberg, George S. Moschytz, "Practical
  328. Fast 1-D DCT Algorithms with 11 Multiplications".  IEEE Intl. Conf. on
  329. Acoustics, Speech & Signal Processing, 1989, 988-991.
  330. [The fast IDCT algorithm used in the DCTDecode filter.]
  331.  
  332. R. Rivest, "The MD5 Message-Digest Algorithm".  RFC 1321.
  333. [MD5 is used in PDF document encryption.]
  334.  
  335. Gregory K. Wallace, "The JPEG Still Picture Compression Standard".
  336. ftp://ftp.uu.net/graphics/jpeg/wallace.ps.gz
  337. [Good description of the JPEG standard.  Also published in CACM, April
  338. 1991, and submitted to IEEE Transactions on Consumer Electronics.]
  339.  
  340. W3C Recommendation, "PNG (Portable Network Graphics) Specification
  341. Version 1.0".
  342. http://www.w3.org/Graphics/PNG/
  343. [Defines the PNG image predictor.]
  344.  
  345. "ISO 8859-2 (Latin 2) Resources".
  346. http://sizif.mf.uni-lj.si/linux/cee/iso8859-2.html
  347. [This is a web page with all sorts of useful Latin-2 character set and
  348. font information.]
  349.