diff options
| -rw-r--r-- | INSTALL.md | 4 | ||||
| -rw-r--r-- | docs/source/configuration/index.rst | 2 | ||||
| -rw-r--r-- | docs/source/index.rst | 3 | ||||
| -rw-r--r-- | docs/source/installation/index.rst | 78 |
4 files changed, 86 insertions, 1 deletions
@@ -54,6 +54,10 @@ other dependencies http://pypi.python.org/pypi/configobj This is packaged as 'python-configobj' in debian/ubuntu. + * python twisted module: + http://twistedmatrix.com/trac/ + This is packaged as 'python-twisted' 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. diff --git a/docs/source/configuration/index.rst b/docs/source/configuration/index.rst index b0bacb4a..5226454a 100644 --- a/docs/source/configuration/index.rst +++ b/docs/source/configuration/index.rst @@ -1,3 +1,5 @@ +.. _configuration: + ************* Configuration ************* diff --git a/docs/source/index.rst b/docs/source/index.rst index adcb8425..ef0368dc 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -10,7 +10,8 @@ User Manual .. toctree:: :maxdepth: 2 :numbered: - + + installation/index usage/index configuration/index api/index diff --git a/docs/source/installation/index.rst b/docs/source/installation/index.rst new file mode 100644 index 00000000..0dba1f15 --- /dev/null +++ b/docs/source/installation/index.rst @@ -0,0 +1,78 @@ +***** +Installation +***** + +Dependencies +======= + +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. + +* python twisted module: + + * http://twistedmatrix.com/trac/ + This is packaged as 'python-twisted' 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 +:ref:`account <account>` in your config. + +See the :ref:`configuration <configuration>` for how to do fancy customization. |