Merge remote-tracking branch 'origin/debian/bullseye' into release

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

diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst
index bc597957f7bb93d5f2521303470fccc8b84a90df..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**
 


@@ -30,6 +30,10 @@ configuration file and corresponding database.
     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::


@@ -40,21 +44,43 @@ configuration file and corresponding database.
     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.

 
 

-**database.hook_dir**
+    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)**.
 
     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.
 


@@ -233,7 +259,7 @@ If ``NOTMUCH_CONFIG`` is unset, notmuch tries (in order)
 - ``${HOME}/.notmuch-config<profile>`` where ``<profile>`` is
   ``.$NOTMUCH_PROFILE`` or ""
 
 - ``${HOME}/.notmuch-config<profile>`` where ``<profile>`` is
   ``.$NOTMUCH_PROFILE`` or ""
 

-Hooks
+HOOKS

 -----
 
 If ``database.hook_dir`` is unset, notmuch tries (in order)
 -----
 
 If ``database.hook_dir`` is unset, notmuch tries (in order)