offlineimap.conf: Clarify password options via netrc

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@SSpaeth.de>
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
This commit is contained in:
Sebastian Spaeth 2011-03-22 11:01:52 +01:00 committed by Nicolas Sebrecht
parent fe0e17e45f
commit 3f77afeb8a

View File

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