diff options
Diffstat (limited to 'doc/doc-txt/README')
-rw-r--r-- | doc/doc-txt/README | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/doc/doc-txt/README b/doc/doc-txt/README new file mode 100644 index 000000000..996f89274 --- /dev/null +++ b/doc/doc-txt/README @@ -0,0 +1,84 @@ +$Cambridge: exim/doc/doc-txt/README,v 1.1 2004/10/07 15:04:35 ph10 Exp $ + +Exim Documentation +------------------ + +This directory should contain the following files: + + ChangeLog most recent log of all changes to Exim + NewStuff features that haven't made it to the manual yet, + and/or a list of newly-added functionality + OptionLists.txt lists of all Exim's options + README this document + README.SIEVE notes on the Sieve support + Exim3.upgrade information about upgrading from release 2.12 to 3.00 + Exim4.upgrade information about upgrading from release 3.33 to 4.00 + dbm.discuss.txt discussion of DBM libraries + filter.txt specification of filter file contents + pcre.txt specification of PCRE regular expression library + pcretest.txt specification of the PCRE test program + spec.txt main specification of Exim + +The .txt files are straight ASCII text; spec.txt and filter.txt have change +bars on the right for changes from the previous editions. + + +PostScript +---------- + +The Exim specifications are also available in PostScript. This is not included +in the main distribution because not everyone wants it and it doesn't diff +well, causing patches to be very much larger than necessary. + +Wherever you got this distribution from should also have carried another file +called exim-postscript-<version>.tar.gz which contains the PostScript +documentation. When de-tarred it creates a directory called +exim-postscript-<version> into which it places the files doc/filter.ps and +doc/spec.ps. + + +HTML +---- + +A special conversion from the original sources via Texinfo into HTML is done to +create the online documentation at http://www.exim.org. This set of files is +also available for installation on other servers. Wherever you got this +distribution from should also have carried another file called +exim-html-<version>.tar.gz which contains the HTML documentation. When +de-tarred it creates a directory called exim-html-<version> into which it +places a directory called doc/html containing the set of HTML files. The kick +off points are: + + html/spec.html - specification (framed) + html/filter_toc.html - filter docs + + +PDF +--- + +The Exim specifications are available in Portable Document Format. Wherever you +got this distribution from should also have carried another file called +exim-pdf-<version>.tar.gz which contains the PDF documentation. When de-tarred +it creates a directory called exim-pdf-<version> into which it places the files +doc/filter.pdf and doc/spec.pdf. + + +TeXinfo +------- + +A version of the documentation that has been converted to TeXinfo format is +available in the distribution file exim-texinfo-<version>.gz. When de-tarred it +creates a directory called exim-texinfo-<version> into which it places the +files doc/filter.texinfo and doc/spec.texinfo. + +The conversion process is automatic (a Perl script) so the result isn't as nice +as hand-maintained TeXinfo files would be, and some information is lost; +for example, TeXinfo does not support the use of change bars. + +There is cgi-bin perl script called info2www which converts info files to +html on the fly so that the same info files can be read using the "info" +program, or from emacs, or from your favourite browser. This is available from + +http://www.ericsson.nl/info2www/info2www.html + +-- End -- |