debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-24 20:08:10 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Simplify and clarify notmuch show --format=sexp description

Browse source 
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.
This commit is contained in:
Austin Clements 2014-04-18 18:42:08 -04:00 committed by David Bremner
parent a39a69ca0f
commit 827a69f639
1 changed files with 6 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/man1/notmuch-show.rst
View 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