unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: Jani Nikula <jani@nikula.org>
To: notmuch@notmuchmail.org
Subject: [PATCH 1/3] man: document external subcommand handling in notmuch(1)
Date: Mon,  6 Mar 2017 21:26:59 +0200	[thread overview]
Message-ID: <20170306192701.14465-1-jani@nikula.org> (raw)

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

             reply	other threads:[~2017-03-06 19:27 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-03-06 19:26 Jani Nikula [this message]
2017-03-06 19:27 ` [PATCH 2/3] NEWS: external subcommand handling Jani Nikula
2017-03-06 19:27 ` [PATCH 3/3] NEWS: notmuch-emacs-mua and desktop integration Jani Nikula
2017-03-07 13:28 ` [PATCH 1/3] man: document external subcommand handling in notmuch(1) David Bremner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170306192701.14465-1-jani@nikula.org \
    --to=jani@nikula.org \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).