--- /dev/null
+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 14926431FBD\r
+ for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 15:42:48 -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 kRo5dM-xpqvD for <notmuch@notmuchmail.org>;\r
+ Fri, 18 Apr 2014 15:42:41 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-8.mit.edu (dmz-mailsec-scanner-8.mit.edu\r
+ [18.7.68.37])\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 BD3A8431FBF\r
+ for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 15:42:24 -0700 (PDT)\r
+X-AuditID: 12074425-f79906d000000cf9-98-5351aa4f7b2f\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-8.mit.edu (Symantec Messaging Gateway) with SMTP\r
+ id B0.10.03321.F4AA1535; Fri, 18 Apr 2014 18:42:23 -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 s3IMgCwU009368; \r
+ Fri, 18 Apr 2014 18:42:13 -0400\r
+Received: from drake.dyndns.org (26-4-172.dynamic.csail.mit.edu [18.26.4.172])\r
+ (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 s3IMgAX5028746\r
+ (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+ Fri, 18 Apr 2014 18:42:12 -0400\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
+ (envelope-from <amdragon@mit.edu>)\r
+ id 1WbHU2-0007bG-RL; Fri, 18 Apr 2014 18:42:10 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v2 1/4] doc: Clarify notmuch show --format=raw description\r
+Date: Fri, 18 Apr 2014 18:42:05 -0400\r
+Message-Id: <1397860928-29032-2-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 1.9.1\r
+In-Reply-To: <1397860928-29032-1-git-send-email-amdragon@mit.edu>\r
+References: <1397860928-29032-1-git-send-email-amdragon@mit.edu>\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFtrIIsWRmVeSWpSXmKPExsUixCmqreu/KjDYYM8jM4vrN2cyOzB6PFt1\r
+ izmAMYrLJiU1J7MstUjfLoEr48B5i4LjYhUbnj1nbGD8y9/FyMkhIWAi8X37BGYIW0ziwr31\r
+ bF2MXBxCArOZJI4f2MMM4WxklNh4cSkjhHOESWLv5laosrmMEj/+fgbrZxPQkNi2fzkjiC0i\r
+ IC2x8+5s1i5GDg5mATWJP10qIGFhAS+J9qML2EFsFgFVibuNC8FaeQUcJJofr2KFOENO4uSx\r
+ yWCtnAKOEte+CYGEhYBK+q8uZpzAyL+AkWEVo2xKbpVubmJmTnFqsm5xcmJeXmqRroVebmaJ\r
+ XmpK6SZGUMiwu6juYJxwSOkQowAHoxIP74aAwGAh1sSy4srcQ4ySHExKoryPFgOF+JLyUyoz\r
+ Eosz4otKc1KLDzFKcDArifBe7QLK8aYkVlalFuXDpKQ5WJTEed9aWwULCaQnlqRmp6YWpBbB\r
+ ZGU4OJQkeN+uBGoULEpNT61Iy8wpQUgzcXCCDOcBGv50Bcjw4oLE3OLMdIj8KUZFKXHeEyDN\r
+ AiCJjNI8uF5YTL9iFAd6RZi3BKSKB5gO4LpfAQ1mAhr890wAyOCSRISUVAPjYeM9U77nnCgJ\r
+ TZOZ/o5b6tMzMzu/pwF3T7atuhCvrZ5RaPMkQOHd4VSbeZKr7nupSvZyVX1nc5r54f+Bf0Ws\r
+ kn8fdjQnTzu9atPz7D2ukx6Yf7qw27uh/NNyiWSWPznMxvz1k5pOOajcnvxsZcK/jOgJP3df\r
+ ZTwgvWM6x1H/FtWwK7vfBF51U2Ipzkg01GIuKk4EAEo27KfEAgAA\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 22:42:48 -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..c4518ec 100644\r
+--- a/doc/man1/notmuch-show.rst\r
++++ b/doc/man1/notmuch-show.rst\r
+@@ -76,22 +76,22 @@ 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
+ ``--format-version=N``\r
+ Use the specified structured output format version. This is\r
+@@ -105,6 +105,10 @@ Supported options for **show** include\r
+ and are identified in the 'json', 'sexp' or 'text' output\r
+ formats.\r
+ \r
++ Note that even a message with no MIME structure or a single\r
++ body part still has two MIME parts: part 0 is the whole\r
++ message (headers and body) and part 1 is just the body.\r
++\r
+ ``--verify``\r
+ Compute and report the validity of any MIME cryptographic\r
+ signatures found in the selected content (ie. "multipart/signed"\r
+-- \r
+1.9.1\r
+\r
projects / notmuch-archives.git / commitdiff