cli: fix notmuch help additional topics

[notmuch] / INSTALL

diff --git a/INSTALL b/INSTALL
index 9cf328eea3186910ad9dd5cbbc44893325d46b74..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
        ------


@@ -49,14 +39,14 @@ which are each described below:
        reading mail while notmuch would wait for Xapian when removing
        the "inbox" and "unread" tags from messages in a thread.
 
        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
        ------


@@ -70,16 +60,30 @@ which are each described below:
 
        Talloc is available from http://talloc.samba.org/
 
 
        Talloc is available from http://talloc.samba.org/
 

+Building Documentation
+----------------------
+
+By default the documentation for notmuch is built using sphinx.
+
+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:
 
 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
+        sudo apt-get install libxapian-dev libgmime-2.6-dev libtalloc-dev python-sphinx

 
   For Fedora and similar:
 
 
   For Fedora and similar:
 

-       sudo yum install xapian-core-devel gmime-devel libtalloc-devel
+       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.
 
 On other systems, a similar command can be used, but the details of
 the package names may be different.