Merge branch 'dbmjz'
[exim.git] / doc / doc-txt / README
CommitLineData
495ae4b0
PH
1Exim Documentation
2------------------
3
4This 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
495ae4b0 16 spec.txt main specification of Exim
4aa45c31 17 experimental-spec.txt specification of experimental features
495ae4b0
PH
18
19
20PostScript
21----------
22
23The Exim specifications are also available in PostScript. This is not included
4aa45c31
PH
24in the main distribution because not everyone wants it. Wherever you got this
25distribution from should also have carried another file called
26exim-postscript-<version>.tar.gz which contains the PostScript documentation.
27When de-tarred it creates a directory called exim-postscript-<version> into
28which it places the files doc/filter.ps and doc/spec.ps.
495ae4b0
PH
29
30
31HTML
32----
33
4aa45c31
PH
34A conversion from the original sources into HTML is done to create the online
35documentation at http://www.exim.org. This set of files is also available for
36installation on other servers. Wherever you got this distribution from should
37also have carried another file called exim-html-<version>.tar.gz which contains
38the HTML documentation. When de-tarred it creates a directory called
39exim-html-<version> into which it places a directory called doc/html containing
40the set of HTML files. The kick off point is the traditional index.html.
495ae4b0
PH
41
42
43PDF
44---
45
46The Exim specifications are available in Portable Document Format. Wherever you
47got this distribution from should also have carried another file called
48exim-pdf-<version>.tar.gz which contains the PDF documentation. When de-tarred
49it creates a directory called exim-pdf-<version> into which it places the files
50doc/filter.pdf and doc/spec.pdf.
51
52
53TeXinfo
54-------
55
56A version of the documentation that has been converted to TeXinfo format is
57available in the distribution file exim-texinfo-<version>.gz. When de-tarred it
58creates a directory called exim-texinfo-<version> into which it places the
59files doc/filter.texinfo and doc/spec.texinfo.
60
4aa45c31
PH
61The conversion process is automatic, so the result isn't as nice as
62hand-maintained TeXinfo files would be, and some information is lost; for
63example, TeXinfo does not support the use of change bars.
495ae4b0
PH
64
65-- End --