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