]> Pileus Git - ~andy/fetchmail/blobdiff - README
Drop BUGS.
[~andy/fetchmail] / README
diff --git a/README b/README
index cf1b5a11d88207339c168853204ba14a3c963c45..dc971eccf9a417fb2dd75ba047a3f7b88fe4379a 100644 (file)
--- a/README
+++ b/README
@@ -1,83 +1,50 @@
-               The fetchmail announcement 
+                        fetchmail README
 
-fetchmail is a full-featured, robust, well-documented POP2, POP3,
-APOP, and IMAP batch mail retrieval/forwarding utility intended to be
-used over 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
+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
+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).
 
-The fetchmail code was developed under Linux, but 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.
+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 program was originally authored (under the name
-popclient) by Carl Harris <ceharris@mal.com>. I, Eric S. Raymond,
-<esr@thyrsus.com> took over development in June 1996.  I subsequently
-renamed the program `fetchmail' to reflect the addition of IMAP
-support.  See the distribution files NEWS for detailed information on
-recent changes and NOTES for design notes.
+The fetchmail code was developed under Linux, but has also been
+extensively tested under the BSD variants, AIX, HP-UX versions 9 and
+10, SunOS, Solaris, NEXTSTEP, OSF 3.2, IRIX, and Rhapsody.
 
-Before accepting responsibility for the popclient sources from Carl, I
-had investigated and used and tinkered with every other UNIX
-remote-mail forwarder I could find, including fetchpop1.9,
-PopTart-0.9.3, get-mail, gwpop, pimp-1.0, pop-perl5-1.2, popc,
-popmail-1.6 and upop.  I learned from all of them, and fetchmail is a
-carefully-thought-out attempt to render obsolete every other program
-in its class.
+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.
 
-Here are fetchmail's main features.  Those unique to fetchmail are marked
-with **.
+See the distribution files FEATURES for a full list of features, NEWS
+for detailed information on recent changes, NOTES for design notes, and
+TODO for a list of things that still need doing.
 
-       *  **POP2, POP3, **APOP, **RPOP and **IMAP support.
+The INSTALL file describes how to configure and install fetchmail.
 
-       ** Host is auto-probed for a working server if no protocol is
-          specified for the connection.  Thus you don't need to know
-          what servers are running on your mail host in advance; the
-          verbose option will tell you which one succeeds.
+The fetchmail code appears to be stable and free of bugs affecting
+normal operation (that is, retrieving from POP3 or IMAP in single-drop
+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.
 
-       ** Delivery via via SMTP to the client machine's port 25.  This
-          means the retrieved mail automatically goes to the system
-          default MDA as if it were normal sender-initiated SMTP mail.
+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.
 
-       *  Easy control via command line or free-format run control file.
+You can get the code from the fetchmail home page:
 
-       *  Daemon mode -- fetchmail can be run in background to poll
-          one or more hosts at a specified interval.
+       http://fetchmail.berlios.de/
 
-       *  From:, To:, Cc:, and Reply-To: headers are rewritten so that 
-          usernames relative to the fetchmail host become fully-qualified
-          Internet addresses.  This enables replies to work correctly.
-          (Would be unique to fetchmail if I hadn't added it to fetchpop.)
+Enjoy!
 
-       *  Strict conformance to relevant RFCs and good debugging options.
-          You could use fetchmail to test and debug server implementatations.
-
-       *  Carefully written, comprehensive and up-to-date man page describing
-          not only modes of operation but also (**) how to interpret the most
-          common kinds of problems and what to do about deficient servers
-
-       *  Rugged, simple, and well-tested code -- the author relies on it
-           every day and it has never lost mail, not even in experimental
-          versions.
-
-       *  Large user community -- fetchmail has inherited a significant
-          user base from Carl Harris's popclient community.   This means
-          feedback is rapid, bugs get found and fixed rapidly.
-
-At this point, the fetchmail code appears to be stable and bug-free.
-It will probably undergo substantial change only if and when support
-for a new retrieval protocol or IMAP extensions are added.
-
-You can easily find the latest version of fetchmail from Eric's home page:
-
-       http://www.ccil.org/~esr
-
-Just chase the link to the freeware collection.  Besides fetchmail, it
-includes a tasty selection of Web authoring tools, programmer's aids,
-graphics libraries, compilers for bizarre languages, games, and 
-miscellaneous interesting hacks.  Enjoy!
-
-                                                       -- esr
+                                                       -- esr, ma