From: Austin Clements Date: Fri, 18 Apr 2014 15:18:49 +0000 (+2000) Subject: [PATCH 1/4] doc: Clarify notmuch show --format=raw description X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=18f09dd9d246b4e4b2d462eacc5e6fadd3da014c;p=notmuch-archives.git [PATCH 1/4] doc: Clarify notmuch show --format=raw description --- diff --git a/5a/44a247fad688eb7a487655c1856c5de3dfa7b3 b/5a/44a247fad688eb7a487655c1856c5de3dfa7b3 new file mode 100644 index 000000000..d7c2a6253 --- /dev/null +++ b/5a/44a247fad688eb7a487655c1856c5de3dfa7b3 @@ -0,0 +1,132 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 1F526431FC0 + for ; Fri, 18 Apr 2014 08:19:19 -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 ksrCFn-bMwz3 for ; + Fri, 18 Apr 2014 08:19:11 -0700 (PDT) +Received: from dmz-mailsec-scanner-3.mit.edu (dmz-mailsec-scanner-3.mit.edu + [18.9.25.14]) + (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id E3647431FBF + for ; Fri, 18 Apr 2014 08:19:06 -0700 (PDT) +X-AuditID: 1209190e-f79ee6d000000c40-41-535142655227 +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-3.mit.edu (Symantec Messaging Gateway) with SMTP + id 8F.59.03136.66241535; Fri, 18 Apr 2014 11:19:02 -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 s3IFIxhB021239; + Fri, 18 Apr 2014 11:18:59 -0400 +Received: from drake.dyndns.org + (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com + [216.15.114.40]) (authenticated bits=0) + (User authenticated as amdragon@ATHENA.MIT.EDU) + by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s3IFIv3i027506 + (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT); + Fri, 18 Apr 2014 11:18:58 -0400 +Received: from amthrax by drake.dyndns.org with local (Exim 4.77) + (envelope-from ) + id 1WbAZ7-0006b4-1L; Fri, 18 Apr 2014 11:18:57 -0400 +From: Austin Clements +To: notmuch@notmuchmail.org +Subject: [PATCH 1/4] doc: Clarify notmuch show --format=raw description +Date: Fri, 18 Apr 2014 11:18:49 -0400 +Message-Id: <1397834332-25175-2-git-send-email-amdragon@mit.edu> +X-Mailer: git-send-email 1.9.1 +In-Reply-To: <1397834332-25175-1-git-send-email-amdragon@mit.edu> +References: <1397834332-25175-1-git-send-email-amdragon@mit.edu> +X-Brightmail-Tracker: + H4sIAAAAAAAAA+NgFtrEIsWRmVeSWpSXmKPExsUixCmqrZvmFBhs8G0ls8X1mzOZHRg9nq26 + xRzAGMVlk5Kak1mWWqRvl8CVcfvDcaaCN8IVF/u+MjYwfuPtYuTgkBAwkXjxoriLkRPIFJO4 + cG89WxcjF4eQwGwmiY0PGtghnI2MEtPe/WaFcO4wSXyZdAbKmcsosfHYNxaQfjYBDYlt+5cz + gtgiAtISO+/OZgVZwSygJvGnSwUkLCzgLrH3BkgvJweLgKrE1FnXwGxeAQeJWT/Ps0OcISdx + 8thksDingKPEy+UtYOOFgGqevzrLNIGRfwEjwypG2ZTcKt3cxMyc4tRk3eLkxLy81CJdY73c + zBK91JTSTYzgoJHk28H49aDSIUYBDkYlHt5I5sBgIdbEsuLK3EOMkhxMSqK8FTZAIb6k/JTK + jMTijPii0pzU4kOMEhzMSiK8u/8GBAvxpiRWVqUW5cOkpDlYlMR531pbBQsJpCeWpGanphak + FsFkZTg4lCR4qx2BhgoWpaanVqRl5pQgpJk4OEGG8wANTwCp4S0uSMwtzkyHyJ9iVJQS581z + AEoIgCQySvPgemFR/YpRHOgVYd7pIO08wIQA1/0KaDAT0OC/Z0CuLi5JREhJNTC6L/p1LjZh + RotMu00J10Ym6/8zitbqfehVmthw5VH/Cy9F3u9h+f8v7ZMXlDi0pPkUs1Ot6URW7wuF4Sue + WNz9dW/u+92PODcsnaL/r8y506DaOMyN0aZDzEXtc3O69pQ8u/bE0zMXqm/8zLLgGV9t6fc3 + qqxmlgapvLLPzc8ySW6Om33WOk2JpTgj0VCLuag4EQCcx+qBxQIAAA== +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 15:19:19 -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..2c0f64c 100644 +--- a/doc/man1/notmuch-show.rst ++++ b/doc/man1/notmuch-show.rst +@@ -76,22 +76,26 @@ 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. ++ ++ Note that even a message with a simple body has two parts: ++ part 0 is the whole message and part 1 is the body of the ++ message. + + ``--format-version=N`` + Use the specified structured output format version. This is +-- +1.9.1 +