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.
This commit is contained in:
David Bremner 2019-02-18 09:08:48 -04:00
parent adb53b0737
commit 9dedb23b47
2 changed files with 12 additions and 0 deletions

View file

@ -195,6 +195,15 @@ The available configuration items are described below.
Default: ``auto``. 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>** **built_with.<name>**
Compile time feature <name>. Current possibilities include Compile time feature <name>. Current possibilities include
"compact" (see **notmuch-compact(1)**) and "field_processor" (see "compact" (see **notmuch-compact(1)**) and "field_processor" (see

View file

@ -169,6 +169,9 @@ property:<key>=<value>
can be present on a given message with several different values. can be present on a given message with several different values.
See **notmuch-properties(7)** for more details. See **notmuch-properties(7)** for more details.
User defined prefixes are also supported, see **notmuch-config(1)** for
details.
Operators Operators
--------- ---------