From: Austin Clements Date: Fri, 18 Apr 2014 15:18:52 +0000 (+2000) Subject: [PATCH 4/4] doc: Simplify and clarify notmuch show --format=sexp description X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=2baa341b0a13f0c172dbccfd39858f65788d840c;p=notmuch-archives.git [PATCH 4/4] doc: Simplify and clarify notmuch show --format=sexp description --- diff --git a/3f/5dc836338ac25480d4bf0b567a0fa88ec699d2 b/3f/5dc836338ac25480d4bf0b567a0fa88ec699d2 new file mode 100644 index 000000000..808b29c2d --- /dev/null +++ b/3f/5dc836338ac25480d4bf0b567a0fa88ec699d2 @@ -0,0 +1,112 @@ +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 8567C431FC0 + for ; Fri, 18 Apr 2014 08:19:20 -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 1V4O6WXJCCR4 for ; + Fri, 18 Apr 2014 08:19:15 -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 30507431FB6 + for ; Fri, 18 Apr 2014 08:19:11 -0700 (PDT) +X-AuditID: 1209190e-f79ee6d000000c40-64-5351426ef994 +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 F2.69.03136.E6241535; Fri, 18 Apr 2014 11:19:10 -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 s3IFIxmT021240; + 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 s3IFIvCp027513 + (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-0006bB-3e; Fri, 18 Apr 2014 11:18:57 -0400 +From: Austin Clements +To: notmuch@notmuchmail.org +Subject: [PATCH 4/4] doc: Simplify and clarify notmuch show --format=sexp + description +Date: Fri, 18 Apr 2014 11:18:52 -0400 +Message-Id: <1397834332-25175-5-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+NgFtrIIsWRmVeSWpSXmKPExsUixCmqrZvnFBhsMPu9pcX1mzOZHRg9nq26 + xRzAGMVlk5Kak1mWWqRvl8CV8WxGF3vBKZ6KZxNWsTUw9nN2MXJwSAiYSJx5aNbFyAlkiklc + uLeerYuRi0NIYDaTxO3fV5khnI2MEv/6+lghnDtMEv2/LzFBOHMZJZbuvsUO0s8moCGxbf9y + RhBbREBaYufd2awgK5gF1CT+dKmAmMICoRIPblaDVLAIqEosbP/PDGLzCjhIrJ39khniCjmJ + k8cms4LYnAKOEi+Xt7CA2EJANc9fnWWawMi/gJFhFaNsSm6Vbm5iZk5xarJucXJiXl5qka6x + Xm5miV5qSukmRnDISPLtYPx6UOkQowAHoxIPbyRzYLAQa2JZcWXuIUZJDiYlUd4KG6AQX1J+ + SmVGYnFGfFFpTmrxIUYJDmYlEd7dfwOChXhTEiurUovyYVLSHCxK4rxvra2ChQTSE0tSs1NT + C1KLYLIyHBxKErzVjkBDBYtS01Mr0jJzShDSTBycIMN5gIYngNTwFhck5hZnpkPkTzEqSonz + 5jkAJQRAEhmleXC9sJh+xSgO9Iow73SQdh5gOoDrfgU0mAlo8N8zIFcXlyQipKQaGDe9jBWN + +q5XVmm5+1Xs0oNq75++VeJX8XBZcH5vxFVGvoYXAZLi26d4z+0pOdBYyt68wuH4T84HzAFJ + 0RWqBqVKKranxTwnacnrvdlfHqwYrn/vTpmd45NdwZIyV9m1blQenz8l2u1PUPG8p7ouLx+0 + JixkfL7yWDgHw8s8o517kkPiV7VsU2Ipzkg01GIuKk4EAIR0HXnEAgAA +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:20 -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 b8b10b9..586dbc5 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 +