INSTALL: Note the advantages of Xapian 1.0.18+ and 1.1.4+
[notmuch] / INSTALL
1 Build and install instructions for Notmuch.
2
3 Compilation commands
4 --------------------
5 The process for compiling and installing Notmuch is the very standard
6 sequence of:
7
8         ./configure
9         make
10         sudo make install
11
12 In fact, if you don't plan to pass any arguments to the configure
13 script, then you can skip that step and just start with "make", (which
14 will call configure for you). See this command:
15
16         ./configure --help
17
18 for detailed documentation of the things you can control at the
19 configure stage.
20
21 notmuch.el installation
22 -----------------------
23 Installing the notmuch.el emacs lisp function systemwide:
24
25         sudo make install-emacs
26
27 Each user needs to add (require 'notmuch) in his ~/.emacs to make it
28 available and then start emacs running notmuch with "emacs -f notmuch"
29 or start notmuch from within emacs with "M-x notmuch".
30
31 Dependencies
32 ------------
33 Notmuch depends on three libraries: Xapian, GMime 2.4, and Talloc
34 which are each described below:
35
36         Xapian
37         ------
38         Xapian is the search-engine library underlying Notmuch.
39
40         It provides all the real machinery of indexing and searching,
41         (including the very nice parsing of the query string).
42
43         Xapian is available from http://xapian.org
44
45         Note: Notmuch will work best with Xapian 1.0.18 (or later) or
46         Xapian 1.1.4 (or later). Previous versions of Xapian (whether
47         1.0 or 1.1) had a performance bug that made notmuch very slow
48         when modifying tags. This would cause distracting pauses when
49         reading mail while notmuch would wait for Xapian when removing
50         the "inbox" and "unread" tags from messages in a thread.
51
52         GMime 2.4
53         ---------
54         GMime 2.4 provides decoding of MIME email messages for Notmuch.
55
56         Without GMime, Notmuch would not be able to extract and index
57         the actual text from email message encoded as BASE64, etc.
58
59         GMime 2.4 is available from http://spruce.sourceforge.net/gmime/
60
61         Talloc
62         ------
63         Talloc is a memory-pool allocator used by Notmuch.
64
65         Talloc is an extremely lightweight and easy-to-use tool for
66         allocating memory in a hierarchical fashion and then freeing
67         it with a single call of the top-level handle. Using it has
68         made development of Notmuch much easier and much less prone to
69         memory leaks.
70
71         Talloc is available from http://talloc.samba.org/
72
73 On a modern, package-based operating system you can install all of the
74 dependencies with a simple simple command line. For example:
75
76   For Debian and similar:
77
78         sudo apt-get install libxapian-dev libgmime-2.4-dev libtalloc-dev
79
80   For Fedora and similar:
81
82         sudo yum install xapian-core-devel gmime-devel libtalloc-devel
83
84 On other systems, a similar command can be used, but the details of
85 the package names may be different.
86
87         
88