blob: 2d3fe44cc0c4190938e8c348cbaa20bf0470367b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
Installation
************
.. rubric:: dependencies
Alot depends on recent versions of notmuch and urwid. Note that due to restrictions
on argparse and subprocess, you need to run *`python ≥ `3.5`* (see :ref:`faq <faq_7>`).
A full list of dependencies is below:
* `libmagic and python bindings <http://darwinsys.com/file/>`_, ≥ `5.04`
* `configobj <http://www.voidspace.org.uk/python/configobj.html>`_, ≥ `4.7.0`
* `twisted <http://twistedmatrix.com/trac/>`_, ≥ `10.2.0`:
* `libnotmuch <http://notmuchmail.org/>`_ and it's python bindings, ≥ `0.13`
* `urwid <http://excess.org/urwid/>`_ toolkit, ≥ `1.3.0`
* `urwidtrees <https://github.com/pazz/urwidtrees>`_, ≥ `1.0`
* `gpg <http://www.gnupg.org/related_software/gpgme>`_ and it's python bindings, ≥ `1.9.0`
.. note:: urwidtrees was only recently detached from alot and is not widely
available as a separate package. You can install it e.g., via
`pip <https://pypi.python.org/pypi/pip>`_ directly from github:
.. code-block:: sh
pip install --user https://github.com/pazz/urwidtrees/archive/master.zip
On debian/ubuntu the rest are packaged as::
python-setuptools python-magic python-configobj python-twisted python-notmuch python-urwid python-gpg
On fedora/redhat these are packaged as::
python-setuptools python-magic python-configobj python-twisted python-notmuch python-urwid python-gpg
Alot uses `mailcap <http://en.wikipedia.org/wiki/Mailcap>`_ to look up mime-handler for inline
rendering and opening of attachments. For a full description of the maicap protocol consider the
manpage :manpage:`mailcap(5)` or :rfc:`1524`. To avoid surprises you should at least have an inline
renderer (copiousoutput) set up for `text/html`, i.e. have something like this in your
:file:`~/.mailcap`::
text/html; w3m -dump -o document_charset=%{charset} '%s'; nametemplate=%s.html; copiousoutput
.. rubric:: get and install alot
You can use `pip` to install directly from GitHub::
$ pip install --user https://github.com/pazz/alot/archive/master.zip
Don't have pip installed? Just download and extract, then run::
python setup.py install --user
Make sure :file:`~/.local/bin` is in your :envvar:`PATH`. For system-wide
installation omit the `--user` flag and call with the respective permissions.
.. rubric:: generate manual and manpage
To generate the documentation you need `sphinx <http://sphinx.pocoo.org/>`_, ≥ `1.07` installed.
Go to :file:`docs/` and do a::
make html
make man
to generate the user manual and a man page. Both will end up in their respective subfolders in
:file:`docs/build`.
|
