From: David Bremner <david@tethera.net>
Date: Tue, 31 May 2022 11:51:00 +0000 (-0300)
Subject: CLI: document handling of --config for external commands
X-Git-Tag: 0.37_rc0~102
X-Git-Url: https://git.cworth.org/git?p=notmuch;a=commitdiff_plain;h=a5504e8b1cfd8dddfe395ba4a46da3ea6008e714

CLI: document handling of --config for external commands

Create a section of the notmuch(1) manpage to have some place to put
this documentation.
---

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