From f88f8cf984a6b63bf938ac42438e64520897bff6 Mon Sep 17 00:00:00 2001 From: Sebastian Spaeth Date: Sat, 7 Jan 2012 18:03:21 +0100 Subject: [PATCH] offlineimap.conf wording tweaks Clarify and improve wording in minor ways. Signed-off-by: Sebastian Spaeth --- docs/HACKING.rst | 3 +-- offlineimap.conf | 56 ++++++++++++++++++++++++------------------------ 2 files changed, 29 insertions(+), 30 deletions(-) diff --git a/docs/HACKING.rst b/docs/HACKING.rst index 728f957..71ec112 100644 --- a/docs/HACKING.rst +++ b/docs/HACKING.rst @@ -26,8 +26,7 @@ In order to involve into OfflineIMAP you need some knowledges about Git and our workflow. Don't be afraid if you don't know much, we would be pleased to help you. -You can find the API docs autogenerated on http://offlineimap.readthedocs.org, -(although it still does not work fully +You can find the API docs autogenerated on http://docs.offlineimap.org. Release cycles ============== diff --git a/offlineimap.conf b/offlineimap.conf index b6ff6e6..71ea2f7 100644 --- a/offlineimap.conf +++ b/offlineimap.conf @@ -238,37 +238,37 @@ remoterepository = RemoteExample # maxsize = 2000000 -# When you are starting to sync an already existing account yuo can tell offlineimap -# to sync messages from only the last x days. When you do this messages older than x -# days will be completely ignored. This can be useful for importing existing accounts -# when you do not want to download large amounts of archive email. - +# When you are starting to sync an already existing account you can tell +# offlineimap to sync messages from only the last x days. When you do +# this messages older than x days will be completely ignored. This can +# be useful for importing existing accounts when you do not want to +# download large amounts of archive email. +# # Messages older than maxage days will not be synced, their flags will -# not be changed, they will not be deleted etc. For offlineimap it will be like these -# messages do not exist. This will perform an IMAP search in the case of IMAP or Gmail -# and therefor requires that the server support server side searching. This will -# calculate the earliest day that would be included in the search and include all -# messages from that day until today. e.g. maxage = 3 to sync only the last 3 days mail - -# maxage = 3 +# not be changed, they will not be deleted etc. For offlineimap it will +# be like these messages do not exist. This will perform an IMAP search +# in the case of IMAP or Gmail and therefor requires that the server +# support server side searching. This will calculate the earliest day +# that would be included in the search and include all messages from +# that day until today. e.g. maxage = 3 to sync only the last 3 days +# mail +# +# maxage = -# Maildir format uses colon (:) separator between uniq name and info. +# Maildir file format uses colon (:) separator between uniq name and info. # Unfortunatelly colon is not allowed character in windows file name. If you # enable maildir-windows-compatible option, offlineimap will be able to store # messages on windows drive, but you will probably loose compatibility with # other programs working with the maildir - -# maildir-windows-compatible = no +# +#maildir-windows-compatible = no [Repository LocalExample] -# This is one of the two repositories that you'll work with given the -# above example. Each repository requires a "type" declaration. -# -# The types supported are Maildir and IMAP. -# +# Each repository requires a "type" declaration. The types supported for +# local repositories are Maildir and IMAP. type = Maildir @@ -278,12 +278,12 @@ type = Maildir localfolders = ~/Test -# You can specify the "path separator character" used for your Maildir -# folders. This is inserted in-between the components of the tree. -# It defaults to ".". If you want your Maildir folders to be nested, -# set it to "/". - -sep = . +# You can specify the "folder separator character" used for your Maildir +# folders. It is inserted in-between the components of the tree. If you +# want your folders to be nested directories, set it to "/". 'sep' is +# ignored for IMAP repositories, as it is queried automatically. +# +#sep = . # Some users may not want the atime (last access time) of folders to be # modified by OfflineIMAP. If 'restoreatime' is set to yes, OfflineIMAP @@ -291,11 +291,11 @@ sep = . # folder to their original value after each sync. # # In nearly all cases, the default should be fine. +# +#restoreatime = no -restoreatime = no [Repository RemoteExample] - # And this is the remote repository. We only support IMAP or Gmail here. type = IMAP