Updating man pages for new S-Expression output format.

Add sections about the new S-Expression output format (--format=sexp) to
the notmuch-search, notmuch-reply and notmuch-show man pages.
This commit is contained in:
Peter Feigl 2012-12-06 22:12:15 +01:00 committed by David Bremner
parent 76271e098c
commit 9a989772cb
3 changed files with 46 additions and 19 deletions

View file

@ -37,7 +37,7 @@ Supported options for
include include
.RS .RS
.TP 4 .TP 4
.BR \-\-format= ( default | json | headers\-only ) .BR \-\-format= ( default | json | sexp | headers\-only )
.RS .RS
.TP 4 .TP 4
.BR default .BR default
@ -48,6 +48,11 @@ Produces JSON output containing headers for a reply message and the
contents of the original message. This output can be used by a client contents of the original message. This output can be used by a client
to create a reply message intelligently. to create a reply message intelligently.
.TP .TP
.BR sexp
Produces S-Expression output containing headers for a reply message and
the contents of the original message. This output can be used by a client
to create a reply message intelligently.
.TP
.BR headers\-only .BR headers\-only
Only produces In\-Reply\-To, References, To, Cc, and Bcc headers. Only produces In\-Reply\-To, References, To, Cc, and Bcc headers.
.RE .RE
@ -74,8 +79,8 @@ user's addresses.
Decrypt any MIME encrypted parts found in the selected content Decrypt any MIME encrypted parts found in the selected content
(ie. "multipart/encrypted" parts). Status of the decryption will be (ie. "multipart/encrypted" parts). Status of the decryption will be
reported (currently only supported with --format=json) and the reported (currently only supported with --format=json and --format=sexp)
multipart/encrypted part will be replaced by the decrypted and the multipart/encrypted part will be replaced by the decrypted
content. content.
.RE .RE
@ -89,7 +94,8 @@ id:<message-id>), but it can be useful to reply to several messages at
once. For example, when a series of patches are sent in a single once. For example, when a series of patches are sent in a single
thread, replying to the entire thread allows for the reply to comment thread, replying to the entire thread allows for the reply to comment
on issues found in multiple patches. The default format supports on issues found in multiple patches. The default format supports
replying to multiple messages at once, but the JSON format does not. replying to multiple messages at once, but the JSON and S-Expression
formats do not.
.RE .RE
.RE .RE

View file

@ -25,9 +25,9 @@ Supported options for
include include
.RS 4 .RS 4
.TP 4 .TP 4
.BR \-\-format= ( json | text ) .BR \-\-format= ( json | sexp | text )
Presents the results in either JSON or plain-text (default). Presents the results in either JSON, S-Expressions or plain-text (default).
.RE .RE
.RS 4 .RS 4
@ -49,7 +49,7 @@ the authors of the thread and the subject.
Output the thread IDs of all threads with any message matching the Output the thread IDs of all threads with any message matching the
search terms, either one per line (\-\-format=text) or as a JSON array search terms, either one per line (\-\-format=text) or as a JSON array
(\-\-format=json). (\-\-format=json) or an S-Expression list (\-\-format=sexp).
.RE .RE
.RS 4 .RS 4
.TP 4 .TP 4
@ -57,22 +57,23 @@ search terms, either one per line (\-\-format=text) or as a JSON array
Output the message IDs of all messages matching the search terms, Output the message IDs of all messages matching the search terms,
either one per line (\-\-format=text) or as a JSON array either one per line (\-\-format=text) or as a JSON array
(\-\-format=json). (\-\-format=json) or as an S-Expression list (\-\-format=sexp).
.RE .RE
.RS 4 .RS 4
.TP 4 .TP 4
.B files .B files
Output the filenames of all messages matching the search terms, either Output the filenames of all messages matching the search terms, either
one per line (\-\-format=text) or as a JSON array (\-\-format=json). one per line (\-\-format=text) or as a JSON array (\-\-format=json) or
as an S-Expression list (\-\-format=sexp).
.RE .RE
.RS 4 .RS 4
.TP 4 .TP 4
.B tags .B tags
Output all tags that appear on any message matching the search terms, Output all tags that appear on any message matching the search terms,
either one per line (\-\-format=text) or as a JSON array either one per line (\-\-format=text) or as a JSON array (\-\-format=json)
(\-\-format=json). or as an S-Expression list (\-\-format=sexp).
.RE .RE
.RE .RE

View file

@ -31,12 +31,14 @@ If true,
outputs all messages in the thread of any message matching the search outputs all messages in the thread of any message matching the search
terms; if false, it outputs only the matching messages. For terms; if false, it outputs only the matching messages. For
.B --format=json .B --format=json
and
.B --format=sexp
this defaults to true. For other formats, this defaults to false. this defaults to true. For other formats, this defaults to false.
.RE .RE
.RS 4 .RS 4
.TP 4 .TP 4
.B \-\-format=(text|json|mbox|raw) .B \-\-format=(text|json|sexp|mbox|raw)
.RS 4 .RS 4
.TP 4 .TP 4
@ -60,11 +62,29 @@ format is more robust than the text format for automated
processing. The nested structure of multipart MIME messages is processing. The nested structure of multipart MIME messages is
reflected in nested JSON output. By default JSON output includes all reflected in nested JSON output. By default JSON output includes all
messages in a matching thread; that is, by default, messages in a matching thread; that is, by default,
.B \-\-format=json .B \-\-format=json
sets sets
.B "\-\-entire\-thread" .B "\-\-entire\-thread"
The caller can disable this behaviour by setting The caller can disable this behaviour by setting
.B \-\-entire\-thread=false .B \-\-entire\-thread=false
.RE
.RS 4
.TP 4
.B 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,
.B \-\-format=sexp
sets
.B "\-\-entire\-thread"
The caller can disable this behaviour by setting
.B \-\-entire\-thread=false
.RE .RE
.RS 4 .RS 4
@ -113,7 +133,7 @@ message.
Output the single decoded MIME part N of a single message. The search Output the single decoded MIME part N of a single message. The search
terms must match only a single message. Message parts are numbered in terms must match only a single message. Message parts are numbered in
a depth-first walk of the message MIME structure, and are identified a depth-first walk of the message MIME structure, and are identified
in the 'json' or 'text' output formats. in the 'json', 'sexp' or 'text' output formats.
.RE .RE
.RS 4 .RS 4
@ -123,8 +143,8 @@ in the 'json' or 'text' output formats.
Compute and report the validity of any MIME cryptographic signatures Compute and report the validity of any MIME cryptographic signatures
found in the selected content (ie. "multipart/signed" parts). Status found in the selected content (ie. "multipart/signed" parts). Status
of the signature will be reported (currently only supported with of the signature will be reported (currently only supported with
--format=json), and the multipart/signed part will be replaced by the --format=json and --format=sexp), and the multipart/signed part
signed data. will be replaced by the signed data.
.RE .RE
.RS 4 .RS 4
@ -133,9 +153,9 @@ signed data.
Decrypt any MIME encrypted parts found in the selected content Decrypt any MIME encrypted parts found in the selected content
(ie. "multipart/encrypted" parts). Status of the decryption will be (ie. "multipart/encrypted" parts). Status of the decryption will be
reported (currently only supported with --format=json) and the reported (currently only supported with --format=json and
multipart/encrypted part will be replaced by the decrypted --format=sexp) and the multipart/encrypted part will be replaced
content. Implies --verify. by the decrypted content. Implies --verify.
.RE .RE
.RS 4 .RS 4
@ -166,7 +186,7 @@ If true (the default)
includes the bodies of the messages in the output; if false, includes the bodies of the messages in the output; if false,
bodies are omitted. bodies are omitted.
.B --body=false .B --body=false
is only implemented for the json format and it is incompatible with is only implemented for the json and sexp formats and it is incompatible with
.B --part > 0. .B --part > 0.
This is useful if the caller only needs the headers as body-less This is useful if the caller only needs the headers as body-less