]> git.notmuchmail.org Git - notmuch/blobdiff - INSTALL
emacs: Add new option notmuch-search-hide-excluded
[notmuch] / INSTALL
diff --git a/INSTALL b/INSTALL
index 69f9df7e0ada594ce2a3e9010b87da0251389bad..8054fafa1d34a05637323058e316b035bcd7fdff 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -20,7 +20,7 @@ configure stage.
 
 Dependencies
 ------------
-Notmuch depends on four libraries: Xapian, GMime 2.6,
+Notmuch depends on four libraries: Xapian, GMime 3.0,
 Talloc, and zlib which are each described below:
 
        Xapian
@@ -32,13 +32,6 @@ Talloc, and zlib which are each described below:
 
        Xapian is available from https://xapian.org
 
-       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
        -----
        GMime provides decoding of MIME email messages for Notmuch.
@@ -46,7 +39,16 @@ Talloc, and zlib which are each described below:
        Without GMime, Notmuch would not be able to extract and index
        the actual text from email message encoded as BASE64, etc.
 
-       GMime is available from http://spruce.sourceforge.net/gmime/
+       GMime is available from https://github.com/jstedfast/gmime
+
+        Sfsexp
+        ------
+
+        sfsexp is the "small fast s-expression" library. Notmuch
+        optionally use it to provide a second query parser.
+
+        sfsexp is available from https://github.com/mjsottile/sfsexp.
+        In Debian Bookworm and later, install libsexp-dev.
 
        Talloc
        ------
@@ -70,7 +72,7 @@ Talloc, and zlib which are each described below:
        Notmuch needs the transparent write feature of zlib introduced
        in version 1.2.5.2 (Dec. 2011).
 
-       zlib is available from http://zlib.net
+       zlib is available from https://zlib.net
 
 Building Documentation
 ----------------------
@@ -80,6 +82,9 @@ of sphinx (Jul. 2010).
 
 Sphinx is available from www.sphinx-doc.org.
 
+To install the documentation as "info" pages, you will need the
+additional tools makeinfo and install-info.
+
 Installing Dependencies from Packages
 -------------------------------------
 
@@ -88,11 +93,11 @@ dependencies with a single simple command line. For example:
 
   For Debian and similar:
 
-        sudo apt-get install libxapian-dev libgmime-3.0-dev libtalloc-dev zlib1g-dev python3-sphinx
+        sudo apt-get install libxapian-dev libgmime-3.0-dev libtalloc-dev zlib1g-dev python3-sphinx texinfo install-info
 
   For Fedora and similar:
 
-       sudo yum install xapian-core-devel gmime-devel libtalloc-devel zlib-devel python3-sphinx
+       sudo dnf install xapian-core-devel gmime30-devel libtalloc-devel zlib-devel python3-sphinx texinfo info
 
 On other systems, a similar command can be used, but the details of
 the package names may be different.