diff options
| author | Mark Walters <markwalters1009@gmail.com> | 2012-07-24 19:57:57 +0100 |
|---|---|---|
| committer | David Bremner <bremner@debian.org> | 2012-07-25 08:14:48 -0300 |
| commit | a89a2b276f59d8a97a7e3e6213f385aab79094a1 (patch) | |
| tree | 143450bbe5513fb102ddf0ee21b4f2c6a251f6a9 | |
| parent | ed93d7919914d5eb11263cbc4ef864ad0bd54bff (diff) | |
man: show: update man page for entire-thread and json.
Previously in notmuch show --format=json implied --entire-thread. This
is still the default but it is now possible to disable this. Update
the manpage to reflect this.
| -rw-r--r-- | man/man1/notmuch-show.1 | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1 index 506583a..765b22c 100644 --- a/man/man1/notmuch-show.1 +++ b/man/man1/notmuch-show.1 @@ -24,11 +24,14 @@ Supported options for include .RS 4 .TP 4 -.B \-\-entire\-thread +.B \-\-entire\-thread=(true|false) -By default only those messages that match the search terms will be -displayed. With this option, all messages in the same thread as any -matched message will be displayed. +If true, +.B notmuch show +outputs all messages in the thread of any message matching the search +terms; if false, it outputs only the matching messages. For +.B --format=json +this defaults to true. For other formats, this defaults to false. .RE .RS 4 @@ -55,11 +58,13 @@ be nested. The output is formatted with Javascript Object Notation (JSON). This format is more robust than the text format for automated processing. The nested structure of multipart MIME messages is -reflected in nested JSON output. JSON output always includes all -messages in a matching thread; in effect +reflected in nested JSON output. By default JSON output includes all +messages in a matching thread; that is, by default, .B \-\-format=json -implies -.B \-\-entire\-thread +sets +.B "\-\-entire\-thread" +The caller can disable this behaviour by setting +.B \-\-entire\-thread=false .RE .RS 4 |