doc: add configuration section to notmuch-new(1)

Increase discoverability.
This commit is contained in:
David Bremner 2022-02-06 09:28:14 -04:00
parent 69289c5d62
commit 8060022bdf
2 changed files with 20 additions and 0 deletions

View file

@ -102,6 +102,8 @@ database.path
Default: see :ref:`database`
.. _index.decrypt:
index.decrypt
Policy for decrypting encrypted messages during indexing. Must be
one of: ``false``, ``auto``, ``nostash``, or ``true``.
@ -155,6 +157,8 @@ index.decrypt
Default: ``auto``.
.. _index.header:
index.header.<prefix>
Define the query prefix <prefix>, based on a mail header. For
example ``index.header.List=List-Id`` will add a probabilistic
@ -164,6 +168,8 @@ index.header.<prefix>
supported. See :any:`notmuch-search-terms(7)` for a list of existing
prefixes, and an explanation of probabilistic prefixes.
.. _maildir.synchronize_flags:
maildir.synchronize\_flags
If true, then the following maildir flags (in message filenames)
will be synchronized with the corresponding notmuch tags:
@ -197,6 +203,8 @@ maildir.synchronize\_flags
Default: ``true``.
.. _new.ignore:
new.ignore
A list to specify files and directories that will not be searched
for messages by :any:`notmuch-new(1)`. Each entry in the list is either:
@ -215,6 +223,8 @@ new.ignore
Default: empty list.
.. _new.tags:
new.tags
A list of tags that will be added to all messages incorporated by
**notmuch new**.

View file

@ -78,6 +78,16 @@ Supported options for **new** include
to optimize the scanning of directories for new mail. This option turns
that optimization off.
CONFIGURATION
=============
Indexing is influenced by the configuration options
:ref:`index.decrypt <index.decrypt>`, :ref:`index.header
<index.header>`, and :ref:`new.ignore <new.ignore>`. Tagging
is controlled by :ref:`new.tags <new.tags>` and
:ref:`maildir.synchronize_flags <maildir.synchronize_flags>`. See
:any:`notmuch-config(1)` for details.
EXIT STATUS
===========