maxsyncaccounts: improve documentation

Github-ref: https://github.com/OfflineIMAP/offlineimap/issues/520
Reviewed-by: Linus Arver <linusa@google.com>
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
This commit is contained in:
Nicolas Sebrecht 2018-01-26 19:47:48 +01:00
parent 67d35dbbcb
commit f732d6b2b6

View File

@ -77,14 +77,16 @@ accounts = Test
# This option stands in the [general] section. # This option stands in the [general] section.
# #
# Offlineimap can synchronize more than one account at a time. If you want to # Offlineimap can synchronize more than one account at a time. There are two
# enable this feature, set the below value to something greater than 1. To # ways to sync accounts concurrently:
# force it to synchronize only one account at a time, set it to 1.
# #
# NOTE: if you are using autorefresh and have more than one account, you must # 1. By running one offlineimap instance for each account (with the -a CLI
# set this number to be >= to the number of accounts you have; since any given # option). This is the recommended way. In this case, keep the following option
# sync run never "finishes" due to a timer, you will never sync your additional # to 1.
# accounts if this is 1. #
# 2. By allowing offlineimap to sync more than one account for an instance (not
# recommended). In this case, set the maxsyncaccounts option to a value greater
# than 1.
# #
#maxsyncaccounts = 1 #maxsyncaccounts = 1
@ -273,8 +275,13 @@ remoterepository = RemoteExample
# your mail periodically. If you want that, specify how frequently to do that # your mail periodically. If you want that, specify how frequently to do that
# (in minutes) here. Fractional minutes (ie, 3.25) is allowed. # (in minutes) here. Fractional minutes (ie, 3.25) is allowed.
# #
# If you want more than one account concurrently synced in this mode, don't # If you want more than one account concurrently synced in one instance of
# forget to set the maxsyncaccounts option accordingly. # offlineimap (not recommended), don't forget to increase the maxsyncaccounts
# option accordingly.
#
# NOTE: If you run systemd it's recommended to not enable this option and use
# the systemd timer instead (see the ./contrib/systemd/ directory in the
# repository).
# #
#autorefresh = 5 #autorefresh = 5
@ -1364,7 +1371,7 @@ remoteuser = username
# This option stands in the [Repository RemoteExample] section. # This option stands in the [Repository RemoteExample] section.
# #
# If offlineiamp is having troubles to download some UIDS, it's possible to get # If offlineimap is having troubles to download some UIDS, it's possible to get
# them ignored in a list. This only ignore the download. # them ignored in a list. This only ignore the download.
# #
# The function must return the list of UIDs (integers), None otherwise. It is # The function must return the list of UIDs (integers), None otherwise. It is