diff options
| author | David Bremner <david@tethera.net> | 2019-02-18 09:08:48 -0400 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2019-05-25 07:21:21 -0300 |
| commit | 9dedb23b47961047d75ef08210481018042d0baf (patch) | |
| tree | 9ae9b9ffd38049d6a5c47849b894ea1e831e3d94 /doc | |
| parent | adb53b073791f710b93a8fc755b6b7b606bf7fd1 (diff) | |
doc: document user header indexing.
It's a bit odd that the primary documentation is in notmuch-config,
but it is consistent with the "query:" prefix.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man1/notmuch-config.rst | 9 | ||||
| -rw-r--r-- | doc/man7/notmuch-search-terms.rst | 3 |
2 files changed, 12 insertions, 0 deletions
diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst index 89909808..28487079 100644 --- a/doc/man1/notmuch-config.rst +++ b/doc/man1/notmuch-config.rst @@ -195,6 +195,15 @@ The available configuration items are described below. Default: ``auto``. +**index.header.<prefix>** **[STORED IN DATABASE]** + Define the query prefix <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.<name>** Compile time feature <name>. Current possibilities include "compact" (see **notmuch-compact(1)**) and "field_processor" (see diff --git a/doc/man7/notmuch-search-terms.rst b/doc/man7/notmuch-search-terms.rst index fd8bf634..1dd2dc58 100644 --- a/doc/man7/notmuch-search-terms.rst +++ b/doc/man7/notmuch-search-terms.rst @@ -169,6 +169,9 @@ property:<key>=<value> can be present on a given message with several different values. See **notmuch-properties(7)** for more details. +User defined prefixes are also supported, see **notmuch-config(1)** for +details. + Operators --------- |