[PATCH 9/9] doc: document user header indexing.

Subject: [PATCH 9/9] doc: document user header indexing.

Date: Sun, 28 Apr 2019 20:10:49 -0300

To: David Bremner, notmuch@notmuchmail.org


From: David Bremner

It's a bit odd that the primary documentation is in notmuch-config,
but it is consistent with the "query:" prefix.
 doc/man1/notmuch-config.rst       | 9 +++++++++
 doc/man7/notmuch-search-terms.rst | 3 +++
 2 files changed, 12 insertions(+)

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.
     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

notmuch mailing list