X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=man%2Fman1%2Fnotmuch-show.1;h=4481f216b30970b7f2f5cecbd099439f64bd65b5;hb=df6f3cdf9d421011090ccb50af9828f5903544ee;hp=506583a6c6ebccb833d84d7e3d7569e7d29a5bdf;hpb=52e50f78238fe1b2ed46fabcb203b37048a3ae44;p=notmuch diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1 index 506583a6..4481f216 100644 --- a/man/man1/notmuch-show.1 +++ b/man/man1/notmuch-show.1 @@ -1,4 +1,4 @@ -.TH NOTMUCH-SHOW 1 2012-06-01 "Notmuch 0.13.2" +.TH NOTMUCH-SHOW 1 2012-08-20 "Notmuch 0.14" .SH NAME notmuch-show \- show messages matching the given search terms .SH SYNOPSIS @@ -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