Generate fetchmailconf from Makefile to expand ${prefix} properly.

[~andy/fetchmail] / README

diff --git a/README b/README
index dd3c76f26beb96c0b8b97d28015c7a45c1f27e28..d7e885cd812893218f8fe99e3efe0c6ed30175e2 100644 (file)
--- a/README
+++ b/README
@@ -1,22 +1,33 @@
                         fetchmail README
 
-fetchmail is a free, full-featured, robust, well-documented remote
+Fetchmail is a free, full-featured, robust, well-documented remote
 mail retrieval and forwarding utility intended to be used over
-on-demand TCP/IP links (such as SLIP or PPP connections).  It supports
-POP2, POP3, RPOP, APOP, KPOP, all flavors of IMAP (including IMAP4rev1
-with RFC1731 Kerberos v4 authentication), and ESMTP ETRN.  It
+on-demand TCP/IP links (such as SLIP or PPP connections).  It
 retrieves mail from remote mail servers and forwards it to your local
 (client) machine's delivery system, so it can then be be read by
 normal mail user agents such as elm(1) or Mail(1).
 
+Fetchmail supports all standard mail-retrieval protocols in use on the
+Internet: POP2, POP3, RPOP, APOP, KPOP, IMAP2bis, IMAP4, IMAP4rev1
+ESMTP ETRN, and ODMR.  Fetchmail also fully supports authentication
+via GSSAPI, Kerberos 4 and 5, RFC1938 one-time passwords, Compuserve's
+POP3 with RPA, Microsoft's NTLM, Demon Internet's SDPS, or CRAM-MD5
+authentication a la RFC2195.  Fetchmail also supports end-to-end
+encryption with OpenSSL.
+
 The fetchmail code was developed under Linux, but has also been
-extensively tested under 4.4BSD, AIX, Solaris and NEXTSTEP.  It should be
-readily portable to other Unix variants (it uses GNU autoconf).  It
-has also been ported to QNX; to build under QNX, see the header
-comments in the Makefile.
+extensively tested under the BSD variants, AIX, HP-UX versions 9 and
+10, SunOS, Solaris, NEXTSTEP, OSF 3.2, IRIX, and Rhapsody.
+
+It should be readily portable to other Unix variants (it uses GNU
+autoconf).  It has been ported to LynxOS and BeOS and will build there
+without special action.  It has also been ported to QNX; to build
+under QNX, see the header comments in the Makefile.  It is reported to
+build and run under AmigaOS.
 
 See the distribution files FEATURES for a full list of features, NEWS
-for detailed information on recent changes and NOTES for design notes.
+for detailed information on recent changes, NOTES for design notes, and
+TODO for a list of things that still need doing.
 
 The fetchmail code appears to be stable and free of bugs affecting
 normal operation (that is, retrieving from POP3 or IMAP in single-drop
@@ -24,16 +35,14 @@ mode and forwarding via SMTP to sendmail).  It will probably undergo
 substantial change only if and when support for a new retrieval
 protocol or authentication mode is added.
 
-You can easily fetch the latest version of fetchmail via FTP from the
-following FTP directory:
-
-       ftp://ftp.ccil.org/pub/esr/fetchmail
+If you want to hack on this code, a list of known bugs and to-do items
+can be found in the file todo.html.
 
-Or you can get it from the fetchmail home page:
+You can get the code from the fetchmail home page:
 
-       http://www.ccil.org/~esr/fetchmail
+       http://fetchmail.berlios.de/
 
 Enjoy!
 
-                                                       -- esr
+                                                       -- esr, ma