From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by olra.theworths.org (Postfix) with ESMTP id 14926431FBD for ; Fri, 18 Apr 2014 15:42:48 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at olra.theworths.org X-Spam-Flag: NO X-Spam-Score: -0.7 X-Spam-Level: X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled Received: from olra.theworths.org ([127.0.0.1]) by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id kRo5dM-xpqvD for ; Fri, 18 Apr 2014 15:42:41 -0700 (PDT) Received: from dmz-mailsec-scanner-8.mit.edu (dmz-mailsec-scanner-8.mit.edu [18.7.68.37]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) by olra.theworths.org (Postfix) with ESMTPS id BD3A8431FBF for ; Fri, 18 Apr 2014 15:42:24 -0700 (PDT) X-AuditID: 12074425-f79906d000000cf9-98-5351aa4f7b2f Received: from mailhub-auth-3.mit.edu ( [18.9.21.43]) (using TLS with cipher AES256-SHA (256/256 bits)) (Client did not present a certificate) by dmz-mailsec-scanner-8.mit.edu (Symantec Messaging Gateway) with SMTP id B0.10.03321.F4AA1535; Fri, 18 Apr 2014 18:42:23 -0400 (EDT) Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11]) by mailhub-auth-3.mit.edu (8.13.8/8.9.2) with ESMTP id s3IMgCwU009368; Fri, 18 Apr 2014 18:42:13 -0400 Received: from drake.dyndns.org (26-4-172.dynamic.csail.mit.edu [18.26.4.172]) (authenticated bits=0) (User authenticated as amdragon@ATHENA.MIT.EDU) by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s3IMgAX5028746 (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT); Fri, 18 Apr 2014 18:42:12 -0400 Received: from amthrax by drake.dyndns.org with local (Exim 4.77) (envelope-from ) id 1WbHU2-0007bG-RL; Fri, 18 Apr 2014 18:42:10 -0400 From: Austin Clements To: notmuch@notmuchmail.org Subject: [PATCH v2 1/4] doc: Clarify notmuch show --format=raw description Date: Fri, 18 Apr 2014 18:42:05 -0400 Message-Id: <1397860928-29032-2-git-send-email-amdragon@mit.edu> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1397860928-29032-1-git-send-email-amdragon@mit.edu> References: <1397860928-29032-1-git-send-email-amdragon@mit.edu> X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFtrIIsWRmVeSWpSXmKPExsUixCmqreu/KjDYYM8jM4vrN2cyOzB6PFt1 izmAMYrLJiU1J7MstUjfLoEr48B5i4LjYhUbnj1nbGD8y9/FyMkhIWAi8X37BGYIW0ziwr31 bF2MXBxCArOZJI4f2MMM4WxklNh4cSkjhHOESWLv5laosrmMEj/+fgbrZxPQkNi2fzkjiC0i IC2x8+5s1i5GDg5mATWJP10qIGFhAS+J9qML2EFsFgFVibuNC8FaeQUcJJofr2KFOENO4uSx yWCtnAKOEte+CYGEhYBK+q8uZpzAyL+AkWEVo2xKbpVubmJmTnFqsm5xcmJeXmqRroVebmaJ XmpK6SZGUMiwu6juYJxwSOkQowAHoxIP74aAwGAh1sSy4srcQ4ySHExKoryPFgOF+JLyUyoz Eosz4otKc1KLDzFKcDArifBe7QLK8aYkVlalFuXDpKQ5WJTEed9aWwULCaQnlqRmp6YWpBbB ZGU4OJQkeN+uBGoULEpNT61Iy8wpQUgzcXCCDOcBGv50Bcjw4oLE3OLMdIj8KUZFKXHeEyDN AiCJjNI8uF5YTL9iFAd6RZi3BKSKB5gO4LpfAQ1mAhr890wAyOCSRISUVAPjYeM9U77nnCgJ TZOZ/o5b6tMzMzu/pwF3T7atuhCvrZ5RaPMkQOHd4VSbeZKr7nupSvZyVX1nc5r54f+Bf0Ws kn8fdjQnTzu9atPz7D2ukx6Yf7qw27uh/NNyiWSWPznMxvz1k5pOOajcnvxsZcK/jOgJP3df ZTwgvWM6x1H/FtWwK7vfBF51U2Ipzkg01GIuKk4EAEo27KfEAgAA X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 18 Apr 2014 22:42:48 -0000 In addition to being generally more precise, this is explicit that there is no charset conversion. --- doc/man1/notmuch-show.rst | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst index bad868b..c4518ec 100644 --- a/doc/man1/notmuch-show.rst +++ b/doc/man1/notmuch-show.rst @@ -76,22 +76,22 @@ Supported options for **show** include http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html - **raw** (default for a single part, see --part) - For a message or an attached message part, the original, raw - content of the email message is output. Consumers of this - format should expect to implement MIME decoding and similar - functions. - - For a single part (--part) the raw part content is output - after performing any necessary MIME decoding. Note that - messages with a simple body still have two parts: part 0 is - the whole message and part 1 is the body. - - For a multipart part, the part headers and body (including - all child parts) is output. - - The raw format must only be used with search terms matching - single message. + **raw** (default if --part is given) + Write the raw bytes of the given MIME part of a message to + standard out. For this format, it is an error to specify a + query that matches more than one message. + + If the specified part is a leaf part, this outputs the + body of the part after performing content transfer + decoding (but no charset conversion). This is suitable for + saving attachments, for example. + + For a multipart or message part, the output includes the + part headers as well as the body (including all child + parts). No decoding is performed because multipart and + message parts cannot have non-trivial content transfer + encoding. Consumers of this may need to implement MIME + decoding and similar functions. ``--format-version=N`` Use the specified structured output format version. This is @@ -105,6 +105,10 @@ Supported options for **show** include and are identified in the 'json', 'sexp' or 'text' output formats. + Note that even a message with no MIME structure or a single + body part still has two MIME parts: part 0 is the whole + message (headers and body) and part 1 is just the body. + ``--verify`` Compute and report the validity of any MIME cryptographic signatures found in the selected content (ie. "multipart/signed" -- 1.9.1