aboutsummaryrefslogtreecommitdiffhomepage
path: root/man/man1/notmuch-search.1
diff options
context:
space:
mode:
authorGravatar Peter Feigl <craven@gmx.net>2012-12-06 22:12:15 +0100
committerGravatar David Bremner <bremner@debian.org>2012-12-08 09:30:57 -0400
commit9a989772cbf7d5699210adb0b9dd3b42c4bd49de (patch)
tree950aa7226aede01f911f4033ce8245af0e717c5c /man/man1/notmuch-search.1
parent76271e098c6f2b3cc0958bd9996aa7bb9c753f34 (diff)
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.
Diffstat (limited to 'man/man1/notmuch-search.1')
-rw-r--r--man/man1/notmuch-search.115
1 files changed, 8 insertions, 7 deletions
diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1
index 6ccd3b8e..0aff3487 100644
--- a/man/man1/notmuch-search.1
+++ b/man/man1/notmuch-search.1
@@ -25,9 +25,9 @@ Supported options for
include
.RS 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
.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
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
.RS 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,
either one per line (\-\-format=text) or as a JSON array
-(\-\-format=json).
+(\-\-format=json) or as an S-Expression list (\-\-format=sexp).
.RE
.RS 4
.TP 4
.B files
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
.RS 4
.TP 4
.B tags
Output all tags that appear on any message matching the search terms,
-either one per line (\-\-format=text) or as a JSON array
-(\-\-format=json).
+either one per line (\-\-format=text) or as a JSON array (\-\-format=json)
+or as an S-Expression list (\-\-format=sexp).
.RE
.RE