From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Subject: [PATCH 1/3] doc/notmuch: merge two sections on external commands.
Date: Sat, 30 Jul 2022 20:45:49 -0300 [thread overview]
Message-ID: <20220730234551.2623885-1-david@tethera.net> (raw)
When adding the description of the propagation of NOTMUCH_CONFIG, I
missed that there was already a section on external commands, with a
different title.
---
doc/man1/notmuch.rst | 16 +++++-----------
1 file changed, 5 insertions(+), 11 deletions(-)
diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst
index e0892e01..1fec4ee5 100644
--- a/doc/man1/notmuch.rst
+++ b/doc/man1/notmuch.rst
@@ -130,14 +130,16 @@ and to restore from that dump.
The :any:`notmuch-config(1)` command can be used to get or set
settings in the notmuch configuration file.
-CUSTOM COMMANDS
----------------
+EXTERNAL COMMANDS
+-----------------
If the given command is not known to notmuch, notmuch tries to execute
the external **notmuch-<subcommand>** in :envvar:`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 overridden using external commands.
+to be overridden using external commands. The environment variable
+:envvar:`NOTMUCH_CONFIG` will be set according to :option:`--config`,
+if the latter is present.
OPTION SYNTAX
-------------
@@ -185,14 +187,6 @@ 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
next reply other threads:[~2022-07-30 23:46 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-30 23:45 David Bremner [this message]
2022-07-30 23:45 ` [PATCH 2/3] emacs: add docstring for notmuch-show-choose-duplicate David Bremner
2022-07-31 12:46 ` [PATCH v2] " David Bremner
2022-07-30 23:45 ` [PATCH 3/3] doc: add some documentation about duplicate files David Bremner
2022-08-11 10:42 ` David Bremner
2022-08-06 12:23 ` [PATCH 1/3] doc/notmuch: merge two sections on 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=20220730234551.2623885-1-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).