X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-config.rst;h=bc597957f7bb93d5f2521303470fccc8b84a90df;hb=d9af0af1646b6ca303e69076babd4cf071c1bf95;hp=899098084ae2beafea74017b3064de261c0a8917;hpb=2f4beda434c59f9e2f5b7c32d26543bad7217ad4;p=notmuch diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst index 89909808..bc597957 100644 --- a/doc/man1/notmuch-config.rst +++ b/doc/man1/notmuch-config.rst @@ -17,10 +17,6 @@ DESCRIPTION The **config** command can be used to get or set settings in the notmuch configuration file and corresponding database. -Items marked **[STORED IN DATABASE]** are only in the database. They -should not be placed in the configuration file, and should be accessed -programmatically as described in the SYNOPSIS above. - **get** The value of the specified configuration item is printed to stdout. If the item has multiple values (it is a list), each value @@ -38,7 +34,7 @@ programmatically as described in the SYNOPSIS above. Every configuration item is printed to stdout, each on a separate line of the form:: - *section*.\ *item*\ =\ *value* + section.item=value No additional whitespace surrounds the dot or equals sign characters. In a multiple-value item (a list), the values are @@ -54,6 +50,11 @@ The available configuration items are described below. Default: ``$MAILDIR`` variable if set, otherwise ``$HOME/mail``. +**database.hook_dir** + + Directory containing hooks run by notmuch commands. See + **notmuch-hooks(5)**. + **user.name** Your full name. @@ -134,15 +135,7 @@ The available configuration items are described below. Default: ``true``. -**crypto.gpg_path** - Name (or full path) of gpg binary to use in verification and - decryption of PGP/MIME messages. NOTE: This configuration item is - deprecated, and will be ignored if notmuch is built against GMime - 3.0 or later. - - Default: ``gpg``. - -**index.decrypt** **[STORED IN DATABASE]** +**index.decrypt** Policy for decrypting encrypted messages during indexing. Must be one of: ``false``, ``auto``, ``nostash``, or ``true``. @@ -195,12 +188,22 @@ The available configuration items are described below. Default: ``auto``. +**index.header.** + Define the query prefix , based on a mail header. For + example ``index.header.List=List-Id`` will add a probabilistic + prefix ``List:`` that searches the ``List-Id`` field. User + defined prefixes must not start with 'a'...'z'; in particular + adding a prefix with same name as a predefined prefix is not + supported. See **notmuch-search-terms(7)** for a list of existing + prefixes, and an explanation of probabilistic prefixes. + **built_with.** Compile time feature . Current possibilities include - "compact" (see **notmuch-compact(1)**) and "field_processor" (see - **notmuch-search-terms(7)**). + "retry_lock" (configure option, included by default). + (since notmuch 0.30, "compact" and "field_processor" are + always included.) -**query.** **[STORED IN DATABASE]** +**query.** Expansion for named query called . See **notmuch-search-terms(7)** for more information about named queries. @@ -212,8 +215,32 @@ The following environment variables can be used to control the behavior of notmuch. **NOTMUCH\_CONFIG** - Specifies the location of the notmuch configuration file. Notmuch - will use ${HOME}/.notmuch-config if this variable is not set. + Specifies the location of the notmuch configuration file. + +**NOTMUCH_PROFILE** + Selects among notmuch configurations. + +FILES +===== + +CONFIGURATION +------------- + +If ``NOTMUCH_CONFIG`` is unset, notmuch tries (in order) + +- ``$XDG_CONFIG_HOME/notmuch//config`` where ```` is + defined by ``$NOTMUCH_PROFILE`` or "default" +- ``${HOME}/.notmuch-config`` where ```` is + ``.$NOTMUCH_PROFILE`` or "" + +Hooks +----- + +If ``database.hook_dir`` is unset, notmuch tries (in order) + +- ``$XDG_CONFIG_HOME/notmuch//hooks`` where ```` is + defined by ``$NOTMUCH_PROFILE`` or "default" +- ``/.notmuch/hooks`` SEE ALSO ========