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