Merge branch 'release'
[notmuch] / man / man1 / 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 2013-02-17 "Notmuch 0.15.2"
20 .SH NAME
21 notmuch \- thread-based email index, search, and tagging
22 .SH SYNOPSIS
23 .B notmuch
24 .RI "[" option " ...] " command  " [" arg " ...]"
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 This page describes how to get started using notmuch from the command
30 line, and gives a brief overview of the commands available. For more
31 information on e.g.
32 .B notmuch show
33 consult the \fBnotmuch-show\fR(1) man page, also accessible via
34 .B notmuch help show
35
36 The quickest way to get started with Notmuch is to simply invoke the
37 .B notmuch
38 command with no arguments, which will interactively guide you through
39 the process of indexing your mail.
40 .SH NOTE
41 While the command-line program
42 .B notmuch
43 provides powerful functionality, it does not provide the most
44 convenient interface for that functionality. More sophisticated
45 interfaces are expected to be built on top of either the command-line
46 interface, or more likely, on top of the notmuch library
47 interface. See http://notmuchmail.org for more about alternate
48 interfaces to notmuch. The emacs-based interface to notmuch (available under
49 .B emacs/
50 in the Notmuch source distribution) is probably the most widely used at
51 this time.
52
53 .SH OPTIONS
54
55 Supported global options for
56 .B notmuch
57 include
58
59 .RS 4
60 .TP 4
61 .B \-\-help
62
63 Print a synopsis of available commands and exit.
64 .RE
65
66 .RS 4
67 .TP 4
68 .B \-\-version
69
70 Print the installed version of notmuch, and exit.
71 .RE
72
73 .SH COMMANDS
74
75
76 .SS SETUP
77
78 The
79 .B notmuch setup
80 command is used to configure Notmuch for first use, (or to reconfigure
81 it later).
82
83 The setup command will prompt for your full name, your primary email
84 address, any alternate email addresses you use, and the directory
85 containing your email archives. Your answers will be written to a
86 configuration file in ${NOTMUCH_CONFIG} (if set) or
87 ${HOME}/.notmuch-config . This configuration file will be created with
88 descriptive comments, making it easy to edit by hand later to change the
89 configuration. Or you can run
90 .B "notmuch setup"
91 again to change the configuration.
92
93 The mail directory you specify can contain any number of
94 sub-directories and should primarily contain only files with individual
95 email messages (eg. maildir or mh archives are perfect). If there are
96 other, non-email files (such as indexes maintained by other email
97 programs) then notmuch will do its best to detect those and ignore
98 them.
99
100 Mail storage that uses mbox format, (where one mbox file contains many
101 messages), will not work with notmuch. If that's how your mail is
102 currently stored, it is recommended you first convert it to maildir
103 format with a utility such as mb2md before running
104 .B "notmuch setup" .
105
106 Invoking
107 .B notmuch
108 with no command argument will run
109 .B setup
110 if the setup command has not previously been completed.
111 .RE
112
113 .SS OTHER COMMANDS
114
115 Several of the notmuch commands accept search terms with a common
116 syntax. See \fNnotmuch-search-terms\fR(7)
117 for more details on the supported syntax.
118
119 The
120 .BR search ", " show " and " count
121 commands are used to query the email database.
122
123 The
124 .B reply
125 command is useful for preparing a template for an email reply.
126
127 The
128 .B tag
129 command is the only command available for manipulating database
130 contents.
131
132
133 The
134 .BR dump " and " restore
135 commands can be used to create a textual dump of email tags for backup
136 purposes, and to restore from that dump.
137
138 The
139 .B config
140 command can be used to get or set settings int the notmuch
141 configuration file.
142
143 .SH ENVIRONMENT
144 The following environment variables can be used to control the
145 behavior of notmuch.
146 .TP
147 .B NOTMUCH_CONFIG
148 Specifies the location of the notmuch configuration file. Notmuch will
149 use ${HOME}/.notmuch\-config if this variable is not set.
150
151 .TP
152 .B NOTMUCH_TALLOC_REPORT
153 Location to write a talloc memory usage report. See
154 .B talloc_enable_leak_report_full
155 in \fBtalloc\fR(3)
156 for more information.
157
158 .SH SEE ALSO
159
160 \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
161 \fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1),
162 \fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
163 \fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
164 \fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)
165
166
167 The notmuch website:
168 .B http://notmuchmail.org
169 .SH CONTACT
170 Feel free to send questions, comments, or kudos to the notmuch mailing
171 list <notmuch@notmuchmail.org> . Subscription is not required before
172 posting, but is available from the notmuchmail.org website.
173
174 Real-time interaction with the Notmuch community is available via IRC
175 (server: irc.freenode.net, channel: #notmuch).