debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-22 19:08:09 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
notmuch/INSTALL

105 lines
3 KiB
Text
Raw Permalink Normal View History

Add an INSTALL file. The README file was already referring to this, so we actually add it now.
2009-11-02 18:25:04 +01:00
Build and install instructions for Notmuch.
Compilation commands
--------------------
The process for compiling and installing Notmuch is the very standard
sequence of:
./configure
make
sudo make install
INSTALL: Add a pointer to ./configure --help We have some good documentation in ./configure --help, so we should direct users to it.
2010-03-09 21:11:47 +01:00
In fact, if you don't plan to pass any arguments to the configure
script, then you can skip that step and just start with "make", (which
will call configure for you). See this command:
./configure --help
for detailed documentation of the things you can control at the
configure stage.
Add an INSTALL file. The README file was already referring to this, so we actually add it now.
2009-11-02 18:25:04 +01:00
Dependencies
------------
build: drop support for gmime-2.6 GMime 3.0 is over 2 years old now, and 2.6 has been deprecated in notmuch for about 1.5 years. Comments and documentation no longer need to refer to GMime 2.6, so clean them all up. Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-05-02 15:19:33 +02:00
Notmuch depends on four libraries: Xapian, GMime 3.0,
dump: support gzipped and atomic output The main goal is to support gzipped output for future internal calls (e.g. from notmuch-new) to notmuch_database_dump. The additional dependency is not very heavy since xapian already pulls in zlib. We want the dump to be "atomic", in the sense that after running the dump file is either present and complete, or not present. This avoids certain classes of mishaps involving overwriting a good backup with a bad or partial one.
2014-03-29 02:14:51 +01:00
Talloc, and zlib which are each described below:
Add an INSTALL file. The README file was already referring to this, so we actually add it now.
2009-11-02 18:25:04 +01:00
Xapian
------
Xapian is the search-engine library underlying Notmuch.
It provides all the real machinery of indexing and searching,
(including the very nice parsing of the query string).
Use https instead of http where possible Many of the external links found in the notmuch source can be resolved using https instead of http. This changeset addresses as many as i could find, without touching the e-mail corpus or expected outputs found in tests.
2016-06-02 18:26:14 +02:00
Xapian is available from https://xapian.org
Add an INSTALL file. The README file was already referring to this, so we actually add it now.
2009-11-02 18:25:04 +01:00
INSTALL: Note the advantages of Xapian 1.0.18+ and 1.1.4+ These versions provide greatly desired performance advantages for notmuch. Previously, theses details existed in an old NEWS entry, but most users are unlikely to find those details there. Put them here where we mention the Xapian dependency.
2010-06-01 19:42:43 +02:00
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.
INSTALL: Mention that xapian-config might be named xapian-config-1.1 As reported on the mailing list.
2009-11-21 19:52:06 +01:00
INSTALL: suggest gmime-3.x Since we deprecated support for GMime 2.6...
2017-12-09 02:01:17 +01:00
GMime
-----
Update NEWS and INSTALL about gmime 2.6
2012-01-20 10:39:25 +01:00
GMime provides decoding of MIME email messages for Notmuch.
Add an INSTALL file. The README file was already referring to this, so we actually add it now.
2009-11-02 18:25:04 +01:00
Without GMime, Notmuch would not be able to extract and index
the actual text from email message encoded as BASE64, etc.
move more http -> https Correct URLs that have crept into the notmuch codebase with http:// when https:// is possible. As part of this conversion, this changeset also indicates the current preferred upstream URLs for both gmime and sup. the new URLs are https-enabled, the old ones are not. This also fixes T310-emacs.sh, thanks to Bremner for catching it.
2018-04-29 10:35:30 +02:00
GMime is available from https://github.com/jstedfast/gmime
Add an INSTALL file. The README file was already referring to this, so we actually add it now.
2009-11-02 18:25:04 +01:00
Talloc
------
Talloc is a memory-pool allocator used by Notmuch.
Talloc is an extremely lightweight and easy-to-use tool for
allocating memory in a hierarchical fashion and then freeing
it with a single call of the top-level handle. Using it has
made development of Notmuch much easier and much less prone to
memory leaks.
Use https instead of http where possible Many of the external links found in the notmuch source can be resolved using https instead of http. This changeset addresses as many as i could find, without touching the e-mail corpus or expected outputs found in tests.
2016-06-02 18:26:14 +02:00
Talloc is available from https://talloc.samba.org/
Add an INSTALL file. The README file was already referring to this, so we actually add it now.
2009-11-02 18:25:04 +01:00
dump: support gzipped and atomic output The main goal is to support gzipped output for future internal calls (e.g. from notmuch-new) to notmuch_database_dump. The additional dependency is not very heavy since xapian already pulls in zlib. We want the dump to be "atomic", in the sense that after running the dump file is either present and complete, or not present. This avoids certain classes of mishaps involving overwriting a good backup with a bad or partial one.
2014-03-29 02:14:51 +01:00
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).
move more http -> https Correct URLs that have crept into the notmuch codebase with http:// when https:// is possible. As part of this conversion, this changeset also indicates the current preferred upstream URLs for both gmime and sup. the new URLs are https-enabled, the old ones are not. This also fixes T310-emacs.sh, thanks to Bremner for catching it.
2018-04-29 10:35:30 +02:00
zlib is available from https://zlib.net
dump: support gzipped and atomic output The main goal is to support gzipped output for future internal calls (e.g. from notmuch-new) to notmuch_database_dump. The additional dependency is not very heavy since xapian already pulls in zlib. We want the dump to be "atomic", in the sense that after running the dump file is either present and complete, or not present. This avoids certain classes of mishaps involving overwriting a good backup with a bad or partial one.
2014-03-29 02:14:51 +01:00
doc: convert sphinx based docs This is the output from sphinx-quickstart, massaged a bit, along with our existing man pages converted to rst. A skeleton notmuch-emacs manual is also included. It is not suitable for end user use yet.
2014-01-28 17:12:37 +01:00
Building Documentation
----------------------
doc: remove support for rst2man It was becoming increasingly complicated to support rst2man, and there were apparently not many people that relied on it.
2015-01-18 17:55:10 +01:00
To build the documentation for notmuch you need at least version 1.0
of sphinx (Jul. 2010).
doc: convert sphinx based docs This is the output from sphinx-quickstart, massaged a bit, along with our existing man pages converted to rst. A skeleton notmuch-emacs manual is also included. It is not suitable for end user use yet.
2014-01-28 17:12:37 +01:00
Sphinx is available from www.sphinx-doc.org.
doc: install build and install info pages All of the man pages are installed as info pages, plus the (unfinished) notmuch-emacs manual
2018-05-21 22:08:51 +02:00
To install the documentation as "info" pages, you will need the
additional tools makeinfo and install-info.
doc: convert sphinx based docs This is the output from sphinx-quickstart, massaged a bit, along with our existing man pages converted to rst. A skeleton notmuch-emacs manual is also included. It is not suitable for end user use yet.
2014-01-28 17:12:37 +01:00
Installing Dependencies from Packages
-------------------------------------
INSTALL: Include Fedora command for installing dependencies of notmuch. We already had this command in the error message from the configure script, so we should include it here as well.
2010-03-09 21:12:32 +01:00
On a modern, package-based operating system you can install all of the
INSTALL: fix typo
2018-01-13 01:48:22 +01:00
dependencies with a single simple command line. For example:
INSTALL: Include Fedora command for installing dependencies of notmuch. We already had this command in the error message from the configure script, so we should include it here as well.
2010-03-09 21:12:32 +01:00
For Debian and similar:
Add an INSTALL file. The README file was already referring to this, so we actually add it now.
2009-11-02 18:25:04 +01:00
doc: install build and install info pages All of the man pages are installed as info pages, plus the (unfinished) notmuch-emacs manual
2018-05-21 22:08:51 +02:00
sudo apt-get install libxapian-dev libgmime-3.0-dev libtalloc-dev zlib1g-dev python3-sphinx texinfo install-info
Add an INSTALL file. The README file was already referring to this, so we actually add it now.
2009-11-02 18:25:04 +01:00
INSTALL: Include Fedora command for installing dependencies of notmuch. We already had this command in the error message from the configure script, so we should include it here as well.
2010-03-09 21:12:32 +01:00
For Fedora and similar:
Add an INSTALL file. The README file was already referring to this, so we actually add it now.
2009-11-02 18:25:04 +01:00
doc: update install suggestions for fedora derivatives Fedora still has an old gmime-devel which is 2.6.x. This is no longer supported by notmuch. Also apparently dnf is a better choice than yum.
2020-06-26 13:11:00 +02:00
sudo dnf install xapian-core-devel gmime30-devel libtalloc-devel zlib-devel python3-sphinx texinfo info
INSTALL: Include Fedora command for installing dependencies of notmuch. We already had this command in the error message from the configure script, so we should include it here as well.
2010-03-09 21:12:32 +01:00
On other systems, a similar command can be used, but the details of
the package names may be different.
Add an INSTALL file. The README file was already referring to this, so we actually add it now.
2009-11-02 18:25:04 +01:00
Reference in a new issue Copy permalink