aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2022-05-31 08:51:00 -0300
committerDavid Bremner <david@tethera.net>2022-06-13 07:28:35 -0300
commita5504e8b1cfd8dddfe395ba4a46da3ea6008e714 (patch)
tree0ac5fceaff50d4f9886ae1653b10cffb4b8358e0
parent5cbddf7e7a96a801e5ad3482b2636aff375a0821 (diff)
CLI: document handling of --config for external commands
Create a section of the notmuch(1) manpage to have some place to put this documentation.
-rw-r--r--doc/man1/notmuch.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst
index c6ee3036..e0892e01 100644
--- a/doc/man1/notmuch.rst
+++ b/doc/man1/notmuch.rst
@@ -185,6 +185,14 @@ of notmuch.
If set to a non-empty value, the notmuch library will print (to
stderr) Xapian queries it constructs.
+EXTERNAL COMMANDS
+=================
+
+When given a subcommand `foo` not recognized as built-in, notmuch will
+try to run the command (e.g. script) `notmuch-foo` in the user's
+path. The :envvar:`NOTMUCH_CONFIG` will be set according to
+:option:`--config`, if the latter is present.
+
SEE ALSO
========