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 four libraries: Xapian, GMime 2.6,
+Talloc, and zlib which are each described below:
Xapian
------
It provides all the real machinery of indexing and searching,
(including the very nice parsing of the query string).
- Xapian is available from http://xapian.org
+ Xapian is available from https://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.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
------
made development of Notmuch much easier and much less prone to
memory leaks.
- Talloc is available from http://talloc.samba.org/
+ Talloc is available from https://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:
+ zlib
+ ----
- sudo apt-get install libxapian-dev libgmime-2.4-dev libtalloc-dev
+ zlib is an extremely popular compression library. It is used
+ by Xapian, so if you installed that you will already have
+ zlib. You may need to install the zlib headers separately.
-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").
+ Notmuch needs the transparent write feature of zlib introduced
+ in version 1.2.5.2 (Dec. 2011).
+
+ zlib is available from http://zlib.net
+
+Building Documentation
+----------------------
+
+To build the documentation for notmuch you need at least version 1.0
+of sphinx (Jul. 2010).
+
+Sphinx is available from www.sphinx-doc.org.
+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 zlib1g-dev python-sphinx
+
+ For Fedora and similar:
+
+ sudo yum install xapian-core-devel gmime-devel libtalloc-devel zlib-devel python-sphinx
+
+On other systems, a similar command can be used, but the details of
+the package names may be different.