unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Subject: [PATCH 3/3] CLI: document handling of --config for external commands
Date: Tue, 31 May 2022 08:51:00 -0300	[thread overview]
Message-ID: <20220531115100.2446050-3-david@tethera.net> (raw)
In-Reply-To: <20220531115100.2446050-1-david@tethera.net>

Create a section of the notmuch(1) manpage to have some place to put
this documentation.
---
 doc/man1/notmuch.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst
index c6ee3036..e0892e01 100644
--- a/doc/man1/notmuch.rst
+++ b/doc/man1/notmuch.rst
@@ -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
 ========
 
-- 
2.35.2

  parent reply	other threads:[~2022-05-31 11:51 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-05-31 11:50 [PATCH 1/3] test: initial tests for external commands David Bremner
2022-05-31 11:50 ` [PATCH 2/3] CLI: pass --config to external commands via NOTMUCH_CONFIG David Bremner
2022-05-31 11:51 ` David Bremner [this message]
2022-06-13 10:35 ` [PATCH 1/3] test: initial tests for external commands 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=20220531115100.2446050-3-david@tethera.net \
    --to=david@tethera.net \
    --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).