unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: Mark Walters <markwalters1009@gmail.com>
To: notmuch@notmuchmail.org
Subject: [PATCH v2 (rebased) 3/4] man: update man page for the new --body=true|false option
Date: Tue, 24 Jul 2012 19:23:29 +0100	[thread overview]
Message-ID: <1343154210-26841-4-git-send-email-markwalters1009@gmail.com> (raw)
In-Reply-To: <1343154210-26841-1-git-send-email-markwalters1009@gmail.com>

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

  parent reply	other threads:[~2012-07-24 18:25 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-07-24 18:23 [PATCH v2 (rebased) 0/4] Add a --body option to notmuch show Mark Walters
2012-07-24 18:23 ` [PATCH v2 (rebased) 1/4] cli: add --body=true|false option to notmuch-show.c Mark Walters
2012-07-24 18:23 ` [PATCH v2 (rebased) 2/4] test: add tests for the new --body=true|false option Mark Walters
2012-07-24 18:23 ` Mark Walters [this message]
2012-07-24 18:23 ` [PATCH v2 (rebased) 4/4] schemata: update for " Mark Walters
2012-07-24 18:35 ` [PATCH v2 (rebased) 0/4] Add a --body option to notmuch show David Bremner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1343154210-26841-4-git-send-email-markwalters1009@gmail.com \
    --to=markwalters1009@gmail.com \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).