debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-21 18:38:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: document database search algorithm.

Browse source 
Essentially a translation of the function _choose_database_path for
human consumption. As a bonus, document environment variable
NOTMUCH_DATABASE
This commit is contained in:
David Bremner 2021-08-04 07:42:36 -03:00
parent 3df2281746
commit be6edee496
2 changed files with 25 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
doc/man1/notmuch-config.rst
View file

@ -60,7 +60,7 @@ paths are presumed relative to `$HOME` for items in section
sub-directory named ``.notmuch`` if **database.mail\_root** sub-directory named ``.notmuch`` if **database.mail\_root**
is unset). is unset).
Default: ``$MAILDIR`` variable if set, otherwise ``$HOME/mail``. Default: see :ref:`database`
**database.mail_root** **database.mail_root**
The top-level directory where your mail currently exists and to 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, by :envvar:`NOTMUCH_PROFILE` environment variable if set,
``$HOME/.notmuch-config`` otherwise. ``$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 HOOKS
----- -----

5
doc/man1/notmuch.rst
View file

@ -164,6 +164,11 @@ of notmuch.
Specifies the location of the notmuch configuration file. See Specifies the location of the notmuch configuration file. See
:any:`notmuch-config(1)` for details. :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 .. envvar:: NOTMUCH_PROFILE
Selects among notmuch configurations. See :any:`notmuch-config(1)` Selects among notmuch configurations. See :any:`notmuch-config(1)`