doc: document (tersely) the intended behaviour of relative paths.

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

diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst
index 899098084ae2beafea74017b3064de261c0a8917..b158dac3c85884dd5cbdc310edac449e72654bc0 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,25 +30,45 @@ 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::
 

-        *section*.\ *item*\ =\ *value*
+        section.item=value

 
     No additional whitespace surrounds the dot or equals sign
     characters. In a multiple-value item (a list), the values are
     separated by semicolon characters.
 
 
     No additional whitespace surrounds the dot or equals sign
     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.hook_dir**
+
+    Directory containing hooks run by notmuch commands. See
+    **notmuch-hooks(5)**.

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


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

-**crypto.gpg_path**
-    Name (or full path) of gpg binary to use in verification and
-    decryption of PGP/MIME messages.  NOTE: This configuration item is
-    deprecated, and will be ignored if notmuch is built against GMime
-    3.0 or later.
-
-    Default: ``gpg``.
-
-**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``.
 


@@ -195,12 +203,22 @@ The available configuration items are described below.
 
     Default: ``auto``.
 
 
     Default: ``auto``.
 

+**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
+    defined prefixes must not start with 'a'...'z'; in particular
+    adding a prefix with same name as a predefined prefix is not
+    supported. See **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
 **built_with.<name>**
     Compile time feature <name>. Current possibilities include

-    "compact" (see **notmuch-compact(1)**) and "field_processor" (see
-    **notmuch-search-terms(7)**).
+    "retry_lock" (configure option, included by default).
+    (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.


@@ -212,8 +230,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
 ========