X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=INSTALL;h=bc98f1dec86ac2989aa1d67d402e725c33415233;hp=5a63211d26ee076fbfde466386f5ffb75e1f09c3;hb=bf28c60b9facb898d52759c2be993acac67c26d2;hpb=1b10c32a5291f6f540f69bb7d4fb753937e23805 diff --git a/INSTALL b/INSTALL index 5a63211d..bc98f1de 100644 --- a/INSTALL +++ b/INSTALL @@ -9,15 +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: + + ./configure --help + +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 ------ @@ -28,14 +32,21 @@ which are each described below: Xapian is available from http://xapian.org - GMime 2.4 - --------- - GMime 2.4 provides decoding of MIME email messages for Notmuch. + 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 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 ------ @@ -49,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: + + For Debian and similar: sudo apt-get install libxapian-dev libgmime-2.4-dev libtalloc-dev -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"). + 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.