paths are presumed relative to `$HOME` for items in section
**database**.
-**database.path**
- Notmuch will store its database here, (in
- sub-directory named ``.notmuch`` if **database.mail\_root**
- is unset).
+.. nmconfig:: built_with.<name>
- Default: see :ref:`database`
+ 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.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.
+.. nmconfig:: database.autocommit
- History: this configuration value was introduced in notmuch 0.32.
+ How often to commit transactions to disk. `0` means wait until
+ command completes, otherwise an integer `n` specifies to commit to
+ disk after every `n` completed transactions.
- Default: For compatibility with older configurations, the value of
- database.path is used if **database.mail\_root** is unset.
+ History: this configuration value was introduced in notmuch 0.33.
+
+.. nmconfig:: database.backup_dir
-**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.autocommit**
-
- How often to commit transactions to disk. `0` means wait until
- command completes, otherwise an integer `n` specifies to commit to
- disk after every `n` completed transactions.
-
- History: this configuration value was introduced in notmuch 0.33.
-
-**user.name**
- Your full name.
-
- Default: ``$NAME`` variable if set, otherwise read from
- ``/etc/passwd``.
+.. nmconfig:: database.mail_root
-**user.primary\_email**
- Your primary email address.
-
- Default: ``$EMAIL`` variable if set, otherwise constructed from
- the username and hostname of the current machine.
-
-**user.other\_email**
- A list of other email addresses at which you receive email.
+ 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.
- Default: not set.
+ History: this configuration value was introduced in notmuch 0.32.
-**new.tags**
- A list of tags that will be added to all messages incorporated by
- **notmuch new**.
+ Default: For compatibility with older configurations, the value of
+ database.path is used if :nmconfig:`database.mail_root` is unset.
- Default: ``unread;inbox``.
+.. nmconfig:: database.path
-**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:
+ Notmuch will store its database here, (in
+ sub-directory named ``.notmuch`` if :nmconfig:`database.mail_root`
+ is unset).
- A file or a directory name, without path, that will be ignored,
- regardless of the location in the mail store directory hierarchy.
+ Default: see :ref:`database`
- Or:
+.. nmconfig:: git.path
- A regular expression delimited with // that will be matched
- against the path of the file or directory relative to the database
- path. Matching files and directories will be ignored. The
- beginning and end of string must be explicitly anchored. For
- example, /.*/foo$/ would match "bar/foo" and "bar/baz/foo", but
- not "foo" or "bar/foobar".
+ Default location for git repository for :any:`notmuch-git`.
- Default: empty list.
+.. nmconfig:: git.safe_fraction
-**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.
+ 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".
- Default: empty list. Note that :any:`notmuch-setup(1)` puts
- ``deleted;spam`` here when creating new configuration file.
+.. nmconfig:: git.tag_prefix
-**maildir.synchronize\_flags**
- If true, then the following maildir flags (in message filenames)
- will be synchronized with the corresponding notmuch tags:
+ Default tag prefix (filter) for :any:`notmuch-git`.
- +--------+-----------------------------------------------+
- | Flag | Tag |
- +========+===============================================+
- | D | draft |
- +--------+-----------------------------------------------+
- | F | flagged |
- +--------+-----------------------------------------------+
- | P | passed |
- +--------+-----------------------------------------------+
- | R | replied |
- +--------+-----------------------------------------------+
- | S | unread (added when 'S' flag is not present) |
- +--------+-----------------------------------------------+
+.. nmconfig:: index.as_text
- The :any:`notmuch-new(1)` command will notice flag changes in
- filenames and update tags, while the :any:`notmuch-tag(1)` and
- :any:`notmuch-restore(1)` commands will notice tag changes and
- update flags in filenames.
+ 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.
- If there have been any changes in the maildir (new messages added,
- old ones removed or renamed, maildir flags changed, etc.), it is
- advisable to run :any:`notmuch-new(1)` before
- :any:`notmuch-tag(1)` or :any:`notmuch-restore(1)` commands to
- ensure the tag changes are properly synchronized to the maildir
- flags, as the commands expect the database and maildir to be in
- sync.
+ History: This configuration value was introduced in notmuch 0.38.
- Default: ``true``.
+.. nmconfig:: index.decrypt
-**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.
-**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.)
+.. nmconfig:: maildir.synchronize_flags
+
+ If true, then the following maildir flags (in message filenames)
+ will be synchronized with the corresponding notmuch tags:
+
+ +--------+-----------------------------------------------+
+ | Flag | Tag |
+ +========+===============================================+
+ | D | draft |
+ +--------+-----------------------------------------------+
+ | F | flagged |
+ +--------+-----------------------------------------------+
+ | P | passed |
+ +--------+-----------------------------------------------+
+ | R | replied |
+ +--------+-----------------------------------------------+
+ | S | unread (added when 'S' flag is not present) |
+ +--------+-----------------------------------------------+
+
+ The :any:`notmuch-new(1)` command will notice flag changes in
+ filenames and update tags, while the :any:`notmuch-tag(1)` and
+ :any:`notmuch-restore(1)` commands will notice tag changes and
+ update flags in filenames.
+
+ If there have been any changes in the maildir (new messages added,
+ old ones removed or renamed, maildir flags changed, etc.), it is
+ advisable to run :any:`notmuch-new(1)` before
+ :any:`notmuch-tag(1)` or :any:`notmuch-restore(1)` commands to
+ ensure the tag changes are properly synchronized to the maildir
+ flags, as the commands expect the database and maildir to be in
+ sync.
+
+ Default: ``true``.
+
+.. 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:
+
+ A file or a directory name, without path, that will be ignored,
+ regardless of the location in the mail store directory hierarchy.
+
+ Or:
+
+ A regular expression delimited with // that will be matched
+ against the path of the file or directory relative to the database
+ path. Matching files and directories will be ignored. The
+ beginning and end of string must be explicitly anchored. For
+ example, /.*/foo$/ would match "bar/foo" and "bar/baz/foo", but
+ not "foo" or "bar/foobar".
+
+ Default: empty list.
+
+.. nmconfig:: new.tags
+
+ A list of tags that will be added to all messages incorporated by
+ **notmuch new**.
+
+ Default: ``unread;inbox``.
+
+.. nmconfig:: query.<name>
-**query.<name>**
Expansion for named query called <name>. See
:any:`notmuch-search-terms(7)` for more information about named
queries.
-**squery.<name>**
+.. 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.
+
+.. nmconfig:: show.extra_headers
+
+ By default :any:`notmuch-show(1)` includes the following headers
+ in structured output if they are present in the message:
+ `Subject`, `From`, `To`, `Cc`, `Bcc`, `Reply-To`, `Date`. This
+ option allows the specification of a list of further
+ headers to output.
+
+ History: This configuration value was introduced in notmuch 0.35.
+
+ Default: empty list.
+
+.. 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.
+.. nmconfig:: user.name
+
+ Your full name.
+
+ Default: ``$NAME`` variable if set, otherwise read from
+ ``/etc/passwd``.
+
+.. nmconfig:: user.other_email
+
+ A list of other email addresses at which you receive email
+ (see also, :nmconfig:`user.primary_email`)
+
+ Default: not set.
+
+.. nmconfig:: user.primary_email
+
+ Your primary email address.
+
+ Default: ``$EMAIL`` variable if set, otherwise constructed from
+ the username and hostname of the current machine.
+
FILES
=====
+.. _config_search:
+
CONFIGURATION
-------------
projects / notmuch / blobdiff