X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-config.rst;h=323a8b6586ab4777553e043327b72f2b19d7eaeb;hp=8ddfc1d6d285e50ece420b1b840532e2b3954a01;hb=HEAD;hpb=69289c5d62caa114a28532d00b8f11b564b43fd4 diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst index 8ddfc1d6..bd34afa4 100644 --- a/doc/man1/notmuch-config.rst +++ b/doc/man1/notmuch-config.rst @@ -55,13 +55,14 @@ The available configuration items are described below. Non-absolute paths are presumed relative to `$HOME` for items in section **database**. -built_with. +.. nmconfig:: built_with. + Compile time feature . 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 @@ -69,7 +70,8 @@ database.autocommit 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. @@ -77,7 +79,8 @@ database.backup_dir 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)`. @@ -85,7 +88,8 @@ database.hook_dir 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. @@ -93,16 +97,43 @@ database.mail_root 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``. @@ -155,7 +186,10 @@ index.decrypt Default: ``auto``. -index.header. +.. _index.header: + +.. nmconfig:: index.header. + Define the query 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 @@ -164,7 +198,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 +.. nmconfig:: maildir.synchronize_flags + If true, then the following maildir flags (in message filenames) will be synchronized with the corresponding notmuch tags: @@ -197,7 +232,8 @@ maildir.synchronize\_flags 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: @@ -215,18 +251,21 @@ new.ignore 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. +.. nmconfig:: query. + Expansion for named query called . 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. @@ -234,9 +273,7 @@ search.exclude\_tags 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: @@ -248,26 +285,28 @@ show.extra\_headers Default: empty list. -squery. +.. nmconfig:: squery. + Expansion for named query called , 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 `). + (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