1 Return-Path: <amdragon@mit.edu>
\r
2 X-Original-To: notmuch@notmuchmail.org
\r
3 Delivered-To: notmuch@notmuchmail.org
\r
4 Received: from localhost (localhost [127.0.0.1])
\r
5 by olra.theworths.org (Postfix) with ESMTP id 1F526431FC0
\r
6 for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 08:19:19 -0700 (PDT)
\r
7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
\r
11 X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5
\r
12 tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled
\r
13 Received: from olra.theworths.org ([127.0.0.1])
\r
14 by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)
\r
15 with ESMTP id ksrCFn-bMwz3 for <notmuch@notmuchmail.org>;
\r
16 Fri, 18 Apr 2014 08:19:11 -0700 (PDT)
\r
17 Received: from dmz-mailsec-scanner-3.mit.edu (dmz-mailsec-scanner-3.mit.edu
\r
19 (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))
\r
20 (No client certificate requested)
\r
21 by olra.theworths.org (Postfix) with ESMTPS id E3647431FBF
\r
22 for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 08:19:06 -0700 (PDT)
\r
23 X-AuditID: 1209190e-f79ee6d000000c40-41-535142655227
\r
24 Received: from mailhub-auth-3.mit.edu ( [18.9.21.43])
\r
25 (using TLS with cipher AES256-SHA (256/256 bits))
\r
26 (Client did not present a certificate)
\r
27 by dmz-mailsec-scanner-3.mit.edu (Symantec Messaging Gateway) with SMTP
\r
28 id 8F.59.03136.66241535; Fri, 18 Apr 2014 11:19:02 -0400 (EDT)
\r
29 Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])
\r
30 by mailhub-auth-3.mit.edu (8.13.8/8.9.2) with ESMTP id s3IFIxhB021239;
\r
31 Fri, 18 Apr 2014 11:18:59 -0400
\r
32 Received: from drake.dyndns.org
\r
33 (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com
\r
34 [216.15.114.40]) (authenticated bits=0)
\r
35 (User authenticated as amdragon@ATHENA.MIT.EDU)
\r
36 by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s3IFIv3i027506
\r
37 (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);
\r
38 Fri, 18 Apr 2014 11:18:58 -0400
\r
39 Received: from amthrax by drake.dyndns.org with local (Exim 4.77)
\r
40 (envelope-from <amdragon@mit.edu>)
\r
41 id 1WbAZ7-0006b4-1L; Fri, 18 Apr 2014 11:18:57 -0400
\r
42 From: Austin Clements <amdragon@MIT.EDU>
\r
43 To: notmuch@notmuchmail.org
\r
44 Subject: [PATCH 1/4] doc: Clarify notmuch show --format=raw description
\r
45 Date: Fri, 18 Apr 2014 11:18:49 -0400
\r
46 Message-Id: <1397834332-25175-2-git-send-email-amdragon@mit.edu>
\r
47 X-Mailer: git-send-email 1.9.1
\r
48 In-Reply-To: <1397834332-25175-1-git-send-email-amdragon@mit.edu>
\r
49 References: <1397834332-25175-1-git-send-email-amdragon@mit.edu>
\r
50 X-Brightmail-Tracker:
\r
51 H4sIAAAAAAAAA+NgFtrEIsWRmVeSWpSXmKPExsUixCmqrZvmFBhs8G0ls8X1mzOZHRg9nq26
\r
52 xRzAGMVlk5Kak1mWWqRvl8CVcfvDcaaCN8IVF/u+MjYwfuPtYuTgkBAwkXjxoriLkRPIFJO4
\r
53 cG89WxcjF4eQwGwmiY0PGtghnI2MEtPe/WaFcO4wSXyZdAbKmcsosfHYNxaQfjYBDYlt+5cz
\r
54 gtgiAtISO+/OZgVZwSygJvGnSwUkLCzgLrH3BkgvJweLgKrE1FnXwGxeAQeJWT/Ps0OcISdx
\r
55 8thksDingKPEy+UtYOOFgGqevzrLNIGRfwEjwypG2ZTcKt3cxMyc4tRk3eLkxLy81CJdY73c
\r
56 zBK91JTSTYzgoJHk28H49aDSIUYBDkYlHt5I5sBgIdbEsuLK3EOMkhxMSqK8FTZAIb6k/JTK
\r
57 jMTijPii0pzU4kOMEhzMSiK8u/8GBAvxpiRWVqUW5cOkpDlYlMR531pbBQsJpCeWpGanphak
\r
58 FsFkZTg4lCR4qx2BhgoWpaanVqRl5pQgpJk4OEGG8wANTwCp4S0uSMwtzkyHyJ9iVJQS581z
\r
59 AEoIgCQySvPgemFR/YpRHOgVYd7pIO08wIQA1/0KaDAT0OC/Z0CuLi5JREhJNTC6L/p1LjZh
\r
60 RotMu00J10Ym6/8zitbqfehVmthw5VH/Cy9F3u9h+f8v7ZMXlDi0pPkUs1Ot6URW7wuF4Sue
\r
61 WNz9dW/u+92PODcsnaL/r8y506DaOMyN0aZDzEXtc3O69pQ8u/bE0zMXqm/8zLLgGV9t6fc3
\r
62 qqxmlgapvLLPzc8ySW6Om33WOk2JpTgj0VCLuag4EQCcx+qBxQIAAA==
\r
63 X-BeenThere: notmuch@notmuchmail.org
\r
64 X-Mailman-Version: 2.1.13
\r
66 List-Id: "Use and development of the notmuch mail system."
\r
67 <notmuch.notmuchmail.org>
\r
68 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,
\r
69 <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
\r
70 List-Archive: <http://notmuchmail.org/pipermail/notmuch>
\r
71 List-Post: <mailto:notmuch@notmuchmail.org>
\r
72 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
\r
73 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,
\r
74 <mailto:notmuch-request@notmuchmail.org?subject=subscribe>
\r
75 X-List-Received-Date: Fri, 18 Apr 2014 15:19:19 -0000
\r
77 In addition to being generally more precise, this is explicit that
\r
78 there is no charset conversion.
\r
80 doc/man1/notmuch-show.rst | 36 ++++++++++++++++++++----------------
\r
81 1 file changed, 20 insertions(+), 16 deletions(-)
\r
83 diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst
\r
84 index bad868b..2c0f64c 100644
\r
85 --- a/doc/man1/notmuch-show.rst
\r
86 +++ b/doc/man1/notmuch-show.rst
\r
87 @@ -76,22 +76,26 @@ Supported options for **show** include
\r
89 http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
\r
91 - **raw** (default for a single part, see --part)
\r
92 - For a message or an attached message part, the original, raw
\r
93 - content of the email message is output. Consumers of this
\r
94 - format should expect to implement MIME decoding and similar
\r
97 - For a single part (--part) the raw part content is output
\r
98 - after performing any necessary MIME decoding. Note that
\r
99 - messages with a simple body still have two parts: part 0 is
\r
100 - the whole message and part 1 is the body.
\r
102 - For a multipart part, the part headers and body (including
\r
103 - all child parts) is output.
\r
105 - The raw format must only be used with search terms matching
\r
107 + **raw** (default if --part is given)
\r
108 + Write the raw bytes of the given MIME part of a message to
\r
109 + standard out. For this format, it is an error to specify a
\r
110 + query that matches more than one message.
\r
112 + If the specified part is a leaf part, this outputs the
\r
113 + body of the part after performing content transfer
\r
114 + decoding (but no charset conversion). This is suitable for
\r
115 + saving attachments, for example.
\r
117 + For a multipart or message part, the output includes the
\r
118 + part headers as well as the body (including all child
\r
119 + parts). No decoding is performed because multipart and
\r
120 + message parts cannot have non-trivial content transfer
\r
121 + encoding. Consumers of this may need to implement MIME
\r
122 + decoding and similar functions.
\r
124 + Note that even a message with a simple body has two parts:
\r
125 + part 0 is the whole message and part 1 is the body of the
\r
128 ``--format-version=N``
\r
129 Use the specified structured output format version. This is
\r