notmuch search: Add a new --output=(summary|threads|messages|tags) option.
[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 ", " show " and " count
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 \-\-format= ( json | text )
150
151 Presents the results in either JSON or plain-text (default).
152 .RE
153
154 .RS 4
155 .TP 4
156 .B \-\-output=(summary|threads|messages|tags)
157
158 .RS 4
159 .TP 4
160 .B summary
161
162 Output a summary of each thread with any message matching the search
163 terms. The summary includes the thread ID, date, the number of
164 messages in the thread (both the number matched and the total number),
165 the authors of the thread and the subject.
166 .RE
167 .RS 4
168 .TP 4
169 .B threads
170
171 Output the thread IDs of all threads with any message matching the
172 search terms, either one per line (--format=text) or as a JSON array
173 (--format=json).
174 .RE
175 .RS 4
176 .TP 4
177 .B messages
178
179 Output the message IDs of all messages matching the search terms,
180 either one per line (--format=text) or as a JSON array
181 (--format=json).
182 .RE
183 .RS 4
184 .TP 4
185 .B tags
186
187 Output all tags that appear on any message matching the search terms,
188 either one per line (--format=text) or as a JSON array
189 (--format=json).
190 .RE
191 .RE
192
193 .RS 4
194 .TP 4
195 .BR \-\-sort= ( newest\-first | oldest\-first )
196
197 This option can be used to present results in either chronological order
198 .RB ( oldest\-first )
199 or reverse chronological order
200 .RB ( newest\-first ).
201
202 Note: The thread order will be distinct between these two options
203 (beyond being simply reversed). When sorting by
204 .B oldest\-first
205 the threads will be sorted by the oldest message in each thread, but
206 when sorting by
207 .B newest\-first
208 the threads will be sorted by the newest message in each thread.
209
210 .RE
211 .RS 4
212 By default, results will be displayed in reverse chronological order,
213 (that is, the newest results will be displayed first).
214
215 See the
216 .B "SEARCH SYNTAX"
217 section below for details of the supported syntax for <search-terms>.
218 .RE
219 .TP
220 .BR show " [options...] <search-term>..."
221
222 Shows all messages matching the search terms.
223
224 The messages will be grouped and sorted based on the threading (all
225 replies to a particular message will appear immediately after that
226 message in date order). The output is not indented by default, but
227 depth tags are printed so that proper indentation can be performed by
228 a post-processor (such as the emacs interface to notmuch).
229
230 Supported options for
231 .B show
232 include
233 .RS 4
234 .TP 4
235 .B \-\-entire\-thread
236
237 By default only those messages that match the search terms will be
238 displayed. With this option, all messages in the same thread as any
239 matched message will be displayed.
240 .RE
241
242 .RS 4
243 .TP 4
244 .B \-\-format=(text|json|mbox)
245
246 .RS 4
247 .TP 4
248 .B text
249
250 The default plain-text format has all text-content MIME parts
251 decoded. Various components in the output,
252 .RB ( message ", " header ", " body ", " attachment ", and MIME " part ),
253 will be delimited by easily-parsed markers. Each marker consists of a
254 Control-L character (ASCII decimal 12), the name of the marker, and
255 then either an opening or closing brace, ('{' or '}'), to either open
256 or close the component.
257 .RE
258 .RS 4
259 .TP 4
260 .B json
261
262 The output is formatted with Javascript Object Notation (JSON). This
263 format is more robust than the text format for automated
264 processing. JSON output always includes all messages in a matching
265 thread; in effect
266 .B \-\-format=json
267 implies
268 .B \-\-entire\-thread
269
270 .RE
271 .RS 4
272 .TP 4
273 .B mbox
274
275 All matching messages are output in the traditional, Unix mbox format
276 with each message being prefixed by a line beginning with "From " and
277 a blank line separating each message. Lines in the message content
278 beginning with "From " (preceded by zero or more '>' characters) have
279 an additional '>' character added. This reversible escaping
280 is termed "mboxrd" format and described in detail here:
281 http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
282 .RE
283 A common use of
284 .B notmuch show
285 is to display a single thread of email messages. For this, use a
286 search term of "thread:<thread-id>" as can be seen in the first
287 column of output from the
288 .B notmuch search
289 command.
290
291 See the
292 .B "SEARCH SYNTAX"
293 section below for details of the supported syntax for <search-terms>.
294 .RE
295 .TP
296 .BR count " <search-term>..."
297
298 Count messages matching the search terms.
299
300 The number of matching messages is output to stdout.
301
302 With no search terms, a count of all messages in the database will be
303 displayed.
304 .RE
305 .RE
306
307 The
308 .B reply
309 command is useful for preparing a template for an email reply.
310 .RS 4
311 .TP 4
312 .BR reply " [options...] <search-term>..."
313
314 Constructs a reply template for a set of messages.
315
316 To make replying to email easier,
317 .B notmuch reply
318 takes an existing set of messages and constructs a suitable mail
319 template. The Reply-to header (if any, otherwise From:) is used for
320 the To: address. Vales from the To: and Cc: headers are copied, but
321 not including any of the current user's email addresses (as configured
322 in primary_mail or other_email in the .notmuch\-config file) in the
323 recipient list
324
325 It also builds a suitable new subject, including Re: at the front (if
326 not already present), and adding the message IDs of the messages being
327 replied to to the References list and setting the In\-Reply\-To: field
328 correctly.
329
330 Finally, the original contents of the emails are quoted by prefixing
331 each line with '> ' and included in the body.
332
333 The resulting message template is output to stdout.
334
335 Supported options for
336 .B reply
337 include
338 .RS
339 .TP 4
340 .BR \-\-format= ( default | headers\-only )
341 .RS
342 .TP 4
343 .BR default
344 Includes subject and quoted message body.
345 .TP
346 .BR headers\-only
347 Only produces In\-Reply\-To, References, To, Cc, and Bcc headers.
348 .RE
349
350 See the
351 .B "SEARCH SYNTAX"
352 section below for details of the supported syntax for <search-terms>.
353
354 Note: It is most common to use
355 .B "notmuch reply"
356 with a search string matching a single message, (such as
357 id:<message-id>), but it can be useful to reply to several messages at
358 once. For example, when a series of patches are sent in a single
359 thread, replying to the entire thread allows for the reply to comment
360 on issue found in multiple patches.
361 .RE
362 .RE
363
364 The
365 .B tag
366 command is the only command available for manipulating database
367 contents.
368
369 .RS 4
370 .TP 4
371 .BR tag " +<tag>|\-<tag> [...] [\-\-] <search-term>..."
372
373 Add/remove tags for all messages matching the search terms.
374
375 Tags prefixed by '+' are added while those prefixed by '\-' are
376 removed. For each message, tag removal is performed before tag
377 addition.
378
379 The beginning of <search-terms> is recognized by the first
380 argument that begins with neither '+' nor '\-'. Support for
381 an initial search term beginning with '+' or '\-' is provided
382 by allowing the user to specify a "\-\-" argument to separate
383 the tags from the search terms.
384
385 See the
386 .B "SEARCH SYNTAX"
387 section below for details of the supported syntax for <search-terms>.
388 .RE
389
390 The
391 .BR dump " and " restore
392 commands can be used to create a textual dump of email tags for backup
393 purposes, and to restore from that dump
394
395 .RS 4
396 .TP 4
397 .BR dump " [<filename>]"
398
399 Creates a plain-text dump of the tags of each message.
400
401 The output is to the given filename, if any, or to stdout.
402
403 These tags are the only data in the notmuch database that can't be
404 recreated from the messages themselves.  The output of notmuch dump is
405 therefore the only critical thing to backup (and much more friendly to
406 incremental backup than the native database files.)
407 .TP
408 .BR restore " <filename>"
409
410 Restores the tags from the given file (see
411 .BR "notmuch dump" "."
412
413 Note: The dump file format is specifically chosen to be
414 compatible with the format of files produced by sup-dump.
415 So if you've previously been using sup for mail, then the
416 .B "notmuch restore"
417 command provides you a way to import all of your tags (or labels as
418 sup calls them).
419 .RE
420
421 The
422 .B part
423 command can used to output a single part of a multi-part MIME message.
424
425 .RS 4
426 .TP 4
427 .BR part " \-\-part=<part-number> <search-term>..."
428
429 Output a single MIME part of a message.
430
431 A single decoded MIME part, with no encoding or framing, is output to
432 stdout. The search terms must match only a single message, otherwise
433 this command will fail.
434
435 The part number should match the part "id" field output by the
436 "\-\-format=json" option of "notmuch show". If the message specified by
437 the search terms does not include a part with the specified "id" there
438 will be no output.
439
440 See the
441 .B "SEARCH SYNTAX"
442 section below for details of the supported syntax for <search-terms>.
443 .RE
444
445 The
446 .B config
447 command can be used to get or set settings int the notmuch
448 configuration file.
449
450 .RS 4
451 .TP 4
452 .BR "config get " <section> . <item>
453
454 The value of the specified configuration item is printed to stdout. If
455 the item has multiple values, each value is separated by a newline
456 character.
457
458 Available configuration items include at least
459
460         database.path
461
462         user.name
463
464         user.primary_email
465
466         user.other_email
467
468         new.tags
469 .RE
470
471 .RS 4
472 .TP 4
473 .BR "config set " <section> . "<item> [values ...]"
474
475 The specified configuration item is set to the given value.  To
476 specify a multiple-value item, provide each value as a separate
477 command-line argument.
478
479 If no values are provided, the specified configuration item will be
480 removed from the configuration file.
481 .RE
482
483 .SH SEARCH SYNTAX
484 Several notmuch commands accept a common syntax for search terms.
485
486 The search terms can consist of free-form text (and quoted phrases)
487 which will match all messages that contain all of the given
488 terms/phrases in the body, the subject, or any of the sender or
489 recipient headers.
490
491 As a special case, a search string consisting of exactly a single
492 asterisk ("*") will match all messages.
493
494 In addition to free text, the following prefixes can be used to force
495 terms to match against specific portions of an email, (where
496 <brackets> indicate user-supplied values):
497
498         from:<name-or-address>
499
500         to:<name-or-address>
501
502         subject:<word-or-quoted-phrase>
503
504         attachment:<word>
505
506         tag:<tag> (or is:<tag>)
507
508         id:<message-id>
509
510         thread:<thread-id>
511
512 The
513 .B from:
514 prefix is used to match the name or address of the sender of an email
515 message.
516
517 The
518 .B to:
519 prefix is used to match the names or addresses of any recipient of an
520 email message, (whether To, Cc, or Bcc).
521
522 Any term prefixed with
523 .B subject:
524 will match only text from the subject of an email. Searching for a
525 phrase in the subject is supported by including quotation marks around
526 the phrase, immediately following
527 .BR subject: .
528
529 The
530 .B attachment:
531 prefix can be used to search for specific filenames (or extensions) of
532 attachments to email messages.
533
534 For
535 .BR tag: " and " is:
536 valid tag values include
537 .BR inbox " and " unread
538 by default for new messages added by
539 .B notmuch new
540 as well as any other tag values added manually with
541 .BR "notmuch tag" .
542
543 For
544 .BR id: ,
545 message ID values are the literal contents of the Message\-ID: header
546 of email messages, but without the '<', '>' delimiters.
547
548 The
549 .B thread:
550 prefix can be used with the thread ID values that are generated
551 internally by notmuch (and do not appear in email messages). These
552 thread ID values can be seen in the first column of output from
553 .B "notmuch search"
554
555 In addition to individual terms, multiple terms can be
556 combined with Boolean operators (
557 .BR and ", " or ", " not
558 , etc.). Each term in the query will be implicitly connected by a
559 logical AND if no explicit operator is provided, (except that terms
560 with a common prefix will be implicitly combined with OR until we get
561 Xapian defect #402 fixed).
562
563 Parentheses can also be used to control the combination of the Boolean
564 operators, but will have to be protected from interpretation by the
565 shell, (such as by putting quotation marks around any parenthesized
566 expression).
567
568 Finally, results can be restricted to only messages within a
569 particular time range, (based on the Date: header) with a syntax of:
570
571         <intial-timestamp>..<final-timestamp>
572
573 Each timestamp is a number representing the number of seconds since
574 1970\-01\-01 00:00:00 UTC. This is not the most convenient means of
575 expressing date ranges, but until notmuch is fixed to accept a more
576 convenient form, one can use the date program to construct
577 timestamps. For example, with the bash shell the folowing syntax would
578 specify a date range to return messages from 2009\-10\-01 until the
579 current time:
580
581         $(date +%s \-d 2009\-10\-01)..$(date +%s)
582 .SH ENVIRONMENT
583 The following environment variables can be used to control the
584 behavior of notmuch.
585 .TP
586 .B NOTMUCH_CONFIG
587 Specifies the location of the notmuch configuration file. Notmuch will
588 use ${HOME}/.notmuch\-config if this variable is not set.
589 .SH SEE ALSO
590 The emacs-based interface to notmuch (available as
591 .B notmuch.el
592 in the Notmuch distribution).
593
594 The notmuch website:
595 .B http://notmuchmail.org
596 .SH CONTACT
597 Feel free to send questions, comments, or kudos to the notmuch mailing
598 list <notmuch@notmuchmail.org> . Subscription is not required before
599 posting, but is available from the notmuchmail.org website.
600
601 Real-time interaction with the Notmuch community is available via IRC
602 (server: irc.freenode.net, channel: #notmuch).