X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=INSTALL;h=b543c5085e3278b494e501f3c991c1a56ff8d5a1;hp=e51b397cc2a9d77a56424074775dfcdaf4b5abfb;hb=4e2c351c588ad74f4800ca0344232be90387c54a;hpb=ecfc8df47627fde618a338b88d10e710a5611d3b diff --git a/INSTALL b/INSTALL index e51b397c..b543c508 100644 --- a/INSTALL +++ b/INSTALL @@ -20,8 +20,8 @@ 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.4 or 2.6, +Talloc, and zlib which are each described below: Xapian ------ @@ -39,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. - 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. - GMime 2.4 is available from http://spruce.sourceforge.net/gmime/ + GMime is available from http://spruce.sourceforge.net/gmime/ Talloc ------ @@ -60,16 +60,42 @@ which are each described below: Talloc is available from http://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 http://zlib.net + +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: - sudo apt-get install libxapian-dev libgmime-2.4-dev libtalloc-dev + 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 + 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.