[PATCH 1/4] doc: Clarify notmuch show --format=raw description

diff --git a/5a/44a247fad688eb7a487655c1856c5de3dfa7b3 b/5a/44a247fad688eb7a487655c1856c5de3dfa7b3
new file mode 100644 (file)
index 0000000..d7c2a62
--- /dev/null
+++ b/5a/44a247fad688eb7a487655c1856c5de3dfa7b3
@@ -0,0 +1,132 @@
+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 1F526431FC0\r
+       for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 08:19:19 -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 ksrCFn-bMwz3 for <notmuch@notmuchmail.org>;\r
+       Fri, 18 Apr 2014 08:19:11 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-3.mit.edu (dmz-mailsec-scanner-3.mit.edu\r
+       [18.9.25.14])\r
+       (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id E3647431FBF\r
+       for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 08:19:06 -0700 (PDT)\r
+X-AuditID: 1209190e-f79ee6d000000c40-41-535142655227\r
+Received: from mailhub-auth-3.mit.edu ( [18.9.21.43])\r
+       (using TLS with cipher AES256-SHA (256/256 bits))\r
+       (Client did not present a certificate)\r
+       by dmz-mailsec-scanner-3.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id 8F.59.03136.66241535; Fri, 18 Apr 2014 11:19:02 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-3.mit.edu (8.13.8/8.9.2) with ESMTP id s3IFIxhB021239; \r
+       Fri, 18 Apr 2014 11:18:59 -0400\r
+Received: from drake.dyndns.org\r
+       (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com\r
+       [216.15.114.40]) (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s3IFIv3i027506\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Fri, 18 Apr 2014 11:18:58 -0400\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1WbAZ7-0006b4-1L; Fri, 18 Apr 2014 11:18:57 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 1/4] doc: Clarify notmuch show --format=raw description\r
+Date: Fri, 18 Apr 2014 11:18:49 -0400\r
+Message-Id: <1397834332-25175-2-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 1.9.1\r
+In-Reply-To: <1397834332-25175-1-git-send-email-amdragon@mit.edu>\r
+References: <1397834332-25175-1-git-send-email-amdragon@mit.edu>\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFtrEIsWRmVeSWpSXmKPExsUixCmqrZvmFBhs8G0ls8X1mzOZHRg9nq26\r
+       xRzAGMVlk5Kak1mWWqRvl8CVcfvDcaaCN8IVF/u+MjYwfuPtYuTgkBAwkXjxoriLkRPIFJO4\r
+       cG89WxcjF4eQwGwmiY0PGtghnI2MEtPe/WaFcO4wSXyZdAbKmcsosfHYNxaQfjYBDYlt+5cz\r
+       gtgiAtISO+/OZgVZwSygJvGnSwUkLCzgLrH3BkgvJweLgKrE1FnXwGxeAQeJWT/Ps0OcISdx\r
+       8thksDingKPEy+UtYOOFgGqevzrLNIGRfwEjwypG2ZTcKt3cxMyc4tRk3eLkxLy81CJdY73c\r
+       zBK91JTSTYzgoJHk28H49aDSIUYBDkYlHt5I5sBgIdbEsuLK3EOMkhxMSqK8FTZAIb6k/JTK\r
+       jMTijPii0pzU4kOMEhzMSiK8u/8GBAvxpiRWVqUW5cOkpDlYlMR531pbBQsJpCeWpGanphak\r
+       FsFkZTg4lCR4qx2BhgoWpaanVqRl5pQgpJk4OEGG8wANTwCp4S0uSMwtzkyHyJ9iVJQS581z\r
+       AEoIgCQySvPgemFR/YpRHOgVYd7pIO08wIQA1/0KaDAT0OC/Z0CuLi5JREhJNTC6L/p1LjZh\r
+       RotMu00J10Ym6/8zitbqfehVmthw5VH/Cy9F3u9h+f8v7ZMXlDi0pPkUs1Ot6URW7wuF4Sue\r
+       WNz9dW/u+92PODcsnaL/r8y506DaOMyN0aZDzEXtc3O69pQ8u/bE0zMXqm/8zLLgGV9t6fc3\r
+       qqxmlgapvLLPzc8ySW6Om33WOk2JpTgj0VCLuag4EQCcx+qBxQIAAA==\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: Fri, 18 Apr 2014 15:19:19 -0000\r
+\r
+In addition to being generally more precise, this is explicit that\r
+there is no charset conversion.\r
+---\r
+ doc/man1/notmuch-show.rst | 36 ++++++++++++++++++++----------------\r
+ 1 file changed, 20 insertions(+), 16 deletions(-)\r
+\r
+diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst\r
+index bad868b..2c0f64c 100644\r
+--- a/doc/man1/notmuch-show.rst\r
++++ b/doc/man1/notmuch-show.rst\r
+@@ -76,22 +76,26 @@ Supported options for **show** include\r
+ \r
+           http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html\r
+ \r
+-        **raw** (default for a single part, see --part)\r
+-            For a message or an attached message part, the original, raw\r
+-            content of the email message is output. Consumers of this\r
+-            format should expect to implement MIME decoding and similar\r
+-            functions.\r
+-\r
+-            For a single part (--part) the raw part content is output\r
+-            after performing any necessary MIME decoding. Note that\r
+-            messages with a simple body still have two parts: part 0 is\r
+-            the whole message and part 1 is the body.\r
+-\r
+-            For a multipart part, the part headers and body (including\r
+-            all child parts) is output.\r
+-\r
+-            The raw format must only be used with search terms matching\r
+-            single message.\r
++        **raw** (default if --part is given)\r
++            Write the raw bytes of the given MIME part of a message to\r
++            standard out. For this format, it is an error to specify a\r
++            query that matches more than one message.\r
++\r
++            If the specified part is a leaf part, this outputs the\r
++            body of the part after performing content transfer\r
++            decoding (but no charset conversion). This is suitable for\r
++            saving attachments, for example.\r
++\r
++            For a multipart or message part, the output includes the\r
++            part headers as well as the body (including all child\r
++            parts). No decoding is performed because multipart and\r
++            message parts cannot have non-trivial content transfer\r
++            encoding. Consumers of this may need to implement MIME\r
++            decoding and similar functions.\r
++\r
++            Note that even a message with a simple body has two parts:\r
++            part 0 is the whole message and part 1 is the body of the\r
++            message.\r
+ \r
+     ``--format-version=N``\r
+         Use the specified structured output format version. This is\r
+-- \r
+1.9.1\r
+\r