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