From: Jani Nikula <jani@nikula.org>
Date: Mon, 6 Mar 2017 19:26:59 +0000 (+0200)
Subject: man: document external subcommand handling in notmuch(1)
X-Git-Tag: 0.24_rc1~5
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=02421015fd7f9e31f17c5c8e211df33254546789

man: document external subcommand handling in notmuch(1)

The documentation for this was overlooked when adding the subcommand
handling. This seems like the proper place for it.
---

diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst
index 7429f517..fbd7f381 100644
--- a/doc/man1/notmuch.rst
+++ b/doc/man1/notmuch.rst
@@ -116,6 +116,15 @@ dump of email tags for backup purposes, and to restore from that dump.
 The **config** command can be used to get or set settings in the notmuch
 configuration file.
 
+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
+notmuch command. By design, this does not allow notmuch's own commands
+to be overriden using external commands.
+
 ENVIRONMENT
 ===========