Update description of how the documentation is created.

[users/heiko/exim.git] / doc / doc-txt / README

diff --git a/doc/doc-txt/README b/doc/doc-txt/README
index 92fc17827195f818427f922c22cd6b04d643f3f1..4aa43a88e5a5c2516859b1d946200530369a2410 100644 (file)
--- a/doc/doc-txt/README
+++ b/doc/doc-txt/README
@@ -1,4 +1,4 @@
-$Cambridge: exim/doc/doc-txt/README,v 1.2 2005/06/27 18:32:20 tom Exp $
+$Cambridge: exim/doc/doc-txt/README,v 1.3 2007/04/17 13:06:10 ph10 Exp $
 
 Exim Documentation
 ------------------
@@ -15,42 +15,33 @@ This directory should contain the following files:
   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
+  pcrepattern.txt  specification of PCRE regular expression patterns
   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.
+  experimental-spec.txt  specification of experimental features
 
 
 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.
+in the main distribution because not everyone wants it. 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
+A conversion from the original sources 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 point is the traditional index.html.
 
 
 PDF
@@ -71,14 +62,8 @@ 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
+The conversion process is automatic, 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.
 
 -- End --