74f892e8780057c738e90573753f09b99cd63eba
[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 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
84
85 Several of the notmuch commands accept search terms with a common
86 syntax. See the
87 .B "SEARCH SYNTAX"
88 section below for more details on the supported syntax.
89
90 The
91 .BR search ", " show " and " count
92 commands are used to query the email database.
93
94
95 The
96 .B reply
97 command is useful for preparing a template for an email reply.
98 .RS 4
99
100 The
101 .B tag
102 command is the only command available for manipulating database
103 contents.
104
105
106 The
107 .BR dump " and " restore
108 commands can be used to create a textual dump of email tags for backup
109 purposes, and to restore from that dump.
110
111 The
112 .B config
113 command can be used to get or set settings int the notmuch
114 configuration file.
115
116 .SH ENVIRONMENT
117 The following environment variables can be used to control the
118 behavior of notmuch.
119 .TP
120 .B NOTMUCH_CONFIG
121 Specifies the location of the notmuch configuration file. Notmuch will
122 use ${HOME}/.notmuch\-config if this variable is not set.
123 .SH SEE ALSO
124 The emacs-based interface to notmuch (available as
125 .B notmuch.el
126 in the Notmuch distribution).
127
128 The notmuch website:
129 .B http://notmuchmail.org
130 .SH CONTACT
131 Feel free to send questions, comments, or kudos to the notmuch mailing
132 list <notmuch@notmuchmail.org> . Subscription is not required before
133 posting, but is available from the notmuchmail.org website.
134
135 Real-time interaction with the Notmuch community is available via IRC
136 (server: irc.freenode.net, channel: #notmuch).