[PATCH] offlineimap.conf: Clarify password options via netrc

[Sebastian Spaeth]

Document that only one user name per host name can be given via netrc
file.  Reformat the enumeration text.

Signed-off-by: Sebastian Spaeth <Sebastian at SSpaeth.de>
---
Improve docs to make things clear. Applies against current master.

 offlineimap.conf |   44 +++++++++++++++++++++-----------------------
 1 files changed, 21 insertions(+), 23 deletions(-)

diff --git a/offlineimap.conf b/offlineimap.conf
index c0ff8d7..987b6b4 100644
--- a/offlineimap.conf
+++ b/offlineimap.conf
@@ -289,39 +289,37 @@ ssl = yes
 # Specify the remote user name.
 remoteuser = username
 
-# There are five ways to give the password for the remote IMAP
-# server:
+# There are five ways to specify the password for the IMAP server:
 #
-# 1. No password at all specified in the config file. If a matching entry is
-#    found in ~/.netrc (see netrc (5) for information) the password from the
-#    matching entry will be used. If there is no ~/.netrc file but there is an
-#    /etc/netrc file, the password will instead be taken from there. Otherwise 
-#    you will be prompted for the password when OfflineIMAP starts.
+# 1. No password at all specified in the config file.
+#    If a matching entry is found in ~/.netrc (see netrc (5) for
+#    information) this password will be used. Do note that netrc only
+#    allows one entry per hostname. If there is no ~/.netrc file but
+#    there is an /etc/netrc file, the password will instead be taken
+#    from there. Otherwise you will be prompted for the password when
+#    OfflineIMAP starts when using a UI that supports this.
 #
 # 2. The remote password stored in this file with the remotepass
 #    option. Example:
-#
-# remotepass = mypassword
+#    remotepass = mypassword
 #
 # 3. The remote password stored as a single line in an external
 #    file, which is referenced by the remotefile option.  Example:
-#
-# remotepassfile = ~/Password.IMAP.Account1
+#    remotepassfile = ~/Password.IMAP.Account1
 #
 # 4. With a preauth tunnel.  With this method, you invoke an external
-# program that is guaranteed *NOT* to ask for a password, but rather
-# to read from stdin and write to stdout an IMAP procotol stream
-# that begins life in the PREAUTH state.  When you use a tunnel,
-# you do NOT specify a user or password (if you do, they'll be
-# ignored.)  Instead, you specify a preauthtunnel, as this
-# example illustrates for Courier IMAP on Debian:
-#
-# preauthtunnel = ssh -q imaphost '/usr/bin/imapd ./Maildir'
-#
-# 5. If you are using Kerberos and have the Python Kerberos package installed,
-# you should not specify a remotepass.  If the user has a valid
-# Kerberos TGT, OfflineIMAP will figure out the rest all by itself, and
-# fall back to password authentication if needed.
+#    program that is guaranteed *NOT* to ask for a password, but rather
+#    to read from stdin and write to stdout an IMAP procotol stream that
+#    begins life in the PREAUTH state.  When you use a tunnel, you do
+#    NOT specify a user or password (if you do, they'll be ignored.)
+#    Instead, you specify a preauthtunnel, as this example illustrates
+#    for Courier IMAP on Debian:
+#    preauthtunnel = ssh -q imaphost '/usr/bin/imapd ./Maildir'
+#
+# 5. If you are using Kerberos and have the Python Kerberos package
+#    installed, you should not specify a remotepass.  If the user has a
+#    valid Kerberos TGT, OfflineIMAP will figure out the rest all by
+#    itself, and fall back to password authentication if needed.
 
 ########## Advanced settings
 
-- 
1.7.1