]> git.notmuchmail.org Git - notmuch/blobdiff - INSTALL
util: Fix two corner-cases in boolean term quoting function
[notmuch] / INSTALL
diff --git a/INSTALL b/INSTALL
index cadd3cec76ef43c7e804eb0aba66ecb0d7745595..690b0efd27eaa60b404d2ca72da11699d7dc9162 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -18,20 +18,10 @@ will call configure for you). See this command:
 for detailed documentation of the things you can control at the
 configure stage.
 
 for detailed documentation of the things you can control at the
 configure stage.
 
-notmuch.el installation
------------------------
-Installing the notmuch.el emacs lisp function systemwide:
-
-       sudo make install-emacs
-
-Each user needs to add (require 'notmuch) in his ~/.emacs to make it
-available and then start emacs running notmuch with "emacs -f notmuch"
-or start notmuch from within emacs with "M-x notmuch".
-
 Dependencies
 ------------
 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
        ------
 
        Xapian
        ------
@@ -42,19 +32,21 @@ which are each described below:
 
        Xapian is available from http://xapian.org
 
 
        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.
 
 
        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
        ------
 
        Talloc
        ------
@@ -68,16 +60,33 @@ which are each described below:
 
        Talloc is available from http://talloc.samba.org/
 
 
        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:
+Building Documentation
+----------------------
 
 
-        sudo apt-get install libxapian-dev libgmime-2.4-dev libtalloc-dev
+By default the documentation for notmuch is built using sphinx.
 
 
-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").
+Sphinx is available from www.sphinx-doc.org.
+
+If you prefer, you can build the man pages using rst2man, from the
+python docutils package. See doc/INSTALL for details.
+
+
+Installing Dependencies from Packages
+-------------------------------------
 
 
+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.6-dev libtalloc-dev python-sphinx
+
+  For Fedora and similar:
+
+       sudo yum install xapian-core-devel gmime-devel libtalloc-devel python-sphinx
+
+On other systems, a similar command can be used, but the details of
+the package names may be different.