notmuch.1: smooth wording.
[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 2011-12-04 "Notmuch 0.10.2"
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 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 COMMANDS
54
55
56 .SS SETUP
57
58 The
59 .B notmuch setup
60 command is used to configure Notmuch for first use, (or to reconfigure
61 it later).
62
63 The setup command will prompt for your full name, your primary email
64 address, any alternate email addresses you use, and the directory
65 containing your email archives. Your answers will be written to a
66 configuration file in ${NOTMUCH_CONFIG} (if set) or
67 ${HOME}/.notmuch-config . This configuration file will be created with
68 descriptive comments, making it easy to edit by hand later to change the
69 configuration. Or you can run
70 .B "notmuch setup"
71 again to change the configuration.
72
73 The mail directory you specify can contain any number of
74 sub-directories and should primarily contain only files with individual
75 email messages (eg. maildir or mh archives are perfect). If there are
76 other, non-email files (such as indexes maintained by other email
77 programs) then notmuch will do its best to detect those and ignore
78 them.
79
80 Mail storage that uses mbox format, (where one mbox file contains many
81 messages), will not work with notmuch. If that's how your mail is
82 currently stored, it is recommended you first convert it to maildir
83 format with a utility such as mb2md before running
84 .B "notmuch setup" .
85
86 Invoking
87 .B notmuch
88 with no command argument will run
89 .B setup
90 if the setup command has not previously been completed.
91 .RE
92
93 .SS OTHER COMMANDS
94
95 Several of the notmuch commands accept search terms with a common
96 syntax. See the
97 .B "SEARCH SYNTAX"
98 section below for more details on the supported syntax.
99
100 The
101 .BR search ", " show " and " count
102 commands are used to query the email database.
103
104 The
105 .B reply
106 command is useful for preparing a template for an email reply.
107
108 The
109 .B tag
110 command is the only command available for manipulating database
111 contents.
112
113
114 The
115 .BR dump " and " restore
116 commands can be used to create a textual dump of email tags for backup
117 purposes, and to restore from that dump.
118
119 The
120 .B config
121 command can be used to get or set settings int the notmuch
122 configuration file.
123
124 .SH ENVIRONMENT
125 The following environment variables can be used to control the
126 behavior of notmuch.
127 .TP
128 .B NOTMUCH_CONFIG
129 Specifies the location of the notmuch configuration file. Notmuch will
130 use ${HOME}/.notmuch\-config if this variable is not set.
131 .SH SEE ALSO
132
133 The notmuch website:
134 .B http://notmuchmail.org
135 .SH CONTACT
136 Feel free to send questions, comments, or kudos to the notmuch mailing
137 list <notmuch@notmuchmail.org> . Subscription is not required before
138 posting, but is available from the notmuchmail.org website.
139
140 Real-time interaction with the Notmuch community is available via IRC
141 (server: irc.freenode.net, channel: #notmuch).