Commit graph

24 commits

Author SHA1 Message Date
David Bremner
40897af1fc INSTALL: document optional dependency on libsfsexp
For now putting it in the apt-get line will cause complaints about
missing packages for too many people.
2021-10-15 08:49:01 -03:00
David Bremner
8908779999 doc: drop note about early versions of Xapian
Mathias Beyer [1] points out that this note is redudant since Xapian
no longer builds with the problematic versions of Xapian.

[1]: id:20210207124404.yldgtzjrsagacrl4@hoshi
2021-08-03 19:29:34 -03:00
David Bremner
f981f5bae0 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-07-03 06:31:54 -03:00
David Bremner
570349e132 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-03 06:49:49 -03:00
David Bremner
7a6d4a0852 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-26 08:26:13 -07:00
Daniel Kahn Gillmor
c20a5eb805 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-05-03 20:59:20 -03:00
David Bremner
431c41a4f2 INSTALL: fix typo 2018-01-12 20:48:22 -04:00
Daniel Kahn Gillmor
1b9eec0041 INSTALL: refer to python3-sphinx
We're now preferring to build with python3 instead of python2.  Update
the INSTALL to match.

Thanks to Antoine Amarilli <a3nm@a3nm.net> for pointing this out!
2018-01-12 20:47:13 -04:00
David Bremner
8e69663a8b INSTALL: suggest gmime-3.x
Since we deprecated support for GMime 2.6...
2017-12-08 21:01:17 -04:00
Daniel Kahn Gillmor
6a833a6e83 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-05 08:32:17 -03:00
David Bremner
005c2f0df1 cli/lib: remove support for GMime 2.4
It's becoming a maintenance burden to do anything things with the
crypto glue code twice, once for 2.4 and once for 2.6. I don't have
any 2.4 version available to test on my development machine anymore,
so the 2.4 specific code paths are likely not very well tested.
2015-08-26 20:01:45 -03:00
David Bremner
d241a486fa 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-22 08:37:25 +01:00
David Bremner
3c13bc0321 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-04-12 07:59:44 -03:00
David Bremner
d736260385 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-03-09 10:41:08 -03:00
Austin Clements
308107e5ff Recommend libgmime-2.6-dev in INSTALL
Given that everything prefers 2.6 over 2.4, it seems appropriate to
suggest that people install the 2.6 dev package instead of 2.4.
2012-05-24 21:54:30 -03:00
Thomas Jost
6d0fcea4e4 Update NEWS and INSTALL about gmime 2.6 2012-01-21 08:55:08 -04:00
Carl Worth
ecfc8df476 INSTALL/README: Clean up the description of how to run the emacs interface.
The INSTALL file still had old information about the "make
install-emacs" command which no longer exists. README was also giving
pointers on how to develop a real interface, (which is not the right
thing since README should be addressed to users, not coders).

So remove the stale and misplaced information, and instead add a new
"Running notmuch" section to the README describing how to run the
notmuch command-line interface and how to run the emacs interface.
2010-06-01 10:51:42 -07:00
Carl Worth
bb1f03f0b9 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 10:51:42 -07:00
Carl Worth
a875e17211 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 12:13:32 -08:00
Carl Worth
21a92c6cce 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 12:13:32 -08:00
Carl Worth
aac1d60352 INSTALL/notmuch.el: More details on how to install/run notmuch.el
Hopefully this will save some people some head-scratching trying
to figure out how to use it.
2009-11-21 21:40:57 +01:00
Stefan Schmidt
0414c774d2 INSTALL: emacs install dokumentation.
Write down the steps needed to install and actuall use notmuch in emacs. Should
help emacs newbies.

Signed-off-by: Stefan Schmidt <stefan@datenfreihafen.org>
2009-11-21 21:34:25 +01:00
Carl Worth
6732aa1b14 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
Carl Worth
1b10c32a52 Add an INSTALL file.
The README file was already referring to this, so we actually add it
now.
2009-11-02 09:25:04 -08:00