[PATCH 3/3] CLI: document handling of --config for external commands

Subject: [PATCH 3/3] CLI: document handling of --config for external commands

Date: Tue, 31 May 2022 08:51:00 -0300

To: notmuch@notmuchmail.org

Cc:

From: David Bremner

Create a section of the notmuch(1) manpage to have some place to put
this documentation.
---
 doc/man1/notmuch.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

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

_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: