doc: tweak hook configuration documentation.

[notmuch] / doc / man1 / notmuch-config.rst

diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst
index 769f336a33afac4dfeb54ec259940257777e7f71..209226a3d9954580f44300ce8f8fdfa80c7eba56 100644 (file)
--- a/doc/man1/notmuch-config.rst
+++ b/doc/man1/notmuch-config.rst
@@ -7,7 +7,7 @@ SYNOPSIS
 
 **notmuch** **config** **get** <*section*>.<*item*>
 
 
 **notmuch** **config** **get** <*section*>.<*item*>
 

-**notmuch** **config** **set** <*section*>.<*item*> [*value* ...]
+**notmuch** **config** **set** [--database] <*section*>.<*item*> [*value* ...]

 
 **notmuch** **config** **list**
 
 
 **notmuch** **config** **list**
 


@@ -17,10 +17,6 @@ DESCRIPTION
 The **config** command can be used to get or set settings in the notmuch
 configuration file and corresponding database.
 
 The **config** command can be used to get or set settings in the notmuch
 configuration file and corresponding database.
 

-Items marked **[STORED IN DATABASE]** are only in the database.  They
-should not be placed in the configuration file, and should be accessed
-programmatically as described in the SYNOPSIS above.
-

 **get**
     The value of the specified configuration item is printed to
     stdout. If the item has multiple values (it is a list), each value
 **get**
     The value of the specified configuration item is printed to
     stdout. If the item has multiple values (it is a list), each value


@@ -34,6 +30,10 @@ programmatically as described in the SYNOPSIS above.
     If no values are provided, the specified configuration item will
     be removed from the configuration file.
 
     If no values are provided, the specified configuration item will
     be removed from the configuration file.
 

+    With the `--database` option, updates configuration metadata
+    stored in the database, rather than the default (text)
+    configuration file.
+

 **list**
     Every configuration item is printed to stdout, each on a separate
     line of the form::
 **list**
     Every configuration item is printed to stdout, each on a separate
     line of the form::


@@ -44,15 +44,42 @@ programmatically as described in the SYNOPSIS above.
     characters. In a multiple-value item (a list), the values are
     separated by semicolon characters.
 
     characters. In a multiple-value item (a list), the values are
     separated by semicolon characters.
 

-The available configuration items are described below.
+The available configuration items are described below. Non-absolute
+paths are presumed relative to `$HOME` for items in section
+**database**.

 
 **database.path**
 
 **database.path**

+    Notmuch will store its database here, (in
+    sub-directory named ``.notmuch`` if **database.mail\_root**
+    is unset).
+
+    Default: ``$MAILDIR`` variable if set, otherwise ``$HOME/mail``.
+
+**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
     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. Notmuch will store its database within
-    a sub-directory of the path configured here named ``.notmuch``.
+    individual email messages.

 
 

-    Default: ``$MAILDIR`` variable if set, otherwise ``$HOME/mail``.
+    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.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**
+    Directory containing hooks run by notmuch commands. See
+    **notmuch-hooks(5)**.
+
+    History: this configuration value was introduced in notmuch 0.32.
+
+    Default: See HOOKS, below.

 
 **user.name**
     Your full name.
 
 **user.name**
     Your full name.


@@ -134,7 +161,7 @@ The available configuration items are described below.
 
     Default: ``true``.
 
 
     Default: ``true``.
 

-**index.decrypt** **[STORED IN DATABASE]**
+**index.decrypt**

     Policy for decrypting encrypted messages during indexing.  Must be
     one of: ``false``, ``auto``, ``nostash``, or ``true``.
 
     Policy for decrypting encrypted messages during indexing.  Must be
     one of: ``false``, ``auto``, ``nostash``, or ``true``.
 


@@ -187,7 +214,7 @@ The available configuration items are described below.
 
     Default: ``auto``.
 
 
     Default: ``auto``.
 

-**index.header.<prefix>** **[STORED IN DATABASE]**
+**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
     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


@@ -202,7 +229,7 @@ The available configuration items are described below.
     (since notmuch 0.30, "compact" and "field_processor" are
     always included.)
 
     (since notmuch 0.30, "compact" and "field_processor" are
     always included.)
 

-**query.<name>** **[STORED IN DATABASE]**
+**query.<name>**

     Expansion for named query called <name>. See
     **notmuch-search-terms(7)** for more information about named
     queries.
     Expansion for named query called <name>. See
     **notmuch-search-terms(7)** for more information about named
     queries.


@@ -214,8 +241,32 @@ The following environment variables can be used to control the behavior
 of notmuch.
 
 **NOTMUCH\_CONFIG**
 of notmuch.
 
 **NOTMUCH\_CONFIG**

-    Specifies the location of the notmuch configuration file. Notmuch
-    will use ${HOME}/.notmuch-config if this variable is not set.
+    Specifies the location of the notmuch configuration file.
+
+**NOTMUCH_PROFILE**
+    Selects among notmuch configurations.
+
+FILES
+=====
+
+CONFIGURATION
+-------------
+
+If ``NOTMUCH_CONFIG`` is unset, notmuch tries (in order)
+
+- ``$XDG_CONFIG_HOME/notmuch/<profile>/config`` where ``<profile>`` is
+  defined by ``$NOTMUCH_PROFILE`` or "default"
+- ``${HOME}/.notmuch-config<profile>`` where ``<profile>`` is
+  ``.$NOTMUCH_PROFILE`` or ""
+
+HOOKS
+-----
+
+If ``database.hook_dir`` is unset, notmuch tries (in order)
+
+- ``$XDG_CONFIG_HOME/notmuch/<profile>/hooks`` where ``<profile>`` is
+  defined by ``$NOTMUCH_PROFILE`` or "default"
+- ``<database.path>/.notmuch/hooks``

 
 SEE ALSO
 ========
 
 SEE ALSO
 ========