doc: Simplify and clarify notmuch show --format=sexp description
authorAustin Clements <amdragon@MIT.EDU>
Fri, 18 Apr 2014 22:42:08 +0000 (18:42 -0400)
committerDavid Bremner <david@tethera.net>
Mon, 21 Apr 2014 12:51:54 +0000 (21:51 +0900)
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

index 78196eeadcd02afc4246b7b69f41e03ffc59e09f..5aecbfd7d041849545d38789dc24a3c7ebc355b3 100644 (file)
@@ -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