X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;ds=sidebyside;f=man%2Fman1%2Fnotmuch-search.1;h=321d77979555dc4cfd4dcaf3757cbe3ea3e6b615;hb=a12f810a00cf0779e9b62c400f7ccd7af9d3a113;hp=efb63a1cb7dc222c9e4f0c6ab640cfb7946b7e6b;hpb=c48797b498ba8dc46fb323a8a7f2cde4d41d3123;p=notmuch diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1 index efb63a1c..321d7797 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 2013-01-18 "Notmuch 0.15" .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 @@ -17,14 +17,28 @@ message in the thread, the number of matched messages and total messages in the thread, the names of all participants in the thread, and the subject of the newest (or oldest) message. +See \fBnotmuch-search-terms\fR(7) +for details of the supported syntax for . + Supported options for .B search include .RS 4 .TP 4 -.BR \-\-format= ( json | text ) +.BR \-\-format= ( json | sexp | text | text0 ) + +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 -Presents the results in either JSON or plain-text (default). +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 @@ -45,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 @@ -110,7 +129,33 @@ Limit the number of displayed results to N. .RE .RS 4 -See the -.B "SEARCH SYNTAX" -section below for details of the supported syntax for . +.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(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)