[PATCHv2] Improve documentation on "reference" option

Sebastian Spaeth Sebastian at SSpaeth.de
Wed Mar 2 14:28:38 UTC 2011


It is apparently misleading what the reference option is for. This makes
it more clear hopefully.

Signed-off-by: Sebastian Spaeth <Sebastian at SSpaeth.de>
---
Not sure if v1 of this one came through. This is an improved documentation
text.
 offlineimap.conf |   12 ++++++++----
 1 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/offlineimap.conf b/offlineimap.conf
index d3be8be..72a3fa8 100644
--- a/offlineimap.conf
+++ b/offlineimap.conf
@@ -327,10 +327,14 @@ remoteuser = username
 
 ########## Advanced settings
 
-# Some IMAP servers need a "reference" which often refers to the
-# "folder root".  This is most commonly needed with UW IMAP, where
-# you might need to specify the directory in which your mail is
-# stored.  Most users will not need this.
+# Some IMAP servers need a "reference" which often refers to the "folder
+# root".  This is most commonly needed with UW IMAP, where you might
+# need to specify the directory in which your mail is stored. The
+# 'reference' value will be prefixed to all folder paths refering to
+# that repository. E.g. accessing folder 'INBOX' with reference = Mail
+# will try to access Mail/INBOX. Note that the nametrans and
+# folderfilter functions will still apply the full path including the
+# reference prefix.  Most users will not need this.
 #
 # reference = Mail
 
-- 
1.7.1




More information about the OfflineIMAP-project mailing list