Date: Mon, 23 Jul 2012 12:52:20 -0400
From: Austin Clements <amdragon@MIT.EDU>
To: Mark Walters <markwalters1009@gmail.com>
Subject: Re: [PATCH 3/4] man: update man page for the new --body=true|false
	option
Message-ID: <20120723165220.GH31834@mit.edu>
References: <1343060241-18283-1-git-send-email-markwalters1009@gmail.com>
	<1343060241-18283-4-git-send-email-markwalters1009@gmail.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <1343060241-18283-4-git-send-email-markwalters1009@gmail.com>
User-Agent: Mutt/1.5.21 (2010-09-15)
Cc: notmuch@notmuchmail.org
Precedence: list

Quoth Mark Walters on Jul 23 at  5:17 pm:
> ---
>  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,

"If true (the default)"?

> +.B notmuch show
> +includes the bodies of the messages in the output whereas, if false,

The "whereas" is a bit awkward.  Perhaps just a semicolon?  "... in
the output; if false, bodies are omitted."?

> +they are omitted. It defaults to true.  Note that

"Note that" is unnecessary here.

> +.B --body=false
> +is only implemented for the json format.
> +
> +This is useful if the caller is only interested in the headers as it

s/is only interested in/only needs/?

The "it" is a bit awkward, since it's not the option that's much
faster, but the output.  "as body-less output is much faster and
substantially reduces the amount of output"?

> +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