[PATCH v2 (rebased) 3/4] man: update man page for the new --body=true|false option
Mark Walters
markwalters1009 at gmail.com
Tue Jul 24 11:23:29 PDT 2012
---
man/man1/notmuch-show.1 | 16 ++++++++++++++++
1 files changed, 16 insertions(+), 0 deletions(-)
diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1
index b51a54c..506583a 100644
--- a/man/man1/notmuch-show.1
+++ b/man/man1/notmuch-show.1
@@ -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
--
1.7.9.1
More information about the notmuch
mailing list