doc: use envvar directive and role for environment variables

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

diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst
index bc597957f7bb93d5f2521303470fccc8b84a90df..129d4b81026191fe69651064333ff780e5709008 100644 (file)
--- a/doc/man1/notmuch-config.rst
+++ b/doc/man1/notmuch-config.rst
@@ -1,3 +1,5 @@
+.. _notmuch-config(1):
+

 ==============
 notmuch-config
 ==============
 ==============
 notmuch-config
 ==============


@@ -7,7 +9,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 +32,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,20 +46,39 @@ 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.
+
+    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
 
 **database.hook_dir**
 
     Directory containing hooks run by notmuch commands. See

-    **notmuch-hooks(5)**.
+    :any:`notmuch-hooks(5)`.

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


@@ -80,7 +105,7 @@ The available configuration items are described below.
 
 **new.ignore**
     A list to specify files and directories that will not be searched
 
 **new.ignore**
     A list to specify files and directories that will not be searched

-    for messages by **notmuch new**. Each entry in the list is either:
+    for messages by :any:`notmuch-new(1)`. Each entry in the list is either:

 
     A file or a directory name, without path, that will be ignored,
     regardless of the location in the mail store directory hierarchy.
 
     A file or a directory name, without path, that will be ignored,
     regardless of the location in the mail store directory hierarchy.


@@ -101,7 +126,7 @@ The available configuration items are described below.
     default. Using an excluded tag in a query will override that
     exclusion.
 
     default. Using an excluded tag in a query will override that
     exclusion.
 

-    Default: empty list. Note that **notmuch-setup(1)** puts
+    Default: empty list. Note that :any:`notmuch-setup(1)` puts

     ``deleted;spam`` here when creating new configuration file.
 
 **maildir.synchronize\_flags**
     ``deleted;spam`` here when creating new configuration file.
 
 **maildir.synchronize\_flags**


@@ -122,16 +147,18 @@ The available configuration items are described below.
     | S      | unread (added when 'S' flag is not present)   |
     +--------+-----------------------------------------------+
 
     | S      | unread (added when 'S' flag is not present)   |
     +--------+-----------------------------------------------+
 

-    The **notmuch new** command will notice flag changes in filenames
-    and update tags, while the **notmuch tag** and **notmuch restore**
-    commands will notice tag changes and update flags in filenames.
+    The :any:`notmuch-new(1)` command will notice flag changes in
+    filenames and update tags, while the :any:`notmuch-tag(1)` and
+    :any:`notmuch-restore(1)` commands will notice tag changes and
+    update flags in filenames.

 
     If there have been any changes in the maildir (new messages added,
     old ones removed or renamed, maildir flags changed, etc.), it is
 
     If there have been any changes in the maildir (new messages added,
     old ones removed or renamed, maildir flags changed, etc.), it is

-    advisable to run **notmuch new** before **notmuch tag** or
-    **notmuch restore** commands to ensure the tag changes are
-    properly synchronized to the maildir flags, as the commands expect
-    the database and maildir to be in sync.
+    advisable to run :any:`notmuch-new(1)` before
+    :any:`notmuch-tag(1)` or :any:`notmuch-restore(1)` commands to
+    ensure the tag changes are properly synchronized to the maildir
+    flags, as the commands expect the database and maildir to be in
+    sync.

 
     Default: ``true``.
 
 
     Default: ``true``.
 


@@ -151,8 +178,8 @@ The available configuration items are described below.
     ``nostash`` is the same as ``true`` except that it will not stash
     newly-discovered session keys in the database.
 
     ``nostash`` is the same as ``true`` except that it will not stash
     newly-discovered session keys in the database.
 

-    From the command line (i.e. during **notmuch-new(1)**,
-    **notmuch-insert(1)**, or **notmuch-reindex(1)**), the user can
+    From the command line (i.e. during :any:`notmuch-new(1)`,
+    :any:`notmuch-insert(1)`, or :any:`notmuch-reindex(1)`), the user can

     override the database's stored decryption policy with the
     ``--decrypt=`` option.
 
     override the database's stored decryption policy with the
     ``--decrypt=`` option.
 


@@ -176,7 +203,7 @@ The available configuration items are described below.
 
     Stashed session keys are kept in the database as properties
     associated with the message.  See ``session-key`` in
 
     Stashed session keys are kept in the database as properties
     associated with the message.  See ``session-key`` in

-    **notmuch-properties(7)** for more details about how they can be
+    :any:`notmuch-properties(7)` for more details about how they can be

     useful.
 
     Be aware that the notmuch index is likely sufficient (and a
     useful.
 
     Be aware that the notmuch index is likely sufficient (and a


@@ -194,7 +221,7 @@ The available configuration items are described below.
     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
     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
+    supported. See :any:`notmuch-search-terms(7)` for a list of existing

     prefixes, and an explanation of probabilistic prefixes.
 
 **built_with.<name>**
     prefixes, and an explanation of probabilistic prefixes.
 
 **built_with.<name>**


@@ -205,56 +232,56 @@ The available configuration items are described below.
 
 **query.<name>**
     Expansion for named query called <name>. See
 
 **query.<name>**
     Expansion for named query called <name>. See

-    **notmuch-search-terms(7)** for more information about named
+    :any:`notmuch-search-terms(7)` for more information about named

     queries.
 
     queries.
 

-ENVIRONMENT
-===========
-
-The following environment variables can be used to control the behavior
-of notmuch.
-
-**NOTMUCH\_CONFIG**
-    Specifies the location of the notmuch configuration file.
-
-**NOTMUCH_PROFILE**
-    Selects among notmuch configurations.
-

 FILES
 =====
 
 CONFIGURATION
 -------------
 
 FILES
 =====
 
 CONFIGURATION
 -------------
 

-If ``NOTMUCH_CONFIG`` is unset, notmuch tries (in order)
+Notmuch configuration file search 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 ""
+1. File specified by ``--config=FILE`` global option; see
+   :any:`notmuch(1)`.
+
+2. File specified by :envvar:`NOTMUCH_CONFIG` environment variable.
+
+3. ``$XDG_CONFIG_HOME/notmuch/<profile>/config`` where ``<profile>``
+   is defined by :envvar:`NOTMUCH_PROFILE` environment variable if
+   set, ``$XDG_CONFIG_HOME/notmuch/default/config`` otherwise.
+
+4. ``$HOME/.notmuch-config.<profile>`` where ``<profile>`` is defined
+   by :envvar:`NOTMUCH_PROFILE` environment variable if set,
+   ``$HOME/.notmuch-config`` otherwise.

 
 Hooks
 -----
 
 
 Hooks
 -----
 

-If ``database.hook_dir`` is unset, notmuch tries (in order)
+Notmuch hook directory search order:
+
+1. Directory specified by ``database.hook_dir`` configuration option.
+
+2. ``$XDG_CONFIG_HOME/notmuch/<profile>/hooks`` where ``<profile>``
+   is defined by :envvar:`NOTMUCH_PROFILE` environment variable if
+   set, ``$XDG_CONFIG_HOME/notmuch/default/hooks`` otherwise.

 
 

-- ``$XDG_CONFIG_HOME/notmuch/<profile>/hooks`` where ``<profile>`` is
-  defined by ``$NOTMUCH_PROFILE`` or "default"
-- ``<database.path>/.notmuch/hooks``
+3. ``<database.path>/.notmuch/hooks``

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

-**notmuch(1)**,
-**notmuch-count(1)**,
-**notmuch-dump(1)**,
-**notmuch-hooks(5)**,
-**notmuch-insert(1)**,
-**notmuch-new(1)**,
-**notmuch-reply(1)**,
-**notmuch-restore(1)**,
-**notmuch-search(1)**,
-**notmuch-search-terms(7)**,
-**notmuch-properties(7)**,
-**notmuch-show(1)**,
-**notmuch-tag(1)**
+:any:`notmuch(1)`,
+:any:`notmuch-count(1)`,
+:any:`notmuch-dump(1)`,
+:any:`notmuch-hooks(5)`,
+:any:`notmuch-insert(1)`,
+:any:`notmuch-new(1)`,
+:any:`notmuch-properties(7)`,
+:any:`notmuch-reply(1)`,
+:any:`notmuch-restore(1)`,
+:any:`notmuch-search(1)`,
+:any:`notmuch-search-terms(7)`,
+:any:`notmuch-show(1)`,
+:any:`notmuch-tag(1)`