debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-12-22 09:24:54 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

man: show: update man page for entire-thread and json.

Browse source 
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.
This commit is contained in:
Mark Walters 2012-07-24 19:57:57 +01:00 committed by David Bremner
parent ed93d79199
commit a89a2b276f
1 changed files with 13 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
man/man1/notmuch-show.1
View file

@ -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