282ad9896bc6a64004f0c4b16fed2e15ba00b48a
[notmuch] / notmuch.1
1 .\" notmuch - Not much of an email program, (just index, search and tagging)
2 .\"
3 .\" Copyright © 2009 Carl Worth
4 .\"
5 .\" Notmuch is free software: you can redistribute it and/or modify
6 .\" it under the terms of the GNU General Public License as published by
7 .\" the Free Software Foundation, either version 3 of the License, or
8 .\" (at your option) any later version.
9 .\"
10 .\" Notmuch is distributed in the hope that it will be useful,
11 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 .\" GNU General Public License for more details.
14 .\"
15 .\" You should have received a copy of the GNU General Public License
16 .\" along with this program.  If not, see http://www.gnu.org/licenses/ .
17 .\"
18 .\" Author: Carl Worth <cworth@cworth.org>
19 .TH NOTMUCH 1 2009-10-31 "Notmuch 0.1"
20 .SH NAME
21 notmuch \- thread-based email index, search, and tagging
22 .SH SYNOPSIS
23 .B notmuch
24 .IR command " [" args " ...]"
25 .SH DESCRIPTION
26 Notmuch is a command-line based program for indexing, searching,
27 reading, and tagging large collections of email messages.
28
29 The quickest way to get started with Notmuch is to simply invoke the
30 .B notmuch
31 command with no arguments, which will interactively guide you through
32 the process of indexing your mail.
33 .SH NOTE
34 While the command-line program
35 .B notmuch
36 provides powerful functionality, it does not provide the most
37 convenient interface for that functionality. More sophisticated
38 interfaces are expected to be built on top of either the command-line
39 interface, or more likely, on top of the notmuch library
40 interface. See http://notmuchmail.org for more about alternate
41 interfaces to notmuch.
42 .SH COMMANDS
43 The
44 .BR setup
45 command is used to configure Notmuch for first use, (or to reconfigure
46 it later).
47 .RS 4
48 .TP 4
49 .B setup
50
51 Interactively sets up notmuch for first use.
52
53 The setup command will prompt for your full name, your primary email
54 address, any alternate email addresses you use, and the directory
55 containing your email archives. Your answers will be written to a
56 configuration file in ${NOTMUCH_CONFIG} (if set) or
57 ${HOME}/.notmuch-config . This configuration file will be created with
58 descriptive comments, making it easy to edit by hand later to change the
59 configuration. Or you can run
60 .B "notmuch setup"
61 again to change the configuration.
62
63 The mail directory you specify can contain any number of
64 sub-directories and should primarily contain only files with individual
65 email messages (eg. maildir or mh archives are perfect). If there are
66 other, non-email files (such as indexes maintained by other email
67 programs) then notmuch will do its best to detect those and ignore
68 them.
69
70 Mail storage that uses mbox format, (where one mbox file contains many
71 messages), will not work with notmuch. If that's how your mail is
72 currently stored, it is recommended you first convert it to maildir
73 format with a utility such as mb2md before running
74 .B "notmuch setup" .
75
76 Invoking
77 .B notmuch
78 with no command argument will run
79 .B setup
80 if the setup command has not previously been completed.
81 .RE
82
83 The
84 .B new
85 command is used to incorporate new mail into the notmuch database.
86 .RS 4
87 .TP 4
88 .B new
89
90 Find and import any new messages to the database.
91
92 The
93 .B new
94 command scans all sub-directories of the database, performing
95 full-text indexing on new messages that are found. Each new message
96 will automatically be tagged with both the
97 .BR inbox " and " unread
98 tags.
99
100 You should run
101 .B "notmuch new"
102 once after first running
103 .B "notmuch setup"
104 to create the initial database. The first run may take a long time if
105 you have a significant amount of mail (several hundred thousand
106 messages or more). Subsequently, you should run
107 .B "notmuch new"
108 whenever new mail is delivered and you wish to incorporate it into the
109 database. These subsequent runs will be much quicker than the initial
110 run.
111
112 Invoking
113 .B notmuch
114 with no command argument will run
115 .B new
116 if
117 .B "notmuch setup"
118 has previously been completed, but
119 .B "notmuch new"
120 has not previously been run.
121 .RE
122
123 Several of the notmuch commands accept search terms with a common
124 syntax. See the
125 .B "SEARCH SYNTAX"
126 section below for more details on the supported syntax.
127
128 The
129 .BR search " and "show
130 commands are used to query the email database.
131 .RS 4
132 .TP 4
133 .BR search " [options...] <search-term>..."
134
135 Search for messages matching the given search terms, and display as
136 results the threads containing the matched messages.
137
138 The output consists of one line per thread, giving a thread ID, the
139 date of the newest (or oldest, depending on the sort option) matched
140 message in the thread, the number of matched messages and total
141 messages in the thread, the names of all participants in the thread,
142 and the subject of the newest (or oldest) message.
143
144 Supported options for
145 .B search
146 include
147 .RS 4
148 .TP 4
149 .BR \-\-sort= ( newest\-first | oldest\-first )
150
151 This option can be used to present results in either chronological order
152 .RB ( oldest\-first )
153 or reverse chronological order
154 .RB ( newest\-first ).
155
156 Note: The thread order will be distinct between these two options
157 (beyond being simply reversed). When sorting by
158 .B oldest\-first
159 the threads will be sorted by the oldest message in each thread, but
160 when sorting by
161 .B newest\-first
162 the threads will be sorted by the newest message in each thread.
163
164 .RE
165 .RS 4
166 By default, results will be displayed in reverse chronological order,
167 (that is, the newest results will be displayed first).
168
169 See the
170 .B "SEARCH SYNTAX"
171 section below for details of the supported syntax for <search-terms>.
172 .RE
173 .TP
174 .BR show " [options...] <search-term>..."
175
176 Shows all messages matching the search terms.
177
178 The messages will be grouped and sorted based on the threading (all
179 replies to a particular message will appear immediately after that
180 message in date order). The output is not indented by default, but
181 depth tags are printed so that proper indentation can be performed by
182 a post-processor (such as the emacs interface to notmuch).
183
184 Supported options for
185 .B show
186 include
187 .RS 4
188 .TP 4
189 .B \-\-entire\-thread
190
191 By default only those messages that match the search terms will be
192 displayed. With this option, all messages in the same thread as any
193 matched message will be displayed.
194 .RE
195
196 .RS 4
197 The  output format  is plain-text,  with all  text-content  MIME parts
198 decoded. Various components in the output,
199 .RB ( message ", " header ", " body ", " attachment ", and MIME " part ),
200 will be delimited by easily-parsed markers. Each marker consists of a
201 Control-L character (ASCII decimal 12), the name of the marker, and
202 then either an opening or closing brace, ('{' or '}'), to either open
203 or close the component.
204
205 A common use of
206 .B notmuch show
207 is to display a single thread of email messages. For this, use a
208 search term of "thread:<thread-id>" as can be seen in the first
209 column of output from the
210 .B notmuch search
211 command.
212
213 See the
214 .B "SEARCH SYNTAX"
215 section below for details of the supported syntax for <search-terms>.
216 .RE
217 .RE
218
219 The
220 .B reply
221 command is useful for preparing a template for an email reply.
222 .RS 4
223 .TP 4
224 .BR reply " [options...] <search-term>..."
225
226 Constructs a reply template for a set of messages.
227
228 To make replying to email easier,
229 .B notmuch reply
230 takes an existing set of messages and constructs a suitable mail
231 template. The Reply-to header (if any, otherwise From:) is used for
232 the To: address. Vales from the To: and Cc: headers are copied, but
233 not including any of the current user's email addresses (as configured
234 in primary_mail or other_email in the .notmuch-config file) in the
235 recipient list
236
237 It also builds a suitable new subject, including Re: at the front (if
238 not already present), and adding the message IDs of the messages being
239 replied to to the References list and setting the In-Reply-To: field
240 correctly.
241
242 Finally, the original contents of the emails are quoted by prefixing
243 each line with '> ' and included in the body.
244
245 The resulting message template is output to stdout.
246
247 Supported options for
248 .B reply
249 include
250 .RS
251 .TP 4
252 .BR \-\-format= ( default | headers\-only )
253 .RS
254 .TP 4
255 .BR default
256 Includes subject and quoted message body.
257 .TP
258 .BR headers-only
259 Only produces In-Reply-To, References, To, Cc, and Bcc headers.
260 .RE
261
262 See the
263 .B "SEARCH SYNTAX"
264 section below for details of the supported syntax for <search-terms>.
265
266 Note: It is most common to use
267 .B "notmuch reply"
268 with a search string matching a single message, (such as
269 id:<message-id>), but it can be useful to reply to several messages at
270 once. For example, when a series of patches are sent in a single
271 thread, replying to the entire thread allows for the reply to comment
272 on issue found in multiple patches.
273 .RE
274 .RE
275
276 The
277 .B tag
278 command is the only command available for manipulating database
279 contents.
280
281 .RS 4
282 .TP 4
283 .BR tag " +<tag>|-<tag> [...] [--] <search-term>..."
284
285 Add/remove tags for all messages matching the search terms.
286
287 Tags prefixed by '+' are added while those prefixed by '-' are
288 removed. For each message, tag removal is performed before tag
289 addition.
290
291 The beginning of <search-terms> is recognized by the first
292 argument that begins with neither '+' nor '-'. Support for
293 an initial search term beginning with '+' or '-' is provided
294 by allowing the user to specify a "--" argument to separate
295 the tags from the search terms.
296
297 See the
298 .B "SEARCH SYNTAX"
299 section below for details of the supported syntax for <search-terms>.
300 .RE
301
302 The
303 .BR dump " and " restore
304 commands can be used to create a textual dump of email tags for backup
305 purposes, and to restore from that dump
306
307 .RS 4
308 .TP 4
309 .BR dump " [<filename>]"
310
311 Creates a plain-text dump of the tags of each message.
312
313 The output is to the given filename, if any, or to stdout.
314
315 These tags are the only data in the notmuch database that can't be
316 recreated from the messages themselves.  The output of notmuch dump is
317 therefore the only critical thing to backup (and much more friendly to
318 incremental backup than the native database files.)
319 .TP
320 .BR restore " <filename>"
321
322 Restores the tags from the given file (see
323 .BR "notmuch dump" "."
324
325 Note: The dump file format is specifically chosen to be
326 compatible with the format of files produced by sup-dump.
327 So if you've previously been using sup for mail, then the
328 .B "notmuch restore"
329 command provides you a way to import all of your tags (or labels as
330 sup calls them).
331 .SH SEARCH SYNTAX
332 Several notmuch commands accept a common syntax for search terms.
333
334 The search terms can consist of free-form text (and quoted phrases)
335 which will match all messages that contain all of the given
336 terms/phrases in the body, the subject, or any of the sender or
337 recipient headers.
338
339 In addition to free text, the following prefixes can be used to force
340 terms to match against specific portions of an email, (where
341 <brackets> indicate user-supplied values):
342
343         from:<name-or-address>
344
345         to:<name-or-address>
346
347         subject:<word-or-quoted-phrase>
348
349         attachment:<word>
350
351         tag:<tag>
352
353         id:<message-id>
354
355         thread:<thread-id>
356
357 The
358 .B from:
359 prefix is used to match the name or address of the sender of an email
360 message.
361
362 The
363 .B to:
364 prefix is used to match the names or addresses of any recipient of an
365 email message, (whether To, Cc, or Bcc).
366
367 Any term prefixed with
368 .B subject:
369 will match only text from the subject of an email. Searching for a
370 phrase in the subject is supported by including quotation marks around
371 the phrase, immediately following
372 .BR subject: .
373
374 The
375 .B attachment:
376 prefix can be used to search for specific filenames (or extensions) of
377 attachments to email messages.
378
379 For
380 .BR tag: ,
381 valid tag values include
382 .BR inbox " and " unread
383 by default for new messages added by
384 .B notmuch new
385 as well as any other tag values added manually with
386 .BR "notmuch tag" .
387
388 For
389 .BR id: ,
390 message ID values are the literal contents of the Message-ID: header
391 of email messages, but without the '<', '>' delimiters.
392
393 The
394 .B thread:
395 prefix can be used with the thread ID values that are generated
396 internally by notmuch (and do not appear in email messages). These
397 thread ID values can be seen in the first column of output from
398 .B "notmuch search"
399
400 In addition to individual terms, multiple terms can be
401 combined with Boolean operators (
402 .BR and ", " or ", " not
403 , etc.). Each term in the query will be implicitly connected by a
404 logical AND if no explicit operator is provided, (except that terms
405 with a common prefix will be implicitly combined with OR until we get
406 Xapian defect #402 fixed).
407
408 Parentheses can also be used to control the combination of the Boolean
409 operators, but will have to be protected from interpretation by the
410 shell, (such as by putting quotation marks around any parenthesized
411 expression).
412
413 Finally, results can be restricted to only messages within a
414 particular time range, (based on the Date: header) with a syntax of:
415
416         <intial-timestamp>..<final-timestamp>
417
418 Each timestamp is a number representing the number of seconds since
419 1970-01-01 00:00:00 UTC. This is not the most convenient means of
420 expressing date ranges, but until notmuch is fixed to accept a more
421 convenient form, one can use the date program to construct
422 timestamps. For example, with the bash shell the folowing syntax would
423 specify a date range to return messages from 2009-10-01 until the
424 current time:
425
426         $(date +%s -d 2009-10-01)..$(date +%s)
427 .SH SEE ALSO
428 The emacs-based interface to notmuch (available as
429 .B notmuch.el
430 in the Notmuch distribution).
431
432 The notmuch website:
433 .B http://notmuchmail.org
434 .SH CONTACT
435 Feel free to send questions, comments, or kudos to the notmuch mailing
436 list <notmuch@notmuchmail.org> . Subscription is not required before
437 posting, but is available from the notmuchmail.org website.
438
439 Real-time interaction with the Notmuch community is available via IRC
440 (server: irc.freenode.net, channel: #notmuch).