man: document external subcommand handling in notmuch(1)
authorJani Nikula <jani@nikula.org>
Mon, 6 Mar 2017 19:26:59 +0000 (21:26 +0200)
committerDavid Bremner <david@tethera.net>
Tue, 7 Mar 2017 13:05:50 +0000 (09:05 -0400)
The documentation for this was overlooked when adding the subcommand
handling. This seems like the proper place for it.

doc/man1/notmuch.rst

index 7429f517626db277bce71af1f32cc2d14d6b04b1..fbd7f381675748cfca83d5818a50669323485117 100644 (file)
@@ -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
 ===========