From 8060022bdf163128261132d63a479744013688c9 Mon Sep 17 00:00:00 2001 From: David Bremner Date: Sun, 6 Feb 2022 09:28:14 -0400 Subject: [PATCH] doc: add configuration section to notmuch-new(1) Increase discoverability. --- doc/man1/notmuch-config.rst | 10 ++++++++++ doc/man1/notmuch-new.rst | 10 ++++++++++ 2 files changed, 20 insertions(+) diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst index 8ddfc1d6..84a9e023 100644 --- a/doc/man1/notmuch-config.rst +++ b/doc/man1/notmuch-config.rst @@ -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. Define the query prefix , based on a mail header. For example ``index.header.List=List-Id`` will add a probabilistic @@ -164,6 +168,8 @@ index.header. 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**. diff --git a/doc/man1/notmuch-new.rst b/doc/man1/notmuch-new.rst index 9cb4a54e..398f8813 100644 --- a/doc/man1/notmuch-new.rst +++ b/doc/man1/notmuch-new.rst @@ -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 `, :ref:`index.header +`, and :ref:`new.ignore `. Tagging +is controlled by :ref:`new.tags ` and +:ref:`maildir.synchronize_flags `. See +:any:`notmuch-config(1)` for details. + EXIT STATUS =========== -- 2.43.0