X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=man%2Fman1%2Fnotmuch-show.1;h=765b22c630c0c939f2e3c9fa2375ac16820a4660;hb=46446158fd4da1f06f6f0c00acd5fff611afaf48;hp=b51a54c348dfc7b9ccc93407ad02bb3ebd26ad1d;hpb=e4b429039f2598c34ad2a690beb122219705fd5f;p=notmuch diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1 index b51a54c3..765b22c6 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 @@ -152,6 +157,22 @@ The default is .RE +.RS 4 +.TP 4 +.B \-\-body=(true|false) + +If true (the default) +.B notmuch show +includes the bodies of the messages in the output; if false, +bodies are omitted. +.B --body=false +is only implemented for the json format and it is incompatible with +.B --part > 0. + +This is useful if the caller only needs the headers as body-less +output is much faster and substantially smaller. +.RE + A common use of .B notmuch show is to display a single thread of email messages. For this, use a