doc/doc-txt/README

   1 Exim Documentation
   2 ------------------
   3
   4 This directory should contain the following files:
   5
   6   ChangeLog        most recent log of all changes to Exim
   7   NewStuff         features that haven't made it to the manual yet,
   8                    and/or a list of newly-added functionality
   9   OptionLists.txt  lists of all Exim's options
  10   README           this document
  11   README.SIEVE     notes on the Sieve support
  12   Exim3.upgrade    information about upgrading from release 2.12 to 3.00
  13   Exim4.upgrade    information about upgrading from release 3.33 to 4.00
  14   dbm.discuss.txt  discussion of DBM libraries
  15   filter.txt       specification of filter file contents
  16   spec.txt         main specification of Exim
  17   experimental-spec.txt  specification of experimental features
  18
  19
  20 PostScript
  21 ----------
  22
  23 The Exim specifications are also available in PostScript. This is not included
  24 in the main distribution because not everyone wants it. Wherever you got this
  25 distribution from should also have carried another file called
  26 exim-postscript-<version>.tar.gz which contains the PostScript documentation.
  27 When de-tarred it creates a directory called exim-postscript-<version> into
  28 which it places the files doc/filter.ps and doc/spec.ps.
  29
  30
  31 HTML
  32 ----
  33
  34 A conversion from the original sources into HTML is done to create the online
  35 documentation at http://www.exim.org. This set of files is also available for
  36 installation on other servers. Wherever you got this distribution from should
  37 also have carried another file called exim-html-<version>.tar.gz which contains
  38 the HTML documentation. When de-tarred it creates a directory called
  39 exim-html-<version> into which it places a directory called doc/html containing
  40 the set of HTML files. The kick off point is the traditional index.html.
  41
  42
  43 PDF
  44 ---
  45
  46 The Exim specifications are available in Portable Document Format. Wherever you
  47 got this distribution from should also have carried another file called
  48 exim-pdf-<version>.tar.gz which contains the PDF documentation. When de-tarred
  49 it creates a directory called exim-pdf-<version> into which it places the files
  50 doc/filter.pdf and doc/spec.pdf.
  51
  52
  53 TeXinfo
  54 -------
  55
  56 A version of the documentation that has been converted to TeXinfo format is
  57 available in the distribution file exim-texinfo-<version>.gz. When de-tarred it
  58 creates a directory called exim-texinfo-<version> into which it places the
  59 files doc/filter.texinfo and doc/spec.texinfo.
  60
  61 The conversion process is automatic, so the result isn't as nice as
  62 hand-maintained TeXinfo files would be, and some information is lost; for
  63 example, TeXinfo does not support the use of change bars.
  64
  65 -- End --