summaryrefslogtreecommitdiff
path: root/notmuch.1
diff options
context:
space:
mode:
authorScott Robinson <scott@quadhome.com>2009-12-31 11:17:40 -0400
committerCarl Worth <cworth@cworth.org>2010-02-23 12:01:12 -0800
commit6ce2bf68f53fec4302121763e588c33c7cd86a9c (patch)
tree97eed1a84956f582cc43efbb16419c43b930c242 /notmuch.1
parent3ca7a4fbcc9cd72330bce1b1670150af1e250006 (diff)
Add an "--format=(json|text)" command-line option to both notmuch-search and notmuch-show.
In the case of notmuch-show, "--format=json" also implies "--entire-thread" as the thread structure is implicit in the emitted document tree. As a coincidence to the implementation, multipart message ID numbers are now incremented with each part printed. This changes the previous semantics, which were unclear and not necessary related to the actual ordering of the message parts.
Diffstat (limited to 'notmuch.1')
-rw-r--r--notmuch.127
1 files changed, 26 insertions, 1 deletions
diff --git a/notmuch.1 b/notmuch.1
index 8b773e5..2df320d 100644
--- a/notmuch.1
+++ b/notmuch.1
@@ -146,6 +146,12 @@ Supported options for
include
.RS 4
.TP 4
+.BR \-\-format= ( json | text )
+
+Presents the results in either JSON or plain-text (default).
+.RE
+.RS 4
+.TP 4
.BR \-\-sort= ( newest\-first | oldest\-first )
This option can be used to present results in either chronological order
@@ -194,7 +200,14 @@ matched message will be displayed.
.RE
.RS 4
-The output format is plain-text, with all text-content MIME parts
+.TP 4
+.B \-\-format=(json|text)
+
+.RS 4
+.TP 4
+.B text
+
+The default plain-text format has text-content MIME parts
decoded. Various components in the output,
.RB ( message ", " header ", " body ", " attachment ", and MIME " part ),
will be delimited by easily-parsed markers. Each marker consists of a
@@ -202,6 +215,18 @@ Control-L character (ASCII decimal 12), the name of the marker, and
then either an opening or closing brace, ('{' or '}'), to either open
or close the component.
+.RE
+.RS 4
+.TP 4
+.B json
+
+Format output as Javascript Object Notation (JSON). JSON output always
+includes all messages in a matching thread; in effect
+.B \-\-format=json
+implies
+.B \-\-entire\-thread
+
+.RE
A common use of
.B notmuch show
is to display a single thread of email messages. For this, use a