From: Austin Clements Date: Fri, 18 Apr 2014 22:42:08 +0000 (+2000) Subject: [PATCH v2 4/4] doc: Simplify and clarify notmuch show --format=sexp description X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=e6b782ba8cd6835b8a0bb6236c289d266f15b3db;p=notmuch-archives.git [PATCH v2 4/4] doc: Simplify and clarify notmuch show --format=sexp description --- diff --git a/19/55b9f2675f7c082f98057f9bc2b1966ed923bb b/19/55b9f2675f7c082f98057f9bc2b1966ed923bb new file mode 100644 index 000000000..3b549cddc --- /dev/null +++ b/19/55b9f2675f7c082f98057f9bc2b1966ed923bb @@ -0,0 +1,111 @@ +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 1EEE4431FAF + for ; Fri, 18 Apr 2014 15:42:54 -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 laosfe6yTfQy for ; + Fri, 18 Apr 2014 15:42:47 -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 14AAE431FC0 + for ; Fri, 18 Apr 2014 15:42:24 -0700 (PDT) +X-AuditID: 1209190e-f79ee6d000000c40-56-5351aa502363 +Received: from mailhub-auth-1.mit.edu ( [18.9.21.35]) + (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 BB.71.03136.05AA1535; Fri, 18 Apr 2014 18:42:24 -0400 (EDT) +Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11]) + by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id s3IMgDDb007080; + 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 s3IMgBLX028753 + (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT); + Fri, 18 Apr 2014 18:42:13 -0400 +Received: from amthrax by drake.dyndns.org with local (Exim 4.77) + (envelope-from ) + id 1WbHU2-0007bN-TB; Fri, 18 Apr 2014 18:42:10 -0400 +From: Austin Clements +To: notmuch@notmuchmail.org +Subject: [PATCH v2 4/4] doc: Simplify and clarify notmuch show --format=sexp + description +Date: Fri, 18 Apr 2014 18:42:08 -0400 +Message-Id: <1397860928-29032-5-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+NgFlrPIsWRmVeSWpSXmKPExsUixCmqrBuwKjDY4ONUPovrN2cyOzB6PFt1 + izmAMYrLJiU1J7MstUjfLoEr49rmc+wFp3gqnvUXNTD2c3YxcnJICJhINB7rZ4OwxSQu3FsP + ZHNxCAnMZpK4dfEyK4SzkVFi+e8mZpAqIYEjTBLLX6VCJOYySjTcP88IkmAT0JDYtn85mC0i + IC2x8+5soG4ODmYBNYk/XSogprBAhMT9pYkgFSwCqhKnph4Bq+YVcJA4N+8KC8QRchInj00G + 6+QUcJS49k0IYquDRP/VxYwTGPkXMDKsYpRNya3SzU3MzClOTdYtTk7My0st0jXWy80s0UtN + Kd3ECA4XSb4djF8PKh1iFOBgVOLh3RAQGCzEmlhWXJl7iFGSg0lJlPfRYqAQX1J+SmVGYnFG + fFFpTmrxIUYJDmYlEd6rXUA53pTEyqrUonyYlDQHi5I471trq2AhgfTEktTs1NSC1CKYrAwH + h5IEb/ZKoEbBotT01Iq0zJwShDQTByfIcB6g4U9XgAwvLkjMLc5Mh8ifYlSUEuetAEkIgCQy + SvPgemHx/IpRHOgVYd4SkBU8wFQA1/0KaDAT0OC/ZwJABpckIqSkGhiX/zp/M3GS/J5W8cUV + J2u/z2fnWHIm9tpyh28bv4Zee3vdp6dP+XpGlplEwBTLs4c2T+q6ktzRe2Kj4o6eAuY5s891 + F15JbLLI43kxl6Mq2eqU7LfLzOnGjGL+HNNlprDNziySO+Z2KpJxyZ07a3b8TRBj3X/COlx6 + a8aqKfbfwqJ5BFe2OUsrsRRnJBpqMRcVJwIAJ/Of68ICAAA= +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:54 -0000 + +Previously, this was a verbatim copy of the --format=json text. +Change it to instead reference the JSON text and actually describe how +the S-expression format works. +--- + doc/man1/notmuch-show.rst | 14 ++++++-------- + 1 file changed, 6 insertions(+), 8 deletions(-) + +diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst +index 78196ee..5aecbfd 100644 +--- a/doc/man1/notmuch-show.rst ++++ b/doc/man1/notmuch-show.rst +@@ -57,14 +57,12 @@ Supported options for **show** include + UTF-8. + + **sexp** +- The output is formatted as an S-Expression (sexp). This +- format is more robust than the text format for automated +- processing. The nested structure of multipart MIME messages +- is reflected in nested S-Expression output. By default, +- S-Expression output includes all messages in a matching +- thread; that is, by default, +- ``--format=sexp`` sets ``--entire-thread``. The caller can +- disable this behaviour by setting ``--entire-thread=false``. ++ The output is formatted as the Lisp s-expression (sexp) ++ equivalent of the JSON format above. Objects are formatted ++ as property lists whose keys are keywords (symbols preceded ++ by a colon). True is formatted as ``t`` and both false and ++ null are formatted as ``nil``. As for JSON, the s-expression ++ output is always encoded as UTF-8. + + **mbox** + All matching messages are output in the traditional, Unix +-- +1.9.1 +