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