diff options
| author | Robin Jarry <robin@jarry.cc> | 2022-12-06 11:11:47 +0100 |
|---|---|---|
| committer | Robin Jarry <robin@jarry.cc> | 2022-12-06 11:26:08 +0100 |
| commit | c1784b624aea6c93e398a90a4274abe158e72b8a (patch) | |
| tree | 25f06f286c0d910043592a4293490447373eac4e /doc/aerc-maildir.5.scd | |
| parent | c9524d265793775e4c3e326c7191471d982c1e66 (diff) | |
| download | aerc-c1784b624aea6c93e398a90a4274abe158e72b8a.tar.gz | |
doc: add synopsis for all settings
Instead of obscure descriptions for the settings format, add a synopsis
for all settings in the man pages.
Signed-off-by: Robin Jarry <robin@jarry.cc>
Acked-by: Bence Ferdinandy <bence@ferdinandy.com>
Diffstat (limited to 'doc/aerc-maildir.5.scd')
| -rw-r--r-- | doc/aerc-maildir.5.scd | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/doc/aerc-maildir.5.scd b/doc/aerc-maildir.5.scd index 528d7953..f83ca3d8 100644 --- a/doc/aerc-maildir.5.scd +++ b/doc/aerc-maildir.5.scd @@ -15,22 +15,20 @@ must be added manually to the _accounts.conf_ file (see *aerc-accounts*(5)). The following maildir-specific options are available: -*check-mail-cmd* +*check-mail-cmd* = _<command>_ Command to run in conjunction with *check-mail* option. Example: check-mail-cmd = mbsync -a -*check-mail-timeout* +*check-mail-timeout* = _<duration>_ 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>_ - +*source* = _maildir_|_maildirpp_://_<path>_ The *source* indicates the path to the directory containing your maildirs rather than one maildir specifically. |