INSTALL: Mention that xapian-config might be named xapian-config-1.1
[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 You can even skip the configure step if all of the dependencies of
13 Notmuch are satisfied. If they are not, the configure script will
14 notice that and provide instructions on where to obtain the necessary
15 dependencies.
16
17 Dependencies
18 ------------
19 Notmuch depends on three libraries: Xapian, GMime 2.4, and Talloc
20 which are each described below:
21
22         Xapian
23         ------
24         Xapian is the search-engine library underlying Notmuch.
25
26         It provides all the real machinery of indexing and searching,
27         (including the very nice parsing of the query string).
28
29         Xapian is available from http://xapian.org
30
31         After installing Xapian, please ensure that you have a command
32         named "xapian-config" on your $PATH as notmuch expects. (At
33         least one notmuch user found that Xapian installed the config
34         program to /usr/local/bin/xapian-config-1.1 ).
35
36         GMime 2.4
37         ---------
38         GMime 2.4 provides decoding of MIME email messages for Notmuch.
39
40         Without GMime, Notmuch would not be able to extract and index
41         the actual text from email message encoded as BASE64, etc.
42
43         GMime 2.4 is available from http://spruce.sourceforge.net/gmime/
44
45         Talloc
46         ------
47         Talloc is a memory-pool allocator used by Notmuch.
48
49         Talloc is an extremely lightweight and easy-to-use tool for
50         allocating memory in a hierarchical fashion and then freeing
51         it with a single call of the top-level handle. Using it has
52         made development of Notmuch much easier and much less prone to
53         memory leaks.
54
55         Talloc is available from http://talloc.samba.org/
56
57 On a modern, package-based operating system such as Debian, you can
58 install all of the dependencies with the following simple command
59 line:
60
61         sudo apt-get install libxapian-dev libgmime-2.4-dev libtalloc-dev
62
63 On other systems, a similar command can be used, but the details of
64 the package names may be different, (such as "devel" in place of
65 "dev").
66
67
68         
69