[PATCH] man: show: update man page for entire-thread and json.
Mark Walters
markwalters1009 at gmail.com
Fri Jul 20 23:34:08 PDT 2012
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.
---
I didn't update the manpage in the recent patch series. This corrects
that omission. (Less cumbersome wording gratefully received)
Best wishes
Mark man/man1/notmuch-show.1 | 16 +++++++++-------
1 files changed, 9 insertions(+), 7 deletions(-)
diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1
index b51a54c..5fa590e 100644
--- a/man/man1/notmuch-show.1
+++ b/man/man1/notmuch-show.1
@@ -26,9 +26,9 @@ include
.TP 4
.B \-\-entire\-thread
-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.
+By default (except when format=json) 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.
.RE
.RS 4
@@ -55,11 +55,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
--
1.7.9.1
More information about the notmuch
mailing list