]> git.notmuchmail.org Git - notmuch/commitdiff
CLI: document handling of --config for external commands
authorDavid Bremner <david@tethera.net>
Tue, 31 May 2022 11:51:00 +0000 (08:51 -0300)
committerDavid Bremner <david@tethera.net>
Mon, 13 Jun 2022 10:28:35 +0000 (07:28 -0300)
Create a section of the notmuch(1) manpage to have some place to put
this documentation.

doc/man1/notmuch.rst

index c6ee30366264016846701ee4b3c4a9d4df343877..e0892e01667be75a8ae66ab3a89ad737ad9f12e8 100644 (file)
@@ -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
 ========