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: use envvar directive and role for environment variables

Browse source 
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.
This commit is contained in:
Jani Nikula 2021-05-21 23:44:11 +03:00 committed by David Bremner
parent ff4e81ac57
commit 574b2436ee
4 changed files with 49 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/man1/notmuch-compact.rst
View file

@ -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
========

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

@ -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/<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
-----
If ``database.hook_dir`` is unset, notmuch tries (in order)
Notmuch hook directory search order:
- ``$XDG_CONFIG_HOME/notmuch/<profile>/hooks`` where ``<profile>`` is
defined by ``$NOTMUCH_PROFILE`` or "default"
- ``<database.path>/.notmuch/hooks``
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.
3. ``<database.path>/.notmuch/hooks``
SEE ALSO
========

10
doc/man1/notmuch-emacs-mua.rst
View file

@ -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
========

36
doc/man1/notmuch.rst
View file

@ -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-<subcommand>** in ${PATH} instead. This allows
users to have their own notmuch related tools to be run via the
the external **notmuch-<subcommand>** 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
========