]> git.cworth.org Git - notmuch/blobdiff - doc/man1/notmuch-config.rst
doc: tweak hook configuration documentation.
[notmuch] / doc / man1 / notmuch-config.rst
index 32290a38a3e60605230e24e0dbab651b97effc5d..209226a3d9954580f44300ce8f8fdfa80c7eba56 100644 (file)
@@ -44,7 +44,9 @@ configuration file and corresponding database.
     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**
     Notmuch will store its database here, (in
@@ -63,11 +65,22 @@ The available configuration items are described below.
     Default: For compatibility with older configurations, the value of
     database.path is used if **database.mail\_root** is unset.
 
-**database.hook_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**
     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.
 
@@ -246,7 +259,7 @@ If ``NOTMUCH_CONFIG`` is unset, notmuch tries (in order)
 - ``${HOME}/.notmuch-config<profile>`` where ``<profile>`` is
   ``.$NOTMUCH_PROFILE`` or ""
 
-Hooks
+HOOKS
 -----
 
 If ``database.hook_dir`` is unset, notmuch tries (in order)