]> git.cworth.org Git - notmuch/commitdiff
doc: add configuration section to notmuch-new(1)
authorDavid Bremner <david@tethera.net>
Sun, 6 Feb 2022 13:28:14 +0000 (09:28 -0400)
committerDavid Bremner <david@tethera.net>
Sun, 20 Feb 2022 13:33:56 +0000 (09:33 -0400)
Increase discoverability.

doc/man1/notmuch-config.rst
doc/man1/notmuch-new.rst

index 8ddfc1d6d285e50ece420b1b840532e2b3954a01..84a9e0233d1279b0891afc82115001efd1085731 100644 (file)
@@ -102,6 +102,8 @@ database.path
 
     Default: see :ref:`database`
 
 
     Default: see :ref:`database`
 
+.. _index.decrypt:
+
 index.decrypt
     Policy for decrypting encrypted messages during indexing.  Must be
     one of: ``false``, ``auto``, ``nostash``, or ``true``.
 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``.
 
 
     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
 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.
 
     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:
 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``.
 
 
     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:
 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.
 
 
     Default: empty list.
 
+.. _new.tags:
+
 new.tags
     A list of tags that will be added to all messages incorporated by
     **notmuch new**.
 new.tags
     A list of tags that will be added to all messages incorporated by
     **notmuch new**.
index 9cb4a54e75343733e3dfd6fa3ed8e00ad235f5dc..398f8813a834f464ea0b63eb6ce26df84fad6591 100644 (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.
 
    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
 ===========
 
 EXIT STATUS
 ===========