summaryrefslogtreecommitdiff
path: root/docs/source/installation/index.rst
blob: 5298ce342e1239a1cdc627e2560cb70ee9bb8514 (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
66
67
68
69
70
71
72
73
74
75
76
77
78
*****
Installation
*****

INSTALL
=======

Alot depends on recent versions of notmuch (>=0.10) and urwid (>=1.0). Note that due to restrictions
on argparse and subprocess, you need to run *python v>=2.7*, which only recently made it
into debian testing.

urwid
-----
make sure you have urwid v >=1.0. It is available on debian (wheezy)
and in *buntu 12.04. To install from git use::

    git clone http://github.com/wardi/urwid
    cd urwid
    sudo python setup.py install

It seems you need the python headers for this. On debian/ubuntu::

    aptitude install python2.7-dev

 notmuch
-------
install notmuch *and* python bindings from git::

    git clone git://notmuchmail.org/git/notmuch

    cd notmuch
    ./configure
    make
    sudo make install
    cd bindings/python
    python setup.py install --user


alot
----
get alot and install it from git::

    git clone git://github.com/pazz/alot alot
    cd alot
    python setup.py install --user
    make sure `~/.local/bin` is in your path.


other dependencies
------------------
* python bindings to libmagic, greater or equal than v5.04:

  * http://darwinsys.com/file/
  This is packaged as 'python-magic' in debian/ubuntu.
* python configobj module:

  * http://www.voidspace.org.uk/python/configobj.html
  * http://pypi.python.org/pypi/configobj
  This is packaged as 'python-configobj' in debian/ubuntu.

* a mailcap file (I recommend installing 'mime-support' on debian/ubuntu).
   This is used to determine the commands to call when opening attachments
   or text-rendering parts that are not plaintext, e.g. text/html.
   Make sure you have a inline renderer for text/html set in your mailcap as otherwise
   html mails will not display:
   
       text/html;  w3m -dump %s; nametemplate=%s.html; copiousoutput


All other configs are optional, but if you want to send mails you need to specify at least one
account section in your config::

    [accounts]
        [[your account name]]
            realname = Your Name
            address = your@address

See the :file:`/docs/user` for how to do fancy customization.