X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-config.rst;h=138501a8fdbff5175d361ac2f82bdea06894c149;hb=4b0c6fb2f1ba989fee554cb8fa2612046d6414a8;hp=129d4b81026191fe69651064333ff780e5709008;hpb=574b2436eeabf60c930ba227931ee87b0b151a65;p=notmuch diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst index 129d4b81..138501a8 100644 --- a/doc/man1/notmuch-config.rst +++ b/doc/man1/notmuch-config.rst @@ -19,32 +19,37 @@ DESCRIPTION The **config** command can be used to get or set settings in the notmuch configuration file and corresponding database. -**get** - The value of the specified configuration item is printed to - stdout. If the item has multiple values (it is a list), each value - is separated by a newline character. +.. program:: config -**set** - The specified configuration item is set to the given value. To - specify a multiple-value item (a list), provide each value as a - separate command-line argument. +.. option:: get - If no values are provided, the specified configuration item will - be removed from the configuration file. + The value of the specified configuration item is printed to + stdout. If the item has multiple values (it is a list), each value + is separated by a newline character. - With the `--database` option, updates configuration metadata - stored in the database, rather than the default (text) - configuration file. +.. option:: set -**list** - Every configuration item is printed to stdout, each on a separate - line of the form:: + The specified configuration item is set to the given value. To + specify a multiple-value item (a list), provide each value as a + separate command-line argument. - section.item=value + If no values are provided, the specified configuration item will + be removed from the configuration file. - No additional whitespace surrounds the dot or equals sign - characters. In a multiple-value item (a list), the values are - separated by semicolon characters. + With the `--database` option, updates configuration metadata + stored in the database, rather than the default (text) + configuration file. + +.. option:: list + + Every configuration item is printed to stdout, each on a separate + line of the form:: + + section.item=value + + No additional whitespace surrounds the dot or equals sign + characters. In a multiple-value item (a list), the values are + separated by semicolon characters. The available configuration items are described below. Non-absolute paths are presumed relative to `$HOME` for items in section @@ -76,10 +81,13 @@ paths are presumed relative to `$HOME` for items in section `backups`. **database.hook_dir** - Directory containing hooks run by notmuch commands. See :any:`notmuch-hooks(5)`. + History: this configuration value was introduced in notmuch 0.32. + + Default: See HOOKS, below. + **user.name** Your full name. @@ -243,7 +251,7 @@ CONFIGURATION Notmuch configuration file search order: -1. File specified by ``--config=FILE`` global option; see +1. File specified by :option:`notmuch --config` global option; see :any:`notmuch(1)`. 2. File specified by :envvar:`NOTMUCH_CONFIG` environment variable. @@ -256,7 +264,7 @@ Notmuch configuration file search order: by :envvar:`NOTMUCH_PROFILE` environment variable if set, ``$HOME/.notmuch-config`` otherwise. -Hooks +HOOKS ----- Notmuch hook directory search order: