[PATCH 1/3] man: document external subcommand handling in notmuch(1)

Subject: [PATCH 1/3] man: document external subcommand handling in notmuch(1)

Date: Mon, 6 Mar 2017 21:26:59 +0200

To: notmuch@notmuchmail.org

Cc:

From: Jani Nikula

The documentation for this was overlooked when adding the subcommand
handling. This seems like the proper place for it.
---
 doc/man1/notmuch.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst
index 7429f517626d..fbd7f3816757 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
 ===========
 
-- 
2.11.0

Thread: