diff options
| -rw-r--r-- | INSTALL | 8 | ||||
| -rw-r--r-- | README (renamed from README.rst) | 14 | ||||
| -rw-r--r-- | USAGE | 68 |
3 files changed, 48 insertions, 42 deletions
@@ -7,7 +7,7 @@ you need to run *python v>=2.7*. 1. urwid -------- -make sure you have urwid V>= 1.0:: +make sure you have urwid V>= 1.0 git clone http://github.com/wardi/urwid cd urwid @@ -19,7 +19,7 @@ On debian/ubuntu\::: 2. notmuch ---------- -install notmuch *and* python bindings from git\::: +install notmuch *and* python bindings from git: git clone git://notmuchmail.org/git/notmuch cd notmuch @@ -31,7 +31,7 @@ install notmuch *and* python bindings from git\::: 3. alot ------- -get alot and install it from git\::: +get alot and install it from git: git clone git://github.com/pazz/alot alot cd alot @@ -45,7 +45,7 @@ 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\::: +specify at least one account section in you config: [account uoe] realname = Your Name @@ -1,11 +1,10 @@ -This is a proposal for a terminal gui for `notmuch mail <http://notmuchmail.org/>`, -written in python using the `urwid <http://excess.org/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 <https://github.com/pazz/alot/wiki>`. -The API docs for the current master branch are `here <http://pazz.github.com/alot/>`, +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. Do comment on the code or file issues! I'm curious what you think of it. @@ -33,3 +32,8 @@ Soonish to be addressed non-features: * folding for message parts * undo for commands * addressbook integration + +[notmuch]: http://notmuchmail.org/ +[urwid]: http://excess.org/urwid/ +[api]: http://pazz.github.com/alot/ +[wiki]: https://github.com/pazz/alot/wiki @@ -3,7 +3,7 @@ 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\::: +in the config file. These are the default keymaps: [global-maps] $ = flush @@ -63,27 +63,27 @@ The default location for the config file is ~/.alot.rc. You can find a complete example config in data/example.full.rc. Here is a key for the interpreted sections: -[general] - global settings: set your editor etc - -[account X] - defines the account X: realname, email address, sendmail - -[X-maps] - defines keymaps for mode X. possible modes are: - envelope, search, thread, taglist, bufferlist and global. - global-maps are valid in all modes. - -[tag-translate] - defines a map from tagnames to strings that is used when - displaying tags. utf-8 symbols welcome. - -[Xc-theme] - define colour palette for colour mode. X is in {1, 16, 256}. + [general] + global settings: set your editor etc + + [account X] + defines the account X: realname, email address, sendmail + + [X-maps] + defines keymaps for mode X. possible modes are: + envelope, search, thread, taglist, bufferlist and global. + global-maps are valid in all modes. + + [tag-translate] + defines a map from tagnames to strings that is used when + displaying tags. utf-8 symbols welcome. + + [Xc-theme] + define colour palette for colour mode. X is in {1, 16, 256}. All configs are optional, but if you want to send mails you need to specify at least one account section. -A sample gmail section looks like this\::: +A sample gmail section looks like this: [account gmail] realname = Patrick Totzke @@ -93,7 +93,7 @@ A sample gmail section looks like this\::: sender_type = sendmail sendmail_command = msmtp --account=gmail -t -I use this for my uni-account\::: +I use this for my uni-account: [account uoe] realname = Patrick Totzke @@ -120,22 +120,24 @@ For every command X, the callable 'pre_X' will be called before X and 'post_X' a When a hook gets called, it receives instances of -1. `alot.ui.UI`, the main user interface object that can prompt etc. -2. `alot.db.DBManager`, the applications database manager -3. `alot.account.AccountManager`, can be used to look up account info -4. `alot.settings.config`, a configparser to access the users config +1. `alot.ui.UI`, the main user interface object that can prompt etc. +2. `alot.db.DBManager`, the applications database manager +3. `alot.account.AccountManager`, can be used to look up account info +4. `alot.settings.config`, a configparser to access the users config An autogenerated API doc for these can be found at http://pazz.github.com/alot/ , the sphinx sources live in the `docs` folder. As an example, consider this pre-hook for the exit command, -that logs a personalized goodby message\::: +that logs a personalized goodby message: - def pre_exit(ui, dbman, accountman, config): - accounts = accountman.get_accounts() - if accounts: - ui.logger.info('goodbye, %s!' % accounts[0].realname) - else: - ui.logger.info('goodbye!') +```python +def pre_exit(ui, dbman, accountman, config): + accounts = accountman.get_accounts() + if accounts: + ui.logger.info('goodbye, %s!' % accounts[0].realname) + else: + ui.logger.info('goodbye!') +``` Theming @@ -153,7 +155,7 @@ http://excess.org/urwid/browser/palette_test.py See `data/example.full.rc` for a complete list of widgets that can be themed. Moreover, keywords that start with "tag_" will be used to display specific tags. For instance, you -can use the following to always display the "todo" tag in white on red, when in 256c-mode. :: +can use the following to always display the "todo" tag in white on red, when in 256c-mode. [256c-theme] tag_todo_bg = #d66 @@ -163,7 +165,7 @@ You can translate tag strings before displaying them using the [tag-translate] s A key=value statement in this section is interpreted as: Always display the tag `key` as string `value`. Utf-8 symbols are welcome here. See e.g. http://panmental.de/symbols/info.htm -I personally display my maildir flags like this\::: +I personally display my maildir flags like this: [tag-translate] flagged = ⚑ |