X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=man%2Fman1%2Fnotmuch-search.1;h=acd8863a6bc4c11d00236db48e39c4f32a0446f9;hp=1b0c415f07352cc25b1a83a57048f30385d8ba86;hb=d273ed6cf1bdaa2d644cec4909cbf415ff4d257b;hpb=fc4e5248d29cf7264481cbff82343eade5fcc2ca diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1 index 1b0c415f..acd8863a 100644 --- a/man/man1/notmuch-search.1 +++ b/man/man1/notmuch-search.1 @@ -1,6 +1,6 @@ -.TH NOTMUCH-SEARCH 1 2012-03-18 "Notmuch 0.12~rc2" +.TH NOTMUCH-SEARCH 1 2013-01-24 "Notmuch 0.15.1" .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,20 @@ Supported options for include .RS 4 .TP 4 -.BR \-\-format= ( json | text ) +.BR \-\-format= ( json | sexp | text | text0 ) -Presents the results in either JSON or plain-text (default). +Presents the results in either JSON, S-Expressions, newline character +separated plain-text (default), or null character separated plain-text +(compatible with \fBxargs\fR(1) -0 option where available). +.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 @@ -48,31 +59,36 @@ the authors of the thread and the subject. .B threads 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). +search terms, either one per line (\-\-format=text), separated by null +characters (\-\-format=text0), as a JSON array (\-\-format=json), or +an S-Expression list (\-\-format=sexp). .RE .RS 4 .TP 4 .B messages Output the message IDs of all messages matching the search terms, -either one per line (\-\-format=text) or as a JSON array -(\-\-format=json). +either one per line (\-\-format=text), separated by null characters +(\-\-format=text0), as a JSON array (\-\-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), separated by null characters +(\-\-format=text0), 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), separated by null characters +(\-\-format=text0), as a JSON array (\-\-format=json), or as an +S-Expression list (\-\-format=sexp). .RE .RE @@ -114,11 +130,28 @@ Limit the number of displayed results to N. .RS 4 .TP 4 -.BR \-\-no\-exclude - -Do not exclude the messages matching search.exclude_tags in the config file. +.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),