emacs: Add new option notmuch-search-hide-excluded

[notmuch] / INSTALL

diff --git a/INSTALL b/INSTALL
index 690b0efd27eaa60b404d2ca72da11699d7dc9162..8054fafa1d34a05637323058e316b035bcd7fdff 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -20,8 +20,8 @@ configure stage.
 
 Dependencies
 ------------
-Notmuch depends on three libraries: Xapian, GMime 2.4 or 2.6, and
-Talloc which are each described below:
+Notmuch depends on four libraries: Xapian, GMime 3.0,
+Talloc, and zlib which are each described below:
 
        Xapian
        ------
@@ -30,23 +30,25 @@ Talloc which are each described below:
        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
 
-       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
+       -----
        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 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
        ------
@@ -58,32 +60,44 @@ Talloc which are each described below:
        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/
+
+       zlib
+       ----
+
+       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.
+
+       Notmuch needs the transparent write feature of zlib introduced
+       in version 1.2.5.2 (Dec. 2011).
+
+       zlib is available from https://zlib.net
 
 Building Documentation
 ----------------------
 
-By default the documentation for notmuch is built using sphinx.
+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.
 
-If you prefer, you can build the man pages using rst2man, from the
-python docutils package. See doc/INSTALL for details.
-
+To install the documentation as "info" pages, you will need the
+additional tools makeinfo and install-info.
 
 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:
+dependencies with a single simple command line. For example:
 
   For Debian and similar:
 
-        sudo apt-get install libxapian-dev libgmime-2.6-dev libtalloc-dev python-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 python-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.