diff options
| author | David Bremner <david@tethera.net> | 2021-08-04 07:42:36 -0300 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2021-08-21 07:54:44 -0700 |
| commit | be6edee49660308131cbc7a6eb51e38c642cc098 (patch) | |
| tree | b4d9d6a6c29df6b8472eff9705c6f115b2ca1a78 /doc | |
| parent | 3df2281746d57abbb45790ecb432ef40533c30bc (diff) | |
doc: document database search algorithm.
Essentially a translation of the function _choose_database_path for
human consumption. As a bonus, document environment variable
NOTMUCH_DATABASE
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man1/notmuch-config.rst | 21 | ||||
| -rw-r--r-- | doc/man1/notmuch.rst | 5 |
2 files changed, 25 insertions, 1 deletions
diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst index 82fbb44c..07a9eaf0 100644 --- a/doc/man1/notmuch-config.rst +++ b/doc/man1/notmuch-config.rst @@ -60,7 +60,7 @@ paths are presumed relative to `$HOME` for items in section sub-directory named ``.notmuch`` if **database.mail\_root** is unset). - Default: ``$MAILDIR`` variable if set, otherwise ``$HOME/mail``. + Default: see :ref:`database` **database.mail_root** The top-level directory where your mail currently exists and to @@ -272,6 +272,25 @@ Notmuch configuration file search order: by :envvar:`NOTMUCH_PROFILE` environment variable if set, ``$HOME/.notmuch-config`` otherwise. +.. _database: + +DATABASE LOCATION +----------------- + +Notmuch database search order: + +1. Directory specified by :envvar:`NOTMUCH_DATABASE` environment variable. + +2. Directory specified by config key ``database.path``. + +3. ``$XDG_DATA_HOME/notmuch/<profile>`` where ``<profile>`` + is defined by :envvar:`NOTMUCH_PROFILE` environment variable if + set, ``$XDG_DATA_HOME/notmuch/default`` otherwise. + +4. Directory specified by :envvar:`MAILDIR` environment variable. + +5. ``$HOME/mail`` + HOOKS ----- diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst index 6bd1dc03..c6ee3036 100644 --- a/doc/man1/notmuch.rst +++ b/doc/man1/notmuch.rst @@ -164,6 +164,11 @@ of notmuch. Specifies the location of the notmuch configuration file. See :any:`notmuch-config(1)` for details. +.. envvar:: NOTMUCH_DATABASE + + Specifies the location of the notmuch database. See + :any:`notmuch-config(1)` for details. + .. envvar:: NOTMUCH_PROFILE Selects among notmuch configurations. See :any:`notmuch-config(1)` |