]> git.notmuchmail.org Git - notmuch/blobdiff - INSTALL
added syntax files for search and show screens
[notmuch] / INSTALL
diff --git a/INSTALL b/INSTALL
index 5a63211d26ee076fbfde466386f5ffb75e1f09c3..c0b67a319642a41e2ec9b86009a60745cfe71598 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -14,6 +14,16 @@ Notmuch are satisfied. If they are not, the configure script will
 notice that and provide instructions on where to obtain the necessary
 dependencies.
 
 notice that and provide instructions on where to obtain the necessary
 dependencies.
 
+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
 ------------
 Notmuch depends on three libraries: Xapian, GMime 2.4, and Talloc
 Dependencies
 ------------
 Notmuch depends on three libraries: Xapian, GMime 2.4, and Talloc
@@ -28,6 +38,11 @@ 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 ).
+
        GMime 2.4
        ---------
        GMime 2.4 provides decoding of MIME email messages for Notmuch.
        GMime 2.4
        ---------
        GMime 2.4 provides decoding of MIME email messages for Notmuch.