]> Pileus Git - ~andy/fetchmail/blobdiff - README
Fix an incorrect anchor number.
[~andy/fetchmail] / README
diff --git a/README b/README
index 0003b720f890fbf2b097284f281aad7eec87c1aa..41cc71abc7d805a48b8daa479ba6de1dbcada92e 100644 (file)
--- a/README
+++ b/README
@@ -1,35 +1,51 @@
-                       README for popclient
+                        fetchmail README
 
-popclient is a full-featured, robust, well-documented POP2, POP3, APOP,
-and IMAP client originally developed by Carl Harris <ceharris@mal.com> and
-now maintained by Eric S. Raymond <esr@thyrsus.com>.
+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).
 
-popclient was developed under Linux and should be readily portable to other
-UNIX systems (it uses GNU autoconf).  It has also been ported to QNX; to build
-under QNX, see the header commets in the Makefile.
+fetchmail supports standard all mail-retrieval protocols in use on the
+Internet: POP2, POP3 (including POP3 with RFC1938 one-time passwords),
+RPOP, APOP, KPOP, Compuserve's POP3 with RPA, Microsoft's NTLM, Demon
+Internet's SDPS, all flavors of IMAP (including IMAP4rev1 with RFC1731
+Kerberos v4 or GSSAPI authentication or CRAM-MD5 authentication), and
+ESMTP ETRN.  Fetchmail also supports end-to-end encryption with OpenSSL.
 
-You can find the latest version of popclient from Eric's home page
+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.
 
-       http://www.ccil.org/~esr
+It should be readily portable to other Unix variants (it uses GNU
+autoconf).  It has been ported to LynxOS 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.
 
-Features of popclient include:
+Fetchmail is Y2K safe.
 
-       * POP2, POP3, APOP, RPOP and IMAP support with auto-probing for a
-         server on the host if no protocol is specified.
+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.
 
-       * Easy configuration via command line or free-format .poprc file.
+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.
 
-       * Daemon mode -- popmail can be run in background to poll
-         one or more hosts at a specified interval.
+You can easily fetch the latest version of fetchmail via FTP from the
+following FTP directory:
 
-       * Delivery via either file-append with mandatory locking or an
-         MDA you specify, or via SMTP to the client machine's port 25.
+       ftp://ftp.ccil.org/pub/esr/fetchmail
 
-       * From:, To:, Cc:, and Reply-To: headers are rewritten so that 
-         usernames relative to the popclient host become fully-qualified
-         Internet addresses.  This enables replies to work correctly.
+Or you can get it from the fetchmail home page:
+
+       http://www.tuxedo.org/~esr/fetchmail
+
+Enjoy!
 
-There is a man page at popclient.man.  A sample rc file is at sample.poprc.
-For a release history, see the file NEWS.
                                                        -- esr