diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/aerc-config.5.scd | 14 | ||||
-rw-r--r-- | doc/aerc-imap.5.scd | 15 | ||||
-rw-r--r-- | doc/aerc-maildir.5.scd | 15 | ||||
-rw-r--r-- | doc/aerc-notmuch.5.scd | 15 |
4 files changed, 59 insertions, 0 deletions
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd index 79025508..b7fba82d 100644 --- a/doc/aerc-config.5.scd +++ b/doc/aerc-config.5.scd @@ -525,6 +525,20 @@ Note that many of these configuration options are written for you, such as Default: Archive +*check-mail* + Specifies an interval to check for new mail. Mail will be checked at + startup, and every interval. IMAP accounts will check for mail in all + unselected folders, and the selected folder will continue to receive PUSH + mail notifications. Maildir/Notmuch folders must use *check-mail-cmd* in + conjunction with this option. See *aerc-maildir* and *aerc-notmuch* for + more information. + + Setting this option to 0 will disable check-mail + + Example: 5m + + Default: 0 + *copy-to* Specifies a folder to copy sent mails to, usually "Sent". diff --git a/doc/aerc-imap.5.scd b/doc/aerc-imap.5.scd index 5a20749a..99640b64 100644 --- a/doc/aerc-imap.5.scd +++ b/doc/aerc-imap.5.scd @@ -96,6 +96,21 @@ available: This option is only supported on linux. On other platforms, it will be ignored. +*check-mail-include* + Specifies the comma separated list of folders to include when checking for + new mail with *check-mail*. Names prefixed with ~ are interpreted as regular + expressions. + + Default: all folders + +*check-mail-exclude* + Specifies the comma separated list of folders to exclude when checking for + new mail with *check-mail*. Names prefixed with ~ are interpreted as regular + expressions. + Note that this overrides anything from *check-mail-include*. + + Default: no folders + # SEE ALSO *aerc*(1) *aerc-config*(5) diff --git a/doc/aerc-maildir.5.scd b/doc/aerc-maildir.5.scd index 7f6e7ccd..80bc0931 100644 --- a/doc/aerc-maildir.5.scd +++ b/doc/aerc-maildir.5.scd @@ -15,6 +15,21 @@ must be added manually to the *aerc-config*(5) file. The following maildir-specific options are available: +*check-mail-cmd* + Command to run in conjunction with *check-mail* option. + + Example: + mbsync -a + + Default: none + +*check-mail-timeout* + Timeout for the *check-mail-cmd*. The command will be stopped if it does + not complete in this interval and an error will be displayed. Increase from + the default if repeated errors occur + + Default: 10s + *source* maildir://path diff --git a/doc/aerc-notmuch.5.scd b/doc/aerc-notmuch.5.scd index a411c51f..44b6b9d2 100644 --- a/doc/aerc-notmuch.5.scd +++ b/doc/aerc-notmuch.5.scd @@ -20,6 +20,21 @@ must be added manually. In accounts.conf (see *aerc-config*(5)), the following notmuch-specific options are available: +*check-mail-cmd* + Command to run in conjunction with *check-mail* option. + + Example: + mbsync -a + + Default: none + +*check-mail-timeout* + Timeout for the *check-mail-cmd*. The command will be stopped if it does + not complete in this interval and an error will be displayed. Increase from + the default if repeated errors occur + + Default: 10s + *source* notmuch://path |