X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-config.rst;fp=doc%2Fman1%2Fnotmuch-config.rst;h=129d4b81026191fe69651064333ff780e5709008;hp=5c980a8a4bb80d57cff031594fc0ef6db8708c5b;hb=574b2436eeabf60c930ba227931ee87b0b151a65;hpb=ff4e81ac57dee5a62f35093c2966f931a7b7580c diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst index 5c980a8a..129d4b81 100644 --- a/doc/man1/notmuch-config.rst +++ b/doc/man1/notmuch-config.rst @@ -235,39 +235,39 @@ paths are presumed relative to `$HOME` for items in section :any:`notmuch-search-terms(7)` for more information about named 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 ------------- -If ``NOTMUCH_CONFIG`` is unset, notmuch tries (in order) +Notmuch configuration file search order: -- ``$XDG_CONFIG_HOME/notmuch//config`` where ```` is - defined by ``$NOTMUCH_PROFILE`` or "default" -- ``${HOME}/.notmuch-config`` where ```` 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//config`` where ```` + is defined by :envvar:`NOTMUCH_PROFILE` environment variable if + set, ``$XDG_CONFIG_HOME/notmuch/default/config`` otherwise. + +4. ``$HOME/.notmuch-config.`` where ```` is defined + by :envvar:`NOTMUCH_PROFILE` environment variable if set, + ``$HOME/.notmuch-config`` otherwise. 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//hooks`` where ```` + is defined by :envvar:`NOTMUCH_PROFILE` environment variable if + set, ``$XDG_CONFIG_HOME/notmuch/default/hooks`` otherwise. -- ``$XDG_CONFIG_HOME/notmuch//hooks`` where ```` is - defined by ``$NOTMUCH_PROFILE`` or "default" -- ``/.notmuch/hooks`` +3. ``/.notmuch/hooks`` SEE ALSO ========