Merge branches 'master' and 'master' of ssh://jpgarch@complete.org/~jpgarch/git/offli...

[offlineimap] / offlineimap.conf

diff --git a/offlineimap.conf b/offlineimap.conf
index 43cabafc4ad8e075665e1159e12784dd6bd1054f..996fe7a900131ef3e557f9658529471b8161b13a 100644 (file)
--- a/offlineimap.conf
+++ b/offlineimap.conf
@@ -221,17 +221,25 @@ remotehost = examplehost
 # Whether or not to use SSL.
 ssl = yes
 
+# SSL Client certificate (optional)
+# sslclientcert = /path/to/file.crt
+
+# SSL Client key (optional)
+# sslclientkey = /path/to/file.key
+
 # Specify the port.  If not specified, use a default port.
 # remoteport = 993
 
 # Specify the remote user name.
 remoteuser = username
 
-# There are four ways to specify the password for the remote IMAP
+# There are five ways to give the password for the remote IMAP
 # server:
 #
-# 1. No password at all specified in the config file.  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) the
+#    password from the matching entry will be used. Otherwise you
+#    will be prompted for the password when OfflineIMAP starts.
 #
 # 2. The remote password stored in this file with the remotepass
 #    option. Example:
@@ -253,6 +261,10 @@ remoteuser = username
 #
 # 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