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-notmuch.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-notmuch.5.scd')
-rw-r--r-- | doc/aerc-notmuch.5.scd | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/doc/aerc-notmuch.5.scd b/doc/aerc-notmuch.5.scd index 1265b4c5..0ba57d1e 100644 --- a/doc/aerc-notmuch.5.scd +++ b/doc/aerc-notmuch.5.scd @@ -20,22 +20,20 @@ must be added manually. In _accounts.conf_ (see *aerc-accounts*(5)), the following notmuch-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* - notmuch://_<path>_ + Default: _10s_ +*source* = notmuch://_<path>_ The *source* indicates the path to the directory containing your notmuch database (usually a _.notmuch/_ folder). @@ -47,7 +45,7 @@ options are available: source = notmuch://~/mail -*query-map* +*query-map* = _<file>_ Path to a file containing a mapping from display name to notmuch query in the form of *<NAME>*=_<QUERY>_. @@ -56,13 +54,13 @@ options are available: e.g. inbox=tag:inbox and not tag:archived -*exclude-tags* +*exclude-tags* = _<tag1,tag2,tag3...>_ Comma separated list of tags which will be excluded from query results, unless explicitly mentioned in the query. This can for example be useful if you use an _archive_ or _spam_ tag. -*maildir-store* +*maildir-store* = _<path>_ Path to the maildir store containing the message files backing the notmuch database. This is often the same as the notmuch database path. This is optional. If specified, it will be used by aerc to list |