[PATCH 3/4] man: update man page for the new --body=true|false option
Mark Walters
markwalters1009 at gmail.com
Mon Jul 23 09:17:20 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 5fa590e..d781c47 100644
--- a/man/man1/notmuch-show.1
+++ b/man/man1/notmuch-show.1
@@ -154,6 +154,22 @@ The default is
.RE
+.RS 4
+.TP 4
+.B \-\-body=(true|false)
+
+If true,
+.B notmuch show
+includes the bodies of the messages in the output whereas, if false,
+they are omitted. It defaults to true. Note that
+.B --body=false
+is only implemented for the json format.
+
+This is useful if the caller is only interested in the headers as it
+is much faster and the amount of output data is substantially
+reduced.
+.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