Re: [PATCH 3/4] man: update man page for the new --body=true|false option
authorAustin Clements <amdragon@MIT.EDU>
Mon, 23 Jul 2012 16:52:20 +0000 (12:52 +2000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:48:30 +0000 (09:48 -0800)
e9/9e6ba2e659470096d33c5055d89523001c43b8 [new file with mode: 0644]

diff --git a/e9/9e6ba2e659470096d33c5055d89523001c43b8 b/e9/9e6ba2e659470096d33c5055d89523001c43b8
new file mode 100644 (file)
index 0000000..d507219
--- /dev/null
@@ -0,0 +1,127 @@
+Return-Path: <amdragon@mit.edu>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id C8524431FB6\r
+       for <notmuch@notmuchmail.org>; Mon, 23 Jul 2012 09:52:24 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id on-F8TC9CvNw for <notmuch@notmuchmail.org>;\r
+       Mon, 23 Jul 2012 09:52:23 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-2.mit.edu (DMZ-MAILSEC-SCANNER-2.MIT.EDU\r
+       [18.9.25.13])\r
+       by olra.theworths.org (Postfix) with ESMTP id 4F2E2431FAE\r
+       for <notmuch@notmuchmail.org>; Mon, 23 Jul 2012 09:52:23 -0700 (PDT)\r
+X-AuditID: 1209190d-b7fd56d000000933-37-500d8146fe6c\r
+Received: from mailhub-auth-1.mit.edu ( [18.9.21.35])\r
+       by dmz-mailsec-scanner-2.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id C7.5A.02355.6418D005; Mon, 23 Jul 2012 12:52:22 -0400 (EDT)\r
+Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103])\r
+       by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id q6NGqLN1031381; \r
+       Mon, 23 Jul 2012 12:52:22 -0400\r
+Received: from awakening.csail.mit.edu (awakening.csail.mit.edu [18.26.4.91])\r
+       (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id q6NGqKiD022403\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Mon, 23 Jul 2012 12:52:21 -0400 (EDT)\r
+Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1StLro-0002hN-Eu; Mon, 23 Jul 2012 12:52:20 -0400\r
+Date: Mon, 23 Jul 2012 12:52:20 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: Mark Walters <markwalters1009@gmail.com>\r
+Subject: Re: [PATCH 3/4] man: update man page for the new --body=true|false\r
+       option\r
+Message-ID: <20120723165220.GH31834@mit.edu>\r
+References: <1343060241-18283-1-git-send-email-markwalters1009@gmail.com>\r
+       <1343060241-18283-4-git-send-email-markwalters1009@gmail.com>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+Content-Disposition: inline\r
+In-Reply-To: <1343060241-18283-4-git-send-email-markwalters1009@gmail.com>\r
+User-Agent: Mutt/1.5.21 (2010-09-15)\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFmpgleLIzCtJLcpLzFFi42IR4hRV1nVr5A0wuPRGyWL1XB6L6zdnMjsw\r
+       eeycdZfd49mqW8wBTFFcNimpOZllqUX6dglcGfvufmUsOMJVcfTSMuYGxukcXYycHBICJhL/\r
+       PjxghbDFJC7cW8/WxcjFISSwj1Hi05nVTBDOBkaJjRf+sYFUCQmcZJJY/TQMwl7CKHHhiUIX\r
+       IwcHi4CqxJZ9PiBhNgENiW37lzOC2CICOhK3Dy1gB7GZBaQlvv1uZgKxhQVCJLbPWgNm8wLV\r
+       LF++CGp8J6PEvy0VEHFBiZMzn7BA9GpJ3Pj3kglkFcic5f/A7ucU8JK43dcCNl5UQEViyslt\r
+       bBMYhWYh6Z6FpHsWQvcCRuZVjLIpuVW6uYmZOcWpybrFyYl5ealFukZ6uZkleqkppZsYwQEt\r
+       ybuD8d1BpUOMAhyMSjy8uxp4A4RYE8uKK3MPMUpyMCmJ8opWAIX4kvJTKjMSizPii0pzUosP\r
+       MUpwMCuJ8K6uBsrxpiRWVqUW5cOkpDlYlMR5r6Tc9BcSSE8sSc1OTS1ILYLJynBwKEnw8oPs\r
+       ESxKTU+tSMvMKUFIM3FwggznARquA1LDW1yQmFucmQ6RP8WoKCXO+6seKCEAksgozYPrhSWc\r
+       V4ziQK8I85qBtPMAkxVc9yugwUxAg6WzuEAGlyQipKQaGO0X6H25s/sA27OZDxlv/SjJcfvP\r
+       s0HvmcjKbKn6tX8OmyibCshwhz9QPfr0eU/Mlq+ik59mHFeyfv7i3PLupycNfh2Qyq93kOpS\r
+       rAy/EbXVs2Z2L2N+/q5jt/wVYoOerVleejJ+2dk//NO4Jv9/eTKGpecRz6KquSnOO1w8Zmi8\r
+       yFRaHbY88qoSS3FGoqEWc1FxIgDMS3ASEwMAAA==\r
+Cc: notmuch@notmuchmail.org\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Mon, 23 Jul 2012 16:52:24 -0000\r
+\r
+Quoth Mark Walters on Jul 23 at  5:17 pm:\r
+> ---\r
+>  man/man1/notmuch-show.1 |   16 ++++++++++++++++\r
+>  1 files changed, 16 insertions(+), 0 deletions(-)\r
+> \r
+> diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1\r
+> index 5fa590e..d781c47 100644\r
+> --- a/man/man1/notmuch-show.1\r
+> +++ b/man/man1/notmuch-show.1\r
+> @@ -154,6 +154,22 @@ The default is\r
+>  \r
+>  .RE\r
+>  \r
+> +.RS 4\r
+> +.TP 4\r
+> +.B \-\-body=(true|false)\r
+> +\r
+> +If true,\r
+\r
+"If true (the default)"?\r
+\r
+> +.B notmuch show\r
+> +includes the bodies of the messages in the output whereas, if false,\r
+\r
+The "whereas" is a bit awkward.  Perhaps just a semicolon?  "... in\r
+the output; if false, bodies are omitted."?\r
+\r
+> +they are omitted. It defaults to true.  Note that\r
+\r
+"Note that" is unnecessary here.\r
+\r
+> +.B --body=false\r
+> +is only implemented for the json format.\r
+> +\r
+> +This is useful if the caller is only interested in the headers as it\r
+\r
+s/is only interested in/only needs/?\r
+\r
+The "it" is a bit awkward, since it's not the option that's much\r
+faster, but the output.  "as body-less output is much faster and\r
+substantially reduces the amount of output"?\r
+\r
+> +is much faster and the amount of output data is substantially\r
+> +reduced.\r
+> +.RE\r
+> +\r
+>  A common use of\r
+>  .B notmuch show\r
+>  is to display a single thread of email messages. For this, use a\r