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