From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id GFzSBDLA5mGmNQEAgWs5BA (envelope-from ) for ; Tue, 18 Jan 2022 14:27:14 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id IDhLAjLA5mEEFgEA9RJhRA (envelope-from ) for ; Tue, 18 Jan 2022 14:27:14 +0100 Received: from mail.notmuchmail.org (yantan.tethera.net [IPv6:2a01:4f9:c011:7a79::1]) (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 C9CBB3EC71 for ; Tue, 18 Jan 2022 14:27:13 +0100 (CET) Received: from yantan.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id C32EE5F6BE; Tue, 18 Jan 2022 13:27:09 +0000 (UTC) Received: from fethera.tethera.net (fethera.tethera.net [IPv6:2607:5300:60:c5::1]) by mail.notmuchmail.org (Postfix) with ESMTP id E80345F5E1 for ; Tue, 18 Jan 2022 13:27:06 +0000 (UTC) Received: by fethera.tethera.net (Postfix, from userid 1001) id DC5C55FC01; Tue, 18 Jan 2022 08:27:05 -0500 (EST) Received: (nullmailer pid 2906379 invoked by uid 1000); Tue, 18 Jan 2022 13:27:04 -0000 From: David Bremner To: David Bremner , notmuch@notmuchmail.org Subject: [PATCH] doc: document new option `show.extra_headers` Date: Tue, 18 Jan 2022 09:26:59 -0400 Message-Id: <20220118132659.2906367-1-david@tethera.net> X-Mailer: git-send-email 2.34.1 In-Reply-To: <87h7a1w89l.fsf@tethera.net> References: <87h7a1w89l.fsf@tethera.net> MIME-Version: 1.0 Message-ID-Hash: HZTJZMC6XPHCGNMFCXYRQ62NEOEJLF7A X-Message-ID-Hash: HZTJZMC6XPHCGNMFCXYRQ62NEOEJLF7A 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-Country: DE ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1642512433; 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: in-reply-to:in-reply-to:references:references:list-id:list-help: list-owner:list-unsubscribe:list-subscribe:list-post; bh=ZNjdlP4JsQ7n/Lh1wZdQu2Z8C0CAQYL7yTA47deuZhI=; b=dsdK3bWHka6vvh5Sj6G9Bw2MupfLnlX+e2b4TS5kVxcH//B+qGnbFMXqcOeaPTi/RGmWeZ BXkIB3IdtrGxKZTIhJpJ1RNUNQtevww6nPtqXah/j9R7anK0eLQRbahwJwbQZhNeqH3srE hudyZnSsYzEiZ0WiF/B8/wTXyrDRaO0q5K6PkGILIq5aSW0P6IJsXhJ2MLUmJTwqn9LJwW DZZntixdbWJWYgA1KFVoALOOZtqWA+uhx4moxcHK0Ht47vyl76UqOzrEsZ+yH48zNYpBo2 0y8PbSzU/Mc3fddxKnZV/fbDxFnuWTSv3MCGy8fm1wmYDSiJVbSWX1y87USoKQ== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1642512433; a=rsa-sha256; cv=none; b=IdZ8M8sYkmZJpHDRz8L64H9KxyCJKrOJ0ztnZRSJKiiO9uslI4QC10u3Hh2We5Wx8eEf+z hOHdT1yWsBXcgza/31hcCQNWygyf401IK+UMqNTjVY73WbKoHEPBA3d/97e6nT0oMZtA36 fOMRFvlznywfrGRoRl2bFBga6LGsYdMk0RKoDNl00H45Z854Xcph8Brin3mdWV7mJgPGpV UmQ/hko7hN7AvCi8c2BxtJUZZQFL8m9rSltUadjhNFvQ+TwaM8bymHIOcfDEItD28XRaCH jN3wxzbVPSqqAWjMhAHwKEWAbgd0kvTtEufMl+ZoIZYQMfl33fVHSCB2Ju9dVQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 2a01:4f9:c011:7a79::1 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Spam-Score: -1.82 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 2a01:4f9:c011:7a79::1 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Queue-Id: C9CBB3EC71 X-Spam-Score: -1.82 X-Migadu-Scanner: scn0.migadu.com X-TUID: ju3jD2g+pjjj Increase discoverability by cross referencing from the notmuch-show manual entry to the notmuch-config manual entry. --- doc/man1/notmuch-config.rst | 14 ++++++++++++++ doc/man1/notmuch-show.rst | 7 +++++++ 2 files changed, 21 insertions(+) diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst index ed188a25..41e1338b 100644 --- a/doc/man1/notmuch-config.rst +++ b/doc/man1/notmuch-config.rst @@ -145,6 +145,20 @@ search.exclude\_tags Default: empty list. Note that :any:`notmuch-setup(1)` puts ``deleted;spam`` here when creating new configuration file. +.. _show.extra_headers: + +show.extra\_headers + + By default :any:`notmuch-show(1)` includes the following headers + in structured output if they are present in the message: + `Subject`, `From`, `To`, `Cc`, `Bcc`, `Reply-To`, `Date`. This + option allows the specification of a list of further + headers to output. + + History: This configuration value was introduced in notmuch 0.35. + + Default: empty list. + maildir.synchronize\_flags If true, then the following maildir flags (in message filenames) will be synchronized with the corresponding notmuch tags: diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst index 3d2a2c41..1b02d407 100644 --- a/doc/man1/notmuch-show.rst +++ b/doc/man1/notmuch-show.rst @@ -221,6 +221,13 @@ email messages. For this, use a search term of "thread:" as can be seen in the first column of output from the :any:`notmuch-search(1)` command. +CONFIGURATION +============= + +Structured output (json / sexp) is influenced by the configuration +option :ref:`show.extra_headers `. See +:any:`notmuch-config(1)` for details. + EXIT STATUS =========== -- 2.34.1