]> git.cworth.org Git - obsolete/notmuch-old/blobdiff - man/man1/notmuch-show.1
man: update man page for the new --body=true|false option
[obsolete/notmuch-old] / man / man1 / notmuch-show.1
index 3a6c02e7707f2d0f516d8ebda7dbc1f9d0bc89cd..506583a6c6ebccb833d84d7e3d7569e7d29a5bdf 100644 (file)
@@ -1,6 +1,6 @@
-.TH NOTMUCH-SHOW 1 2012-05-25 "Notmuch 0.13.1"
+.TH NOTMUCH-SHOW 1 2012-06-01 "Notmuch 0.13.2"
 .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
@@ -152,6 +152,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