doc: describe new config framework

Remove STORED IN DATABASE discussion, describe search rules.
Currently profiles seem a bit pointless. They will make more sense
when they apply to databases as well.
This commit is contained in:
David Bremner 2021-01-10 11:54:35 -04:00
parent f61d88c6f4
commit d9af0af164
2 changed files with 37 additions and 12 deletions

View file

@ -17,10 +17,6 @@ DESCRIPTION
The **config** command can be used to get or set settings in the notmuch The **config** command can be used to get or set settings in the notmuch
configuration file and corresponding database. 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** **get**
The value of the specified configuration item is printed to The value of the specified configuration item is printed to
stdout. If the item has multiple values (it is a list), each value stdout. If the item has multiple values (it is a list), each value
@ -54,6 +50,11 @@ The available configuration items are described below.
Default: ``$MAILDIR`` variable if set, otherwise ``$HOME/mail``. Default: ``$MAILDIR`` variable if set, otherwise ``$HOME/mail``.
**database.hook_dir**
Directory containing hooks run by notmuch commands. See
**notmuch-hooks(5)**.
**user.name** **user.name**
Your full name. Your full name.
@ -134,7 +135,7 @@ The available configuration items are described below.
Default: ``true``. Default: ``true``.
**index.decrypt** **[STORED IN DATABASE]** **index.decrypt**
Policy for decrypting encrypted messages during indexing. Must be Policy for decrypting encrypted messages during indexing. Must be
one of: ``false``, ``auto``, ``nostash``, or ``true``. one of: ``false``, ``auto``, ``nostash``, or ``true``.
@ -187,7 +188,7 @@ The available configuration items are described below.
Default: ``auto``. Default: ``auto``.
**index.header.<prefix>** **[STORED IN DATABASE]** **index.header.<prefix>**
Define the query prefix <prefix>, based on a mail header. For Define the query prefix <prefix>, based on a mail header. For
example ``index.header.List=List-Id`` will add a probabilistic example ``index.header.List=List-Id`` will add a probabilistic
prefix ``List:`` that searches the ``List-Id`` field. User prefix ``List:`` that searches the ``List-Id`` field. User
@ -202,7 +203,7 @@ The available configuration items are described below.
(since notmuch 0.30, "compact" and "field_processor" are (since notmuch 0.30, "compact" and "field_processor" are
always included.) always included.)
**query.<name>** **[STORED IN DATABASE]** **query.<name>**
Expansion for named query called <name>. See Expansion for named query called <name>. See
**notmuch-search-terms(7)** for more information about named **notmuch-search-terms(7)** for more information about named
queries. queries.
@ -214,8 +215,32 @@ The following environment variables can be used to control the behavior
of notmuch. of notmuch.
**NOTMUCH\_CONFIG** **NOTMUCH\_CONFIG**
Specifies the location of the notmuch configuration file. Notmuch Specifies the location of the notmuch configuration file.
will use ${HOME}/.notmuch-config if this variable is not set.
**NOTMUCH_PROFILE**
Selects among notmuch configurations.
FILES
=====
CONFIGURATION
-------------
If ``NOTMUCH_CONFIG`` is unset, notmuch tries (in order)
- ``$XDG_CONFIG_HOME/notmuch/<profile>/config`` where ``<profile>`` is
defined by ``$NOTMUCH_PROFILE`` or "default"
- ``${HOME}/.notmuch-config<profile>`` where ``<profile>`` is
``.$NOTMUCH_PROFILE`` or ""
Hooks
-----
If ``database.hook_dir`` is unset, notmuch tries (in order)
- ``$XDG_CONFIG_HOME/notmuch/<profile>/hooks`` where ``<profile>`` is
defined by ``$NOTMUCH_PROFILE`` or "default"
- ``<database.path>/.notmuch/hooks``
SEE ALSO SEE ALSO
======== ========

View file

@ -5,15 +5,15 @@ notmuch-hooks
SYNOPSIS SYNOPSIS
======== ========
$DATABASEDIR/.notmuch/hooks/* <hook_dir>/{pre-new, post-new, post-insert}
DESCRIPTION DESCRIPTION
=========== ===========
Hooks are scripts (or arbitrary executables or symlinks to such) that Hooks are scripts (or arbitrary executables or symlinks to such) that
notmuch invokes before and after certain actions. These scripts reside notmuch invokes before and after certain actions. These scripts reside
in the .notmuch/hooks directory within the database directory and must in a directory defined as described in **notmuch-config(1)**. They
have executable permissions. must have executable permissions.
The currently available hooks are described below. The currently available hooks are described below.