From 574b2436eeabf60c930ba227931ee87b0b151a65 Mon Sep 17 00:00:00 2001 From: Jani Nikula Date: Fri, 21 May 2021 23:44:11 +0300 Subject: [PATCH] doc: use envvar directive and role for environment variables Make man1/notmuch.rst the single point of truth for describing notmuch environment variables. Use the envvar directive for that, and reference them with the envvar role. Drive-by cleanup configuration file and hook directory search order documentation. --- doc/man1/notmuch-compact.rst | 10 -------- doc/man1/notmuch-config.rst | 42 +++++++++++++++++----------------- doc/man1/notmuch-emacs-mua.rst | 10 ++++---- doc/man1/notmuch.rst | 36 +++++++++++++++++------------ 4 files changed, 49 insertions(+), 49 deletions(-) diff --git a/doc/man1/notmuch-compact.rst b/doc/man1/notmuch-compact.rst index 85f611bf..3e3e70c5 100644 --- a/doc/man1/notmuch-compact.rst +++ b/doc/man1/notmuch-compact.rst @@ -35,16 +35,6 @@ Supported options for **compact** include ``--quiet`` Do not report database compaction progress to stdout. -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 - will use ${HOME}/.notmuch-config if this variable is not set. - SEE ALSO ======== 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 ======== diff --git a/doc/man1/notmuch-emacs-mua.rst b/doc/man1/notmuch-emacs-mua.rst index a599b6eb..c0d5b1a7 100644 --- a/doc/man1/notmuch-emacs-mua.rst +++ b/doc/man1/notmuch-emacs-mua.rst @@ -72,11 +72,13 @@ Options may be specified multiple times. ENVIRONMENT VARIABLES ===================== -**EMACS** - Name of emacs command to invoke. Defaults to "emacs". +.. envvar:: EMACS -**EMACSCLIENT** - Name of emacsclient command to invoke. Defaults to "emacsclient". + Name of emacs command to invoke. Defaults to "emacs". + +.. envvar:: EMACSCLIENT + + Name of emacsclient command to invoke. Defaults to "emacsclient". SEE ALSO ======== diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst index 7b84ef44..93135bdd 100644 --- a/doc/man1/notmuch.rst +++ b/doc/man1/notmuch.rst @@ -52,7 +52,7 @@ Supported global options for ``notmuch`` include ``--config=FILE`` Specify the configuration file to use. This overrides any - configuration file specified by ${NOTMUCH\_CONFIG}. The empty + configuration file specified by :envvar:`NOTMUCH_CONFIG`. The empty string is a permitted and sometimes useful value of *FILE*, which tells ``notmuch`` to use only configuration metadata from the database. @@ -79,7 +79,7 @@ use, (or to reconfigure it later). The setup command will prompt for your full name, your primary email address, any alternate email addresses you use, and the directory containing your email archives. Your answers will be written to a -configuration file in ${NOTMUCH\_CONFIG} (if set) or +configuration file in :envvar:`NOTMUCH_CONFIG` (if set) or ${HOME}/.notmuch-config . This configuration file will be created with descriptive comments, making it easy to edit by hand later to change the configuration. Or you can run **notmuch setup** again to change the @@ -128,8 +128,8 @@ CUSTOM COMMANDS --------------- If the given command is not known to notmuch, notmuch tries to execute -the external **notmuch-** in ${PATH} instead. This allows -users to have their own notmuch related tools to be run via the +the external **notmuch-** in :envvar:`PATH` instead. This +allows users to have their own notmuch related tools to be run via the notmuch command. By design, this does not allow notmuch's own commands to be overridden using external commands. @@ -153,18 +153,26 @@ 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 - will use ${HOME}/.notmuch-config if this variable is not set. +.. envvar:: NOTMUCH_CONFIG -**NOTMUCH\_TALLOC\_REPORT** - Location to write a talloc memory usage report. See - **talloc\_enable\_leak\_report\_full** in :manpage:`talloc(3)` for more - information. + Specifies the location of the notmuch configuration file. See + :any:`notmuch-config(1)` for details. -**NOTMUCH\_DEBUG\_QUERY** - If set to a non-empty value, the notmuch library will print (to - stderr) Xapian queries it constructs. +.. envvar:: NOTMUCH_PROFILE + + Selects among notmuch configurations. See :any:`notmuch-config(1)` + for details. + +.. envvar:: NOTMUCH_TALLOC_REPORT + + Location to write a talloc memory usage report. See + **talloc\_enable\_leak\_report\_full** in :manpage:`talloc(3)` for more + information. + +.. envvar:: NOTMUCH_DEBUG_QUERY + + If set to a non-empty value, the notmuch library will print (to + stderr) Xapian queries it constructs. SEE ALSO ======== -- 2.43.0