X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=man%2Fman1%2Fnotmuch-search.1;h=5c771fa6e8da8a1a952aad2665dc4133ab99641b;hb=3152cf4b127ebb0798af568a20db8f1b791cd31b;hp=0bc3f40dd47004574c934026ae9abdab1ecefe60;hpb=7c5695b439d89d69d5f6d6a88cdcf964d7a98fbe;p=obsolete%2Fnotmuch-old diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1 index 0bc3f40d..5c771fa6 100644 --- a/man/man1/notmuch-search.1 +++ b/man/man1/notmuch-search.1 @@ -1,6 +1,6 @@ -.TH NOTMUCH-SEARCH 1 2011-12-04 "Notmuch 0.10.2" +.TH NOTMUCH-SEARCH 1 2012-08-20 "Notmuch 0.14" .SH NAME -notmuch-search \- Search for messages matching the given search terms. +notmuch-search \- search for messages matching the given search terms .SH SYNOPSIS .B notmuch search @@ -25,9 +25,18 @@ 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 +.TP 4 +.BR \-\-format-version=N + +Use the specified structured output format version. This is intended +for programs that invoke \fBnotmuch\fR(1) internally. If omitted, the +latest supported version will be used. .RE .RS 4 @@ -49,7 +58,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 +66,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 @@ -112,10 +122,34 @@ result from the end. Limit the number of displayed results to N. .RE +.RS 4 +.TP 4 +.BR \-\-exclude=(true|false|flag) + +Specify whether to omit messages matching search.tag_exclude from the +search results (the default) or not. The extra option +.B flag +only has an effect when +.B --output=summary +In this case all matching threads are returned but the "match count" +is the number of matching non-excluded messages in the thread. +.RE + +.SH EXIT STATUS + +This command supports the following special exit status codes + +.TP +.B 20 +The requested format version is too old. +.TP +.B 21 +The requested format version is too new. + .SH SEE ALSO \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), -\fBnotmuch-dump\fR(5), \fBnotmuch-hooks\fR(5), \fBnotmuch-part\fR(1), -\fBnotmuch-reply\fR(1), \fBnotmuch-reply\fR(1), -\fBnotmuch-restore\fR(1), \fBnotmuch-search-terms\fR(7), -\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1) +\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), +\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), +\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1), +\fBnotmuch-tag\fR(1)