]> Pileus Git - ~andy/fetchmail/blobdiff - README
Update on exchange attachments.
[~andy/fetchmail] / README
diff --git a/README b/README
index f60fb7a0f7a2a660679a78ec831cf409b847113c..becc888b8697227f2543d7a8dc58b9fcc1df00db 100644 (file)
--- a/README
+++ b/README
@@ -1,30 +1,53 @@
-                       README for popclient 3.0
+                        fetchmail README
 
-popclient is a full-featured, robust, well-documented POP2, POP3 and
-APOP 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).
 
-You can find the latest version of popclient from Eric's home page
+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.
 
-       http://www.ccil.org/~esr
+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.
 
-Features of POP include:
+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.
 
-       * POP2, POP3 and APOP support
+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.
+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.
 
-       * Delivery via either file-append with mandatory locking or an
-         MDA you specify.
+You can easily fetch the latest version of fetchmail via FTP from the
+following FTP directory:
 
-       * 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.
+       ftp://ftp.ccil.org/pub/esr/fetchmail
+
+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