summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2012-02-24 09:06:29 +0000
committerPatrick Totzke <patricktotzke@gmail.com>2012-02-24 09:06:29 +0000
commit6862f786661b48a9523468421968172e95270216 (patch)
tree2a452c715e1e89ac7d9300eb2289873d66567c93 /docs/source
parente323733aa62d92cdcb232ad155f45399f6fc5a61 (diff)
docs love
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/configuration/alotrc_table.rst110
-rw-r--r--docs/source/configuration/index.rst3
2 files changed, 56 insertions, 57 deletions
diff --git a/docs/source/configuration/alotrc_table.rst b/docs/source/configuration/alotrc_table.rst
index e842cc3b..acf6755d 100644
--- a/docs/source/configuration/alotrc_table.rst
+++ b/docs/source/configuration/alotrc_table.rst
@@ -3,34 +3,27 @@
ask for subject when compose
-.. describe:: bug_on_exit
+.. describe:: authors_maxlength
- confirm exit
+ max length of authors line in thread widgets
.. describe:: bufferclose_focus_offset
offset of next focussed buffer if the current one gets closed
-.. describe:: colourmode
-
- number of colours your terminal supports
-
-.. describe:: tabwidth
-
- number of spaces used to replace tab characters
-
-.. describe:: template_dir
+.. describe:: bug_on_exit
- templates directory that contains your message templates.
- It will be used if you give `compose --template` a filename without a path prefix.
+ confirm exit
-.. describe:: themes_dir
+.. describe:: colourmode
- directory containing theme files
+ number of colours your terminal supports
-.. describe:: theme
+.. describe:: complete_matching_abook_only
- name of the theme to use
+ in case more than one account has an address book:
+ Set this to True to make tabcompletion for recipients during compose only
+ look in the abook of the account matching the sender address
.. describe:: display_content_in_threadline
@@ -40,41 +33,37 @@
headers that get displayed by default
-.. describe:: envelope_headers_blacklist
+.. describe:: edit_headers_blacklist
- headers that are hidden in envelope buffers by default
-.. describe:: terminal_cmd
+.. describe:: edit_headers_whitelist
- set terminal command used for spawning shell commands
+ Which header fields should be editable in your editor
+ used are those that match the whitelist and don't macht the blacklist.
+ in both cases '*' may be used to indicate all fields.
.. describe:: editor_cmd
editor command
if unset, alot will first try the EDITOR env variable, then /usr/bin/editor
-.. describe:: editor_writes_encoding
-
- file encoding used by your editor
-
-.. describe:: editor_spawn
-
- use terminal_command to spawn a new terminal for the editor?
-
.. describe:: editor_in_thread
call editor in separate thread.
In case your editor doesn't run in the same window as alot, setting true here
will make alot non-blocking during edits
-.. describe:: edit_headers_whitelist
+.. describe:: editor_spawn
- Which header fields should be editable in your editor
- used are those that match the whitelist and don't macht the blacklist.
- in both cases '*' may be used to indicate all fields.
+ use terminal_command to spawn a new terminal for the editor?
-.. describe:: edit_headers_blacklist
+.. describe:: editor_writes_encoding
+
+ file encoding used by your editor
+
+.. describe:: envelope_headers_blacklist
+ headers that are hidden in envelope buffers by default
.. describe:: flush_retry_timeout
@@ -84,22 +73,13 @@
where to look up hooks
-.. describe:: notify_timeout
-
- time in secs to display status messages
-
-.. describe:: show_statusbar
-
- display statusline?
-
-.. describe:: timestamp_format
+.. describe:: initial_command
- timestamp format in strftime format syntax:
- http://docs.python.org/library/datetime.html#strftime-strptime-behavior
+ initial command when none is given as argument:
-.. describe:: authors_maxlength
+.. describe:: notify_timeout
- max length of authors line in thread widgets
+ time in secs to display status messages
.. describe:: print_cmd
@@ -108,23 +88,43 @@
threads/messages are piped to this as plaintext.
muttprint/a2ps works nicely
-.. describe:: initial_command
+.. describe:: quit_on_last_bclose
- initial command when none is given as argument:
+ shut down when the last buffer gets closed
.. describe:: search_threads_sort_order
default sort order of results in a search
-.. describe:: complete_matching_abook_only
+.. describe:: show_statusbar
- in case more than one account has an address book:
- Set this to True to make tabcompletion for recipients during compose only
- look in the abook of the account matching the sender address
+ display statusline?
-.. describe:: quit_on_last_bclose
+.. describe:: tabwidth
- shut down when the last buffer gets closed
+ number of spaces used to replace tab characters
+
+.. describe:: template_dir
+
+ templates directory that contains your message templates.
+ It will be used if you give `compose --template` a filename without a path prefix.
+
+.. describe:: terminal_cmd
+
+ set terminal command used for spawning shell commands
+
+.. describe:: theme
+
+ name of the theme to use
+
+.. describe:: themes_dir
+
+ directory containing theme files
+
+.. describe:: timestamp_format
+
+ timestamp format in strftime format syntax:
+ http://docs.python.org/library/datetime.html#strftime-strptime-behavior
.. describe:: user_agent
diff --git a/docs/source/configuration/index.rst b/docs/source/configuration/index.rst
index 285725f5..94b5e347 100644
--- a/docs/source/configuration/index.rst
+++ b/docs/source/configuration/index.rst
@@ -33,7 +33,7 @@ Here is an example configuration::
[[secret]]
realname = Batman
address = batman@batcave.org
- aliases = batman@batmobile.org
+ aliases = batman@batmobile.org,
sendmail_command = msmtp --account=batman -t
signature = ~/.batman.vcf
signature_as_attachment = True
@@ -107,7 +107,6 @@ Known modes are:
* thread
* taglist
* bufferlist
-* global
Have a look at `the urwid User Input documentation <http://excess.org/urwid/wiki/UserInput>`_ on how key strings are formated.