diff options
| -rw-r--r-- | CUSTOMIZE.md | 46 | ||||
| -rw-r--r-- | FAQ.md | 5 |
2 files changed, 43 insertions, 8 deletions
diff --git a/CUSTOMIZE.md b/CUSTOMIZE.md index 5ea4484e..6315eb33 100644 --- a/CUSTOMIZE.md +++ b/CUSTOMIZE.md @@ -1,5 +1,5 @@ -Config ------- +Configfile Layout +------------------ Just like offlineimap or notmuch itself, alot reads a config file in the "INI" syntax: It consists of some sections whose names are given in square brackets, followed by key-value pairs that use "=" or ":" as separator, ';' and '#' are comment-prefixes. @@ -33,6 +33,10 @@ Here is a key for the interpreted sections: All configs are optional, but if you want to send mails you need to specify at least one account section. + + +Account Sections +---------------- A sample gmail section looks like this (provided you have configured msmtp accordingly): [account gmail] @@ -82,6 +86,32 @@ defaults to `(?P<email>.+?@.+?)\s+(?P<name>.+)`, which makes it work nicely with You can tune this using the `abook_regexp` option (beware Commandparsers escaping semantic!). +Key Bindings +------------ +If you want to bind a commandline to a key you can do so by adding the pair to the +`[MODE-maps]` config section, where MODE is the buffer mode you want the binding to hold. +Consider the following lines, which allow you to send mails in envelope buffers using the +combination `control` + `s`: + + [envelope-maps] + ctrl s = send + +Possible MODE strings are: + + * envelope + * search + * thread + * taglist + * bufferlist + * global + +Bindings defined in section `[global-maps]` are valid in all modes. + +Have a look at [the urwid User Input documentation][keys] on how key strings are formated. + +[keys]: http://excess.org/urwid/wiki/UserInput + + Hooks ----- Hooks are python callables that live in a module specified by @@ -133,14 +163,14 @@ Apart from command pre and posthooks, the following hooks will be interpreted: Receives and returns a string. -Theming +Colours ------- You can change the colour settings in the section `[Xc-theme]`, where X is the colour mode you use. This defaults to 256, but 16 and 1 are also possible. The colourmode can be changed in the globals section or given as a commandline parameter (-C). The keys in this section should be self explanatory. In 16c and 256c modes you can define Y_fg and -Y_bg for the foreground and background of each keyword Y. These can define colorcodes and flags +Y_bg for the foreground and background of each keyword Y. These can define colourcodes and flags like `underline` or `bold`, comma separated if you want more than one. See urwids doc on Attributes: http://excess.org/urwid/reference.html#AttrSpec Urwid privides a neat script that makes choosing colours easy, which can be found here: @@ -148,8 +178,12 @@ http://excess.org/urwid/browser/palette_test.py See the contents of `alot/defaults/alot.rc` for a complete list of widgets that can be themed. -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. + +Custom Tagstring formating +-------------------------- +Keywords in the theme sections 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. [256c-theme] tag_todo_bg = #d66 @@ -39,10 +39,11 @@ think we should implement it. We'll discuss it from there. Why are the default key bindings so counter-intuitive? --------------------------------------------------- -I choose the bindings to be natural for me. I use vim and [pentadactyl][pd] a lot. +Be aware that the bindings for all modes are fully configurable (see the CUSTOMIZE.md). +That said, I choose the bindings to be natural for me. I use vim and [pentadactyl][pd] a lot. However, I'd be interested in discussing the defaults. If you think your bindings are more intuitive or better suited as defaults for some reason, -don't hesitate to tell me. The same holds for the theme settings you use. +don't hesitate to send me your config. The same holds for the theme settings you use. Tell me. Let's improve the defaults. How do I do contacts completion? |