summaryrefslogtreecommitdiff
path: root/README.md
blob: 6562d70dd113b7cfd842fdb6cde3f086911f157c (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
Alot is a terminal interface for [notmuch mail][notmuch] written in 
python using the [urwid][urwid] toolkit.

The files `INSTALL.md` and `CUSTOMIZE.md` contain instructions on how to set it
up and customize respectively.

Autogenerated API docs for the current release can be found [here][api].
Their sources live in the `docs` directory.

Do comment on the code or file issues! I'm curious what you think of it.
You can talk to me in #notmuch@Freenode.

Current features include:
-------------------------
 * modular and command prompt driven interface
 * tab completion and usage help for all commands
 * completion using addressbook lookups
 * user configurable keyboard maps
 * spawn terminals for asynchronous editing of mails
 * theming, optionally in 2, 16 or 256 colours
 * tag specific theming and tagstring translation
 * a hook system to inject one's own python code
 * python shell for introspection
 * forward/reply/group-reply of emails
 * printing/piping of mails and threads
 * multiple accounts for sending mails via sendmail
 * priorizable notification popups
 * database manager that manages a write queue to the notmuch index

Soonish to be addressed non-features:
-------------------------------------
 * encryption/decryption for messages
 * search for strings in displayed buffer
 * folding for message parts
 * undo for commands


Usage
=====
In all views, arrows, page-up/down, j,k and space can be used to move the focus.
Escape cancels prompts and Enter selects. Hit ":" at any time and type in commands
to the prompt.
Usage information on any command can be listed using `help YOURCOMMAND`.
The keybindings for the current mode are listet upon pressing '?'.


[notmuch]: http://notmuchmail.org/
[urwid]: http://excess.org/urwid/
[api]: http://pazz.github.com/alot/
[wiki]: https://github.com/pazz/alot/wiki