diff options
| author | David Bremner <david@tethera.net> | 2022-01-18 09:26:59 -0400 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2022-01-25 07:51:48 -0400 |
| commit | 3bf6487359b693af572867083da06de2663fb1f8 (patch) | |
| tree | 1862c4af92321366de9ab39c3dd5a9a18d138d2a /doc | |
| parent | 88633bc7a79d47ba96879f698ec2267f2d3f6766 (diff) | |
doc: document new option `show.extra_headers`
Increase discoverability by cross referencing from the notmuch-show
manual entry to the notmuch-config manual entry.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man1/notmuch-config.rst | 14 | ||||
| -rw-r--r-- | doc/man1/notmuch-show.rst | 7 |
2 files changed, 21 insertions, 0 deletions
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 =========== |