paths are presumed relative to `$HOME` for items in section
**database**.
-built_with.<name>
+.. nmconfig:: built_with.<name>
+
Compile time feature <name>. Current possibilities include
"retry_lock" (configure option, included by default).
(since notmuch 0.30, "compact" and "field_processor" are
always included.)
-database.autocommit
+.. nmconfig:: database.autocommit
How often to commit transactions to disk. `0` means wait until
command completes, otherwise an integer `n` specifies to commit to
History: this configuration value was introduced in notmuch 0.33.
-database.backup_dir
+.. nmconfig:: database.backup_dir
+
Directory to store tag dumps when upgrading database.
History: this configuration value was introduced in notmuch 0.32.
Default: A sibling directory of the Xapian database called
`backups`.
-database.hook_dir
+.. nmconfig:: database.hook_dir
+
Directory containing hooks run by notmuch commands. See
:any:`notmuch-hooks(5)`.
Default: See HOOKS, below.
-database.mail_root
+.. nmconfig:: database.mail_root
+
The top-level directory where your mail currently exists and to
where mail will be delivered in the future. Files should be
individual email messages.
History: this configuration value was introduced in notmuch 0.32.
Default: For compatibility with older configurations, the value of
- database.path is used if **database.mail\_root** is unset.
+ database.path is used if :nmconfig:`database.mail_root` is unset.
+
+.. nmconfig:: database.path
-database.path
Notmuch will store its database here, (in
- sub-directory named ``.notmuch`` if **database.mail\_root**
+ sub-directory named ``.notmuch`` if :nmconfig:`database.mail_root`
is unset).
Default: see :ref:`database`
-index.decrypt
+.. nmconfig:: git.path
+
+ Default location for git repository for :any:`notmuch-git`.
+
+.. nmconfig:: git.safe_fraction
+
+ Some :any:`notmuch-git` operations check that the fraction of
+ messages changed (in the database or in git, as appropriate) is not
+ too large. This item controls what fraction of total messages is
+ considered "not too large".
+
+.. nmconfig:: git.tag_prefix
+
+ Default tag prefix (filter) for :any:`notmuch-git`.
+
+.. nmconfig:: index.as_text
+
+ List of regular expressions (without delimiters) for MIME types to
+ be indexed as text. Currently this applies only to attachments. By
+ default the regex matches anywhere in the content type; if the
+ user wants an anchored match, they should include anchors in their
+ regexes.
+
+ History: This configuration value was introduced in notmuch 0.38.
+
+.. nmconfig:: index.decrypt
+
Policy for decrypting encrypted messages during indexing. Must be
one of: ``false``, ``auto``, ``nostash``, or ``true``.
Default: ``auto``.
-index.header.<prefix>
+.. _index.header:
+
+.. nmconfig:: index.header.<prefix>
+
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
supported. See :any:`notmuch-search-terms(7)` for a list of existing
prefixes, and an explanation of probabilistic prefixes.
-maildir.synchronize\_flags
+.. nmconfig:: maildir.synchronize_flags
+
If true, then the following maildir flags (in message filenames)
will be synchronized with the corresponding notmuch tags:
Default: ``true``.
-new.ignore
+.. nmconfig:: 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:
Default: empty list.
-new.tags
+.. nmconfig:: new.tags
+
A list of tags that will be added to all messages incorporated by
**notmuch new**.
Default: ``unread;inbox``.
-query.<name>
+.. nmconfig:: query.<name>
+
Expansion for named query called <name>. See
:any:`notmuch-search-terms(7)` for more information about named
queries.
-search.exclude\_tags
+.. nmconfig:: search.exclude_tags
+
A list of tags that will be excluded from search results by
default. Using an excluded tag in a query will override that
exclusion.
Default: empty list. Note that :any:`notmuch-setup(1)` puts
``deleted;spam`` here when creating new configuration file.
-.. _show.extra_headers:
-
-show.extra\_headers
+.. nmconfig:: show.extra_headers
By default :any:`notmuch-show(1)` includes the following headers
in structured output if they are present in the message:
Default: empty list.
-squery.<name>
+.. nmconfig:: squery.<name>
+
Expansion for named query called <name>, using s-expression syntax. See
:any:`notmuch-sexp-queries(7)` for more information about s-expression
queries.
-user.name
+.. nmconfig:: user.name
+
Your full name.
Default: ``$NAME`` variable if set, otherwise read from
``/etc/passwd``.
-user.other\_email
+.. nmconfig:: user.other_email
+
A list of other email addresses at which you receive email
- (see also, :ref:`user.primary_email <user.primary_email>`).
+ (see also, :nmconfig:`user.primary_email`)
Default: not set.
-.. _user.primary_email:
+.. nmconfig:: user.primary_email
-user.primary\_email
Your primary email address.
Default: ``$EMAIL`` variable if set, otherwise constructed from
projects / notmuch / blobdiff