X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=INSTALL;h=fce935289c4a360dd5802d5b20590e2cbefbdc10;hp=64b8e362cc335f277ed2400e63bd37b898be9e3e;hb=d273ed6cf1bdaa2d644cec4909cbf415ff4d257b;hpb=0414c774d212c6be95385a9bf849460242da41a0 diff --git a/INSTALL b/INSTALL index 64b8e362..fce93528 100644 --- a/INSTALL +++ b/INSTALL @@ -9,23 +9,19 @@ sequence of: make sudo make install -You can even skip the configure step if all of the dependencies of -Notmuch are satisfied. If they are not, the configure script will -notice that and provide instructions on where to obtain the necessary -dependencies. +In fact, if you don't plan to pass any arguments to the configure +script, then you can skip that step and just start with "make", (which +will call configure for you). See this command: -notmuch.el installation ------------------------ -Installing the notmuch.el emacs lisp function systemwide: + ./configure --help - sudo make install-emacs - -Each user needs to add (require 'notmuch) in his ~/.emacs to activate it. +for detailed documentation of the things you can control at the +configure stage. Dependencies ------------ -Notmuch depends on three libraries: Xapian, GMime 2.4, and Talloc -which are each described below: +Notmuch depends on three libraries: Xapian, GMime 2.4 or 2.6, and +Talloc which are each described below: Xapian ------ @@ -36,19 +32,21 @@ which are each described below: Xapian is available from http://xapian.org - After installing Xapian, please ensure that you have a command - named "xapian-config" on your $PATH as notmuch expects. (At - least one notmuch user found that Xapian installed the config - program to /usr/local/bin/xapian-config-1.1 ). + Note: Notmuch will work best with Xapian 1.0.18 (or later) or + Xapian 1.1.4 (or later). Previous versions of Xapian (whether + 1.0 or 1.1) had a performance bug that made notmuch very slow + when modifying tags. This would cause distracting pauses when + reading mail while notmuch would wait for Xapian when removing + the "inbox" and "unread" tags from messages in a thread. - GMime 2.4 - --------- - GMime 2.4 provides decoding of MIME email messages for Notmuch. + GMime 2.4 or 2.6 + ---------------- + GMime provides decoding of MIME email messages for Notmuch. Without GMime, Notmuch would not be able to extract and index the actual text from email message encoded as BASE64, etc. - GMime 2.4 is available from http://spruce.sourceforge.net/gmime/ + GMime is available from http://spruce.sourceforge.net/gmime/ Talloc ------ @@ -62,16 +60,19 @@ which are each described below: Talloc is available from http://talloc.samba.org/ -On a modern, package-based operating system such as Debian, you can -install all of the dependencies with the following simple command -line: +On a modern, package-based operating system you can install all of the +dependencies with a simple simple command line. For example: - sudo apt-get install libxapian-dev libgmime-2.4-dev libtalloc-dev + For Debian and similar: -On other systems, a similar command can be used, but the details of -the package names may be different, (such as "devel" in place of -"dev"). + sudo apt-get install libxapian-dev libgmime-2.6-dev libtalloc-dev + + For Fedora and similar: + sudo yum install xapian-core-devel gmime-devel libtalloc-devel + +On other systems, a similar command can be used, but the details of +the package names may be different.