emacs: escape quote in docstring
[notmuch] / README
1 Notmuch - thread-based email index, search and tagging.
2
3 Notmuch is a system for indexing, searching, reading, and tagging
4 large collections of email messages in maildir or mh format. It uses
5 the Xapian library to provide fast, full-text search with a convenient
6 search syntax.
7
8 Notmuch is free software, released under the GNU General Public
9 License version 3 (or later).
10
11 Building notmuch
12 ----------------
13 See the INSTALL file for notes on compiling and installing notmuch.
14
15 Running notmuch
16 ---------------
17 After installing notmuch, start by running "notmuch setup" which will
18 interactively prompt for configuration information such as your name,
19 email address, and the directory which contains your mail archive to
20 be indexed. You can change any answers later by running "notmuch
21 setup" again or by editing the .notmuch-config file in your home
22 directory.
23
24 With notmuch configured you should next run "notmuch new" which will
25 index all of your existing mail. This can take a long time, (several
26 hours) if you have a lot of email, (hundreds of thousands of
27 files). When new mail is delivered to your mail archive in the future,
28 you will want to run "notmuch new" again. These runs will be much
29 faster as they will only index new messages.
30
31 Finally, you can prove to yourself that things are working by running
32 some command-line searches such as "notmuch search
33 from:someone@example.com" or "notmuch search subject:topic". See
34 "notmuch help search-terms" for more details on the available search
35 syntax.
36
37 The command-line search output is not expected to be particularly
38 friendly for day-to-day usage. Instead, it is expected that you will
39 use an email interface that builds on the notmuch command-line tool or
40 the libnotmuch library.
41
42 Notmuch installs a full-featured email interface for use within
43 emacs. To use this, first add the following line to your .emacs file:
44
45         (autoload 'notmuch "notmuch" "Notmuch mail" t)
46
47 Then, either run "emacs -f notmuch" or execute the command "M-x
48 notmuch" from within a running emacs.
49
50 If you're interested in a non-emacs-based interface to notmuch, then
51 please join the notmuch community. Various other interfaces are
52 already in progress, (an interface within vim, a curses interface,
53 graphical interfaces based on evolution, and various web-based
54 interfaces). The authors of these interfaces would love further
55 testing or contribution. See contact information below.
56
57 Contacting users and developers
58 -------------------------------
59 The website for Notmuch is:
60
61         https://notmuchmail.org
62
63 The mailing list address for the notmuch community is:
64
65         notmuch@notmuchmail.org
66
67 We welcome any sort of questions, comments, kudos, or code there.
68
69 Subscription is not required, (but if you do subscribe you'll avoid
70 any delay due to moderation). See the website for subscription
71 information.
72
73 There is also an IRC channel dedicated to talk about using and
74 developing notmuch:
75
76         IRC server:     irc.freenode.net
77         Channel:        #notmuch