From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp10.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id qPQeK77C5WJAMAAAbAwnHQ (envelope-from ) for ; Sun, 31 Jul 2022 01:46:06 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp10.migadu.com with LMTPS id cAg/Kr7C5WKMCAEAG6o9tA (envelope-from ) for ; Sun, 31 Jul 2022 01:46:06 +0200 Received: from mail.notmuchmail.org (yantan.tethera.net [135.181.149.255]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 685D997D4 for ; Sun, 31 Jul 2022 01:46:06 +0200 (CEST) Received: from yantan.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id 3DF865F38C; Sat, 30 Jul 2022 23:46:03 +0000 (UTC) Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197]) by mail.notmuchmail.org (Postfix) with ESMTP id 925205F37B for ; Sat, 30 Jul 2022 23:46:00 +0000 (UTC) Received: by fethera.tethera.net (Postfix, from userid 1001) id A18D65FBC0; Sat, 30 Jul 2022 19:45:59 -0400 (EDT) Received: (nullmailer pid 2623915 invoked by uid 1000); Sat, 30 Jul 2022 23:45:58 -0000 From: David Bremner 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 Message-Id: <20220730234551.2623885-1-david@tethera.net> X-Mailer: git-send-email 2.35.2 MIME-Version: 1.0 Message-ID-Hash: 6LT2DGF54W522CXCRDG5JAL7JXAQPVLX X-Message-ID-Hash: 6LT2DGF54W522CXCRDG5JAL7JXAQPVLX X-MailFrom: bremner@tethera.net X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-notmuch.notmuchmail.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.3 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Migadu-Flow: FLOW_IN X-Migadu-To: larch@yhetil.org X-Migadu-Country: DE ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1659224766; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding:list-id:list-help: list-owner:list-unsubscribe:list-subscribe:list-post; bh=07KlQ9ySZLWacfUr8S0kXWCVSNFMYgeMBix5k0KOgJ0=; b=nFahJQB09gz6vaX5vcEzuHoJb3GWT507e+FcNkzV/acHzkECa6Q7elwUb11pSVKFrTNE/A YbarCFscFrH5p8c5nCql4gObBkspqGyhofvGTIxq1b2NZxk4rex04h1UEjbbG0TWLaIg9R U/1Bjo4loxpJLmI2lq3lfiA350xdh8iBBGvylQ6BsKeHpd1t8POc9RM691s1+NzdXxF9ut MndrQj6S2upywcUSdHqx4UqI5O7KCJrOro3Dv1D+cOc0hADhhhIxYcqnjKWzrgVoa8qSY1 yeSGvLl6A+iPPb/LWZHQWru3eniyzQ7CgFvPZ5SuetT5fgUi9kkjXlXIVW5ihw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1659224766; a=rsa-sha256; cv=none; b=UHEWwqhzsobNa63VfINNyKShDj2DC5WHhRobP2IN0KZMMz6QdXIv6USge28ODauExcY/6B bgerwtYh37urLyKoKJ5lYvFmSbpJnLwEHTByabdDouaJQCmV87YAPIHczfg+HoRTKVHtfb X2QRtoyOBx34mpilwMK82ODod8jgWMsjtgV9bSnDXBt0dFx1NFh4jgJgEiOLPZ5aiTCirC zMfn6dggQ2XdNrvQi02MHB7XcCag36EQByA5MhYkYvK9EJ9A4cvd0cuEVK0AbeampnUatJ Tij4pGI+YMhEctnHmDLZsLtzqw2LeouAMcjnBQMbcJ+W6oGueS/wHv5ZhEPdyw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 135.181.149.255 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Spam-Score: -1.69 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 135.181.149.255 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Queue-Id: 685D997D4 X-Spam-Score: -1.69 X-Migadu-Scanner: scn0.migadu.com X-TUID: 2lmBb86h98A6 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-** 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