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

[notmuch] / man / man1 / notmuch-show.1

diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1
index 27a06b7aa64a72d750e5cfd816ea3defa4c43522..765b22c630c0c939f2e3c9fa2375ac16820a4660 100644 (file)
--- a/man/man1/notmuch-show.1
+++ b/man/man1/notmuch-show.1
@@ -1,6 +1,6 @@
-.TH NOTMUCH-SHOW 1 2012-02-29 "Notmuch 0.12~rc1"
+.TH NOTMUCH-SHOW 1 2012-06-01 "Notmuch 0.13.2"

 .SH NAME
 .SH NAME

-notmuch-show \- Show messages matching the given search terms.
+notmuch-show \- show messages matching the given search terms

 .SH SYNOPSIS
 
 .B notmuch show
 .SH SYNOPSIS
 
 .B notmuch show


@@ -24,11 +24,14 @@ Supported options for
 include
 .RS 4
 .TP 4
 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
 .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
 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
 .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
 
 .RE
 .RS 4


@@ -84,12 +89,17 @@ http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
 .TP 4
 .BR raw " (default for a single part, see \-\-part)"
 
 .TP 4
 .BR raw " (default for a single part, see \-\-part)"
 

-For a message, the original, raw content of the email message is
-output. Consumers of this format should expect to implement MIME
-decoding and similar functions.
+For a message or an attached message part, the original, raw content
+of the email message is output. Consumers of this format should expect
+to implement MIME decoding and similar functions.

 
 For a single part (\-\-part) the raw part content is output after
 
 For a single part (\-\-part) the raw part content is output after

-performing any necessary MIME decoding.
+performing any necessary MIME decoding.  Note that messages with a
+simple body still have two parts: part 0 is the whole message and part
+1 is the body.
+
+For a multipart part, the part headers and body (including all child
+parts) is output.

 
 The raw format must only be used with search terms matching single
 message.
 
 The raw format must only be used with search terms matching single
 message.


@@ -125,7 +135,42 @@ Decrypt any MIME encrypted parts found in the selected content
 (ie. "multipart/encrypted" parts). Status of the decryption will be
 reported (currently only supported with --format=json) and the
 multipart/encrypted part will be replaced by the decrypted
 (ie. "multipart/encrypted" parts). Status of the decryption will be
 reported (currently only supported with --format=json) and the
 multipart/encrypted part will be replaced by the decrypted

-content.
+content.  Implies --verify.
+.RE
+
+.RS 4
+.TP 4
+.BR \-\-exclude=(true|false)
+
+Specify whether to omit threads only matching search.tag_exclude from
+the search results (the default) or not. In either case the excluded
+message will be marked with the exclude flag (except when output=mbox
+when there is nowhere to put the flag).
+
+If --entire-thread is specified then complete threads are returned
+regardless (with the excluded flag being set when appropriate) but
+threads that only match in an excluded message are not returned when
+.B --exclude=true.
+
+The default is
+.B --exclude=true.
+
+.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
 .RE
 
 A common use of