Credit John Beck's fixes.

[~andy/fetchmail] / sample.rcfile

diff --git a/sample.rcfile b/sample.rcfile
index 45f4170e385c8936d2b4a8615731cc273c27d6ab..1d0b09a29aa3482d1a1064f3c731f2e9cbccab8f 100644 (file)
--- a/sample.rcfile
+++ b/sample.rcfile
@@ -1,8 +1,8 @@
-# fetchmail control file sample
+# fetchmail control file sample (remove this header comment from yours!)
 #
 # This file (or one of your own creation, rather) should be located 
 # in your home directory with the name .fetchmailrc.  Permissions on this
-# file may be no greater than -rw-------, or fetchmail will refuse to
+# file may be no greater than -rw------- (0600), or fetchmail will refuse to
 # use it.
 #
 # To see what effect your ~/.fetchmailrc file has, do 
@@ -18,86 +18,37 @@
 # When there is a conflict between the command-line arguments and the
 # arguments in this file, the command-line arguments take precedence.
 #
-# Legal keywords are
-#   poll                      -- must be followed by a mailserver name
-#   skip                      -- must be followed by a mailserver name
-#   protocol (or proto)       -- must be followed by a protocol ID
-#   port                      -- must be followed by a TCP/IP port number
-#   authenticate (or auth)    -- must be followed by an authentication type
-#   timeout                   -- must be followed by a numeric timeout value
-#   envelope                  -- must be followed by an envelope header name
-#   aka                       -- must be followed by one or more server aliases
-#   localdomains              -- must be followed by one or more domain names
-#   interface                 -- must be followed by device/IP address/mask
-#   monitor                   -- must be followed by IP address
-#
-#   username (or user)        -- must be followed by a name
-#   is                        -- must be followed by one or more names
-#   remotefolder (or remote)  -- must be followed by a filename
-#   password (or pass)        -- must be followed by a password string
-#   smtphost (or smtp)        -- must be followed by a host name
-#   mda                       -- must be followed by an MDA command string
-#   preconnect (or pre)       -- must be followed by an initialization command
-#
-#   keep
-#   flush
-#   fetchall
-#   rewrite
-#   stripcr
-#   dns
-#   received
-#   no keep
-#   no flush
-#   no fetchall
-#   no rewrite
-#   no stripcr
-#   no dns
-#   no received
-#   limit                     -- must be followed by numeric size limit
-#   fetchlimit                -- must be followed by numeric msg fetch limit
-#   batchlimit                -- must be followed by numeric SMTP batch limit
-#
-# Legal protocol identifiers are
-#   pop2 (or POP2)
-#   pop3 (or POP3)
-#   imap (or IMAP)
-#   apop (or APOP)
-#   rpop (or RPOP)
-#   kpop (or KPOP)
-#   etrn (or ETRN)
-#
-# Legal authentication types are
-#   login
-#   kerberos
-#
-# Legal global option statements are
-#
-#   set logfile =              -- must be followed by a string
-#
-# The noise keywords `and', `with', `has', `wants', and `options' are ignored
-# anywhere in an entry; they can be used to make it resemble English.  The
-# punctuation characters `,' `:' `;' are also ignored. 
-#
 # The run control file format is fully described (with more examples) on the
 # fetchmail manual page.
-# 
-# This is what the developer's .fetchmailrc looks like:
+#
+# This is what the former developer's .fetchmailrc looks like:
+
+set daemon 300 # Sleep 300 seconds after the poll, then poll again.
 
 defaults
+       # only poll when the sl0 interface is up (only available on some systems)
        interface "sl0/10.0.2.15"       # SLIRP standard address
+       # log in with name "esr" and do multidrop fetch for the users
+       # esr, fetchmail-friends, and magic-numbers
        user esr is esr fetchmail-friends magic-numbers here
+       # fetch (and delete after retrieval) all messages
        fetchall
 
 # Use this for production
-poll imap.ccil.org protocol IMAP:
-       no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org 
+poll imap.example.org protocol IMAP:
+       # do not use MX lookups to check of server aliases, but pass
+       # them explicitly:
+       no dns, aka snark.thyrsus.com thyrsus.com locke.example.org example.org 
        password my_remote_password;
 
 # Use this to test POP3
-skip pop3.ccil.org with protocol APOP:
-       no dns, aka snark.thyrsus.com thyrsus.com locke.ccil.org ccil.org 
+skip pop3.example.org with protocol APOP:
+       # do not use MX lookups to check of server aliases, but pass
+       # them explicitly:
+       no dns, aka snark.thyrsus.com thyrsus.com locke.example.org example.org 
        password my_apop_secret;
 
-# Use this to test against a different server
+# Use this to test against a different server - it is skipped unless
+# you give its name on fetchmail's command line.
 skip pop3.netaxs.com:
        password my_netaxs.password;