Merge branch 'release'
[notmuch] / man / man1 / notmuch-search.1
1 .TH NOTMUCH-SEARCH 1 2012-02-29 "Notmuch 0.12~rc1"
2 .SH NAME
3 notmuch-search \- Search for messages matching the given search terms.
4 .SH SYNOPSIS
5
6 .B notmuch search
7 .RI  [  options "...] <" search-term ">..."
8
9 .SH DESCRIPTION
10
11 Search for messages matching the given search terms, and display as
12 results the threads containing the matched messages.
13
14 The output consists of one line per thread, giving a thread ID, the
15 date of the newest (or oldest, depending on the sort option) matched
16 message in the thread, the number of matched messages and total
17 messages in the thread, the names of all participants in the thread,
18 and the subject of the newest (or oldest) message.
19
20 See \fBnotmuch-search-terms\fR(7)
21 for details of the supported syntax for <search-terms>.
22
23 Supported options for
24 .B search
25 include
26 .RS 4
27 .TP 4
28 .BR \-\-format= ( json | text )
29
30 Presents the results in either JSON or plain-text (default).
31 .RE
32
33 .RS 4
34 .TP 4
35 .B \-\-output=(summary|threads|messages|files|tags)
36
37 .RS 4
38 .TP 4
39 .B summary
40
41 Output a summary of each thread with any message matching the search
42 terms. The summary includes the thread ID, date, the number of
43 messages in the thread (both the number matched and the total number),
44 the authors of the thread and the subject.
45 .RE
46 .RS 4
47 .TP 4
48 .B threads
49
50 Output the thread IDs of all threads with any message matching the
51 search terms, either one per line (\-\-format=text) or as a JSON array
52 (\-\-format=json).
53 .RE
54 .RS 4
55 .TP 4
56 .B messages
57
58 Output the message IDs of all messages matching the search terms,
59 either one per line (\-\-format=text) or as a JSON array
60 (\-\-format=json).
61 .RE
62 .RS 4
63 .TP 4
64 .B files
65
66 Output the filenames of all messages matching the search terms, either
67 one per line (\-\-format=text) or as a JSON array (\-\-format=json).
68 .RE
69 .RS 4
70 .TP 4
71 .B tags
72
73 Output all tags that appear on any message matching the search terms,
74 either one per line (\-\-format=text) or as a JSON array
75 (\-\-format=json).
76 .RE
77 .RE
78
79 .RS 4
80 .TP 4
81 .BR \-\-sort= ( newest\-first | oldest\-first )
82
83 This option can be used to present results in either chronological order
84 .RB ( oldest\-first )
85 or reverse chronological order
86 .RB ( newest\-first ).
87
88 Note: The thread order will be distinct between these two options
89 (beyond being simply reversed). When sorting by
90 .B oldest\-first
91 the threads will be sorted by the oldest message in each thread, but
92 when sorting by
93 .B newest\-first
94 the threads will be sorted by the newest message in each thread.
95
96 By default, results will be displayed in reverse chronological order,
97 (that is, the newest results will be displayed first).
98 .RE
99
100 .RS 4
101 .TP 4
102 .BR \-\-offset=[\-]N
103
104 Skip displaying the first N results. With the leading '\-', start at the Nth
105 result from the end.
106 .RE
107
108 .RS 4
109 .TP 4
110 .BR \-\-limit=N
111
112 Limit the number of displayed results to N.
113 .RE
114
115 .RS 4
116 .TP 4
117 .BR \-\-no\-exclude
118
119 Do not exclude the messages matching search.exclude_tags in the config file.
120 .RE
121
122 .SH SEE ALSO
123
124 \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
125 \fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1),
126 \fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
127 \fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
128 \fBnotmuch-tag\fR(1)