diff options
author | Patrick Totzke <patricktotzke@gmail.com> | 2011-10-24 10:42:37 +0100 |
---|---|---|
committer | Patrick Totzke <patricktotzke@gmail.com> | 2011-10-24 10:42:37 +0100 |
commit | b66ccfd799f60c14d94eba8a1b9ca4c20e52674a (patch) | |
tree | b013ff59062d51c30d7d3b6ca6090afed9c3523f | |
parent | 19bd46e24aeebbed3089ae891c082f99c2ed6bfd (diff) |
updated docs
-rw-r--r-- | COSTOMIZE.md (renamed from USAGE.md) | 64 | ||||
-rw-r--r-- | INSTALL.md (renamed from INSTALL) | 25 | ||||
-rw-r--r-- | README.md | 35 |
3 files changed, 36 insertions, 88 deletions
@@ -1,63 +1,3 @@ -Usage -===== -In all views, arrows, page-up/down, j,k and space can be used to move the focus. -Escape cancels prompts. You can hit ":" at any time and type in commands -to the prompt. Any commandline can be mapped by using the "MODE-maps" sections -in the config file. These are the default keymaps: - - [global-maps] - @ = refresh - I = search tag:inbox AND NOT tag:killed - L = taglist - shift tab = bprevious - U = search tag:unread - tab = bnext - \ = 'prompt search ' - d = bclose - $ = flush - m = compose - o = 'prompt search ' - q = exit - ';' = bufferlist - colon = prompt - - [bufferlist-maps] - x = closefocussed - enter = openfocussed - - [search-maps] - a = toggletag inbox - & = toggletag killed - l = retagprompt - O = refineprompt - enter = openthread - | = refineprompt - - [envelope-maps] - a = prompt attach ~/ - y = send - s = 'prompt subject ' - t = 'prompt to ' - enter = reedit - - [taglist-maps] - enter = select - - [thread-maps] - C = fold --all - E = unfold --all - H = toggleheaders - P = print --thread - S = save --all - a = toggletag inbox - g = groupreply - f = forward - p = print - s = save - r = reply - enter = select - | = 'prompt pipeto ' - Config ------ Just like offlineimap or notmuch itself, alot reads a config file in the "INI" syntax: @@ -65,7 +5,7 @@ It consists of some sections whose names are given in square brackets, followed key-value pairs that use "=" or ":" as separator, ';' and '#' are comment-prefixes. The default location for the config file is `~/.config/alot/config`. -You can find a complete example config with the default values in +You can find a complete example config with the default values and their decriptions in `alot/defaults/alot.rc`. Note that since ":" is a separator for key-value pairs you need to use "colon" to bind @@ -117,7 +57,6 @@ I use this for my uni-account: signature_filename = p.totzke.vcs abook_command = abook --mutt-query - Caution: Sending mails is only supported via sendmail for now. If you want to use a sendmail command different from `sendmail`, specify it as `sendmail_command`. @@ -180,7 +119,6 @@ Apart from command pre and posthooks, the following hooks will be interpreted: Receives and returns a string. - Theming ------- You can change the colour settings in the section `[Xc-theme]`, where X is the @@ -1,20 +1,19 @@ INSTALL ======= -Alot depends on development versions of notmuch and urwid. -Note that due to restrictions on argparse and subprocess, -you need to run *python v>=2.7*. +Alot depends on development versions of notmuch and urwid. 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 +make sure you have urwid v >=1.0. 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: +It seems you need the python headers for this. On debian/ubuntu: aptitude install python2.7-dev @@ -43,16 +42,16 @@ get alot and install it from git: That's it, now `alot` should be in your path. -Alot tries to be as unobtrusive as possible, with one exception: -It forces you to use UTF-8 encoding whereever it can: -All text parts and headers of outgoing emails are converted to utf-8, -notmuch tagstrings, edited emails and config files are interpreted as utf-8. +Alot tries to be as unobtrusive as possible, with one exception: It forces you to use +UTF-8 encoding whereever it can: All text parts and headers of outgoing emails are +converted to utf-8, notmuch tagstrings, edited emails and config files are interpreted as +Utf-8. -All configs are optional, but if you want to send mails you need to -specify at least one account section in you config: +All configs are optional, but if you want to send mails you need to specify at least one +account section in your config: [account uoe] realname = Your Name address = your@address -See USAGE for default keymaps and how to do fancy customization. +See `CUSTOMIZE.md` on how to do fancy customization. @@ -1,30 +1,31 @@ -This is a proposal for a terminal gui for [notmuch mail][notmuch] -written in python using the [urwid][urwid] toolkit. +This is a proposal for a terminal gui for [notmuch mail][notmuch] written in +python using the [urwid][urwid] toolkit. -You can find some old screenshots in `data/alot*png`, -the files `INSTALL` and `USAGE` contain instructions on how to set it up, -use and customize. These files are nicely rendered in the [github wiki][wiki]. -The API docs for the current master branch are [here][api]. -the `docs` directory contains their sources. +The files `INSTALL.md` and `CUSTOMIZE.md` contain instructions on how to set it +up and customize respectively. + +(slightly outdated) autogenerated API docs for the current master branch 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 monochromatic, 16 or 256 colours + * 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 - * tab completion for commands and querystrings * priorizable notification popups * database manager that manages a write queue to the notmuch index - * user configurable keyboard maps - * printing/piping of mails and threads - * addressbook integration (dev branch) Soonish to be addressed non-features: ------------------------------------- @@ -33,6 +34,16 @@ Soonish to be addressed non-features: * 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/ |