[PATCH] doc: document new option `show.extra_headers`

Subject:[PATCH] doc: document new option `show.extra_headers`

Date:Tue, 18 Jan 2022 09:26:59 -0400

To:David Bremner ,notmuch@notmuchmail.org

Cc:

From:David Bremner


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:<thread-id>" 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 <show.extra_headers>`. See
+:any:`notmuch-config(1)` for details.
+
 EXIT STATUS
 ===========
 
-- 
2.34.1

_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: