Re: [PATCH] Fix typo in Message.maildir_flags_to_tags
[notmuch-archives.git] / 87 / 044f1ed46f3264e04861a69a6552869285ec03
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 14926431FBD\r
6         for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 15:42:48 -0700 (PDT)\r
7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
8 X-Spam-Flag: NO\r
9 X-Spam-Score: -0.7\r
10 X-Spam-Level: \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 kRo5dM-xpqvD for <notmuch@notmuchmail.org>;\r
16         Fri, 18 Apr 2014 15:42:41 -0700 (PDT)\r
17 Received: from dmz-mailsec-scanner-8.mit.edu (dmz-mailsec-scanner-8.mit.edu\r
18         [18.7.68.37])\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 BD3A8431FBF\r
22         for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 15:42:24 -0700 (PDT)\r
23 X-AuditID: 12074425-f79906d000000cf9-98-5351aa4f7b2f\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-8.mit.edu (Symantec Messaging Gateway) with SMTP\r
28         id B0.10.03321.F4AA1535; Fri, 18 Apr 2014 18:42:23 -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 s3IMgCwU009368; \r
31         Fri, 18 Apr 2014 18:42:13 -0400\r
32 Received: from drake.dyndns.org (26-4-172.dynamic.csail.mit.edu [18.26.4.172])\r
33         (authenticated bits=0)\r
34         (User authenticated as amdragon@ATHENA.MIT.EDU)\r
35         by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s3IMgAX5028746\r
36         (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
37         Fri, 18 Apr 2014 18:42:12 -0400\r
38 Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
39         (envelope-from <amdragon@mit.edu>)\r
40         id 1WbHU2-0007bG-RL; Fri, 18 Apr 2014 18:42:10 -0400\r
41 From: Austin Clements <amdragon@MIT.EDU>\r
42 To: notmuch@notmuchmail.org\r
43 Subject: [PATCH v2 1/4] doc: Clarify notmuch show --format=raw description\r
44 Date: Fri, 18 Apr 2014 18:42:05 -0400\r
45 Message-Id: <1397860928-29032-2-git-send-email-amdragon@mit.edu>\r
46 X-Mailer: git-send-email 1.9.1\r
47 In-Reply-To: <1397860928-29032-1-git-send-email-amdragon@mit.edu>\r
48 References: <1397860928-29032-1-git-send-email-amdragon@mit.edu>\r
49 X-Brightmail-Tracker:\r
50  H4sIAAAAAAAAA+NgFtrIIsWRmVeSWpSXmKPExsUixCmqreu/KjDYYM8jM4vrN2cyOzB6PFt1\r
51         izmAMYrLJiU1J7MstUjfLoEr48B5i4LjYhUbnj1nbGD8y9/FyMkhIWAi8X37BGYIW0ziwr31\r
52         bF2MXBxCArOZJI4f2MMM4WxklNh4cSkjhHOESWLv5laosrmMEj/+fgbrZxPQkNi2fzkjiC0i\r
53         IC2x8+5s1i5GDg5mATWJP10qIGFhAS+J9qML2EFsFgFVibuNC8FaeQUcJJofr2KFOENO4uSx\r
54         yWCtnAKOEte+CYGEhYBK+q8uZpzAyL+AkWEVo2xKbpVubmJmTnFqsm5xcmJeXmqRroVebmaJ\r
55         XmpK6SZGUMiwu6juYJxwSOkQowAHoxIP74aAwGAh1sSy4srcQ4ySHExKoryPFgOF+JLyUyoz\r
56         Eosz4otKc1KLDzFKcDArifBe7QLK8aYkVlalFuXDpKQ5WJTEed9aWwULCaQnlqRmp6YWpBbB\r
57         ZGU4OJQkeN+uBGoULEpNT61Iy8wpQUgzcXCCDOcBGv50Bcjw4oLE3OLMdIj8KUZFKXHeEyDN\r
58         AiCJjNI8uF5YTL9iFAd6RZi3BKSKB5gO4LpfAQ1mAhr890wAyOCSRISUVAPjYeM9U77nnCgJ\r
59         TZOZ/o5b6tMzMzu/pwF3T7atuhCvrZ5RaPMkQOHd4VSbeZKr7nupSvZyVX1nc5r54f+Bf0Ws\r
60         kn8fdjQnTzu9atPz7D2ukx6Yf7qw27uh/NNyiWSWPznMxvz1k5pOOajcnvxsZcK/jOgJP3df\r
61         ZTwgvWM6x1H/FtWwK7vfBF51U2Ipzkg01GIuKk4EAEo27KfEAgAA\r
62 X-BeenThere: notmuch@notmuchmail.org\r
63 X-Mailman-Version: 2.1.13\r
64 Precedence: list\r
65 List-Id: "Use and development of the notmuch mail system."\r
66         <notmuch.notmuchmail.org>\r
67 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
68         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
69 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
70 List-Post: <mailto:notmuch@notmuchmail.org>\r
71 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
72 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
73         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
74 X-List-Received-Date: Fri, 18 Apr 2014 22:42:48 -0000\r
75 \r
76 In addition to being generally more precise, this is explicit that\r
77 there is no charset conversion.\r
78 ---\r
79  doc/man1/notmuch-show.rst | 36 ++++++++++++++++++++----------------\r
80  1 file changed, 20 insertions(+), 16 deletions(-)\r
81 \r
82 diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst\r
83 index bad868b..c4518ec 100644\r
84 --- a/doc/man1/notmuch-show.rst\r
85 +++ b/doc/man1/notmuch-show.rst\r
86 @@ -76,22 +76,22 @@ Supported options for **show** include\r
87  \r
88             http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html\r
89  \r
90 -        **raw** (default for a single part, see --part)\r
91 -            For a message or an attached message part, the original, raw\r
92 -            content of the email message is output. Consumers of this\r
93 -            format should expect to implement MIME decoding and similar\r
94 -            functions.\r
95 -\r
96 -            For a single part (--part) the raw part content is output\r
97 -            after performing any necessary MIME decoding. Note that\r
98 -            messages with a simple body still have two parts: part 0 is\r
99 -            the whole message and part 1 is the body.\r
100 -\r
101 -            For a multipart part, the part headers and body (including\r
102 -            all child parts) is output.\r
103 -\r
104 -            The raw format must only be used with search terms matching\r
105 -            single message.\r
106 +        **raw** (default if --part is given)\r
107 +            Write the raw bytes of the given MIME part of a message to\r
108 +            standard out. For this format, it is an error to specify a\r
109 +            query that matches more than one message.\r
110 +\r
111 +            If the specified part is a leaf part, this outputs the\r
112 +            body of the part after performing content transfer\r
113 +            decoding (but no charset conversion). This is suitable for\r
114 +            saving attachments, for example.\r
115 +\r
116 +            For a multipart or message part, the output includes the\r
117 +            part headers as well as the body (including all child\r
118 +            parts). No decoding is performed because multipart and\r
119 +            message parts cannot have non-trivial content transfer\r
120 +            encoding. Consumers of this may need to implement MIME\r
121 +            decoding and similar functions.\r
122  \r
123      ``--format-version=N``\r
124          Use the specified structured output format version. This is\r
125 @@ -105,6 +105,10 @@ Supported options for **show** include\r
126          and are identified in the 'json', 'sexp' or 'text' output\r
127          formats.\r
128  \r
129 +        Note that even a message with no MIME structure or a single\r
130 +        body part still has two MIME parts: part 0 is the whole\r
131 +        message (headers and body) and part 1 is just the body.\r
132 +\r
133      ``--verify``\r
134          Compute and report the validity of any MIME cryptographic\r
135          signatures found in the selected content (ie. "multipart/signed"\r
136 -- \r
137 1.9.1\r
138 \r