unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: Austin Clements <amdragon@MIT.EDU>
To: Mark Walters <markwalters1009@gmail.com>
Cc: notmuch@notmuchmail.org
Subject: Re: [PATCH 3/4] man: update man page for the new --body=true|false option
Date: Mon, 23 Jul 2012 12:52:20 -0400	[thread overview]
Message-ID: <20120723165220.GH31834@mit.edu> (raw)
In-Reply-To: <1343060241-18283-4-git-send-email-markwalters1009@gmail.com>

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

  reply	other threads:[~2012-07-23 16:52 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-07-23 16:17 [PATCH 0/4] Add a --body option to notmuch show Mark Walters
2012-07-23 16:17 ` [PATCH 1/4] cli: add --body=true|false option to notmuch-show.c Mark Walters
2012-07-23 16:43   ` Austin Clements
2012-07-23 16:17 ` [PATCH 2/4] test: add tests for the new --body=true|false option Mark Walters
2012-07-23 16:17 ` [PATCH 3/4] man: update man page " Mark Walters
2012-07-23 16:52   ` Austin Clements [this message]
2012-07-23 16:17 ` [PATCH 4/4] schemata: update for " Mark Walters

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=20120723165220.GH31834@mit.edu \
    --to=amdragon@mit.edu \
    --cc=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).