summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2012-09-01 23:29:57 +0100
committerPatrick Totzke <patricktotzke@gmail.com>2012-09-01 23:29:57 +0100
commit3286c8084aa3970dbba5200774a5c38481a8750a (patch)
treec9779115b95cc6a107c992dd3e19a1f31f567a4e
parent4c8572d41d74760165569b4de10dc2904e70ef54 (diff)
doc: clean up
-rw-r--r--alot/defaults/alot.rc.spec2
-rw-r--r--alot/defaults/default.bindings6
-rw-r--r--docs/source/configuration/accounts_table2
-rw-r--r--docs/source/configuration/alotrc_table20
-rw-r--r--docs/source/configuration/index.rst3
-rw-r--r--docs/source/configuration/key_bindings.rst8
6 files changed, 24 insertions, 17 deletions
diff --git a/alot/defaults/alot.rc.spec b/alot/defaults/alot.rc.spec
index 63689e9f..73ecc95d 100644
--- a/alot/defaults/alot.rc.spec
+++ b/alot/defaults/alot.rc.spec
@@ -223,7 +223,7 @@ forward_subject_prefix = string(default='Fwd: ')
sent_tags = force_list(default=list('sent'))
# path to signature file that gets attached to all outgoing mails from this account, optionally
- # renamed to ref:`signature_filename <signature-filename>`.
+ # renamed to :ref:`signature_filename <signature-filename>`.
signature = string(default=None)
# attach signature file if set to True, append its content (mimetype text)
diff --git a/alot/defaults/default.bindings b/alot/defaults/default.bindings
index 1eddd7b0..3ccb3e2b 100644
--- a/alot/defaults/default.bindings
+++ b/alot/defaults/default.bindings
@@ -1,9 +1,3 @@
-###########################################################################
-# Default Key Bindings #
-# #
-# for alot. © 2012 Patrick Totzke, GNU GPL3+ https://github.com/pazz/alot #
-###########################################################################
-
up = move up
down = move down
page up = move page up
diff --git a/docs/source/configuration/accounts_table b/docs/source/configuration/accounts_table
index aea1956c..872afac2 100644
--- a/docs/source/configuration/accounts_table
+++ b/docs/source/configuration/accounts_table
@@ -85,7 +85,7 @@
.. describe:: signature
path to signature file that gets attached to all outgoing mails from this account, optionally
- renamed to ref:`signature_filename <signature-filename>`.
+ renamed to :ref:`signature_filename <signature-filename>`.
:type: string
:default: None
diff --git a/docs/source/configuration/alotrc_table b/docs/source/configuration/alotrc_table
index 051d6ea5..64f415f5 100644
--- a/docs/source/configuration/alotrc_table
+++ b/docs/source/configuration/alotrc_table
@@ -46,7 +46,7 @@
* `{pending_writes}`: number of pending write operations to the index
:type: mixed_list
- :default: [{buffer_no}: bufferlist], total messages: {total_messages}
+ :default: [{buffer_no}: bufferlist], {input_queue} total messages: {total_messages}
.. _bug-on-exit:
@@ -189,7 +189,7 @@
* `{to}`: To-header of the envelope
:type: mixed_list
- :default: [{buffer_no}: envelope], total messages: {total_messages}
+ :default: [{buffer_no}: envelope], {input_queue} total messages: {total_messages}
.. _flush-retry-timeout:
@@ -233,6 +233,16 @@
:default: "search tag:inbox AND NOT tag:killed"
+.. _input-timeout:
+
+.. describe:: input_timeout
+
+ timeout in (floating point) seconds until partial input is cleared
+
+ :type: float
+ :default: 1.0
+
+
.. _notify-timeout:
.. describe:: notify_timeout
@@ -311,7 +321,7 @@
* `{result_count_positive}`: 's' if result count is greater than 0.
:type: mixed_list
- :default: [{buffer_no}: search] for "{querystring}", {result_count} of {total_messages} messages
+ :default: [{buffer_no}: search] for "{querystring}", {input_queue} {result_count} of {total_messages} messages
.. _search-threads-sort-order:
@@ -354,7 +364,7 @@
that will be substituted accordingly.
:type: mixed_list
- :default: [{buffer_no}: taglist], total messages: {total_messages}
+ :default: [{buffer_no}: taglist], {input_queue} total messages: {total_messages}
.. _template-dir:
@@ -435,7 +445,7 @@
* `{message_count}`: number of contained messages
:type: mixed_list
- :default: [{buffer_no}: thread] {subject}, total messages: {total_messages}
+ :default: [{buffer_no}: thread] {subject}, {input_queue} total messages: {total_messages}
.. _timestamp-format:
diff --git a/docs/source/configuration/index.rst b/docs/source/configuration/index.rst
index e10fcf1b..98c123ca 100644
--- a/docs/source/configuration/index.rst
+++ b/docs/source/configuration/index.rst
@@ -16,7 +16,8 @@ All configs are optional, but if you want to send mails you need to specify at l
:ref:`account <config.accounts>` in your config.
.. toctree::
-
+ :maxdepth: 2
+
config_options
accounts
contacts_completion
diff --git a/docs/source/configuration/key_bindings.rst b/docs/source/configuration/key_bindings.rst
index 55aef763..40d5b500 100644
--- a/docs/source/configuration/key_bindings.rst
+++ b/docs/source/configuration/key_bindings.rst
@@ -29,16 +29,18 @@ Known modes are:
Have a look at `the urwid User Input documentation <http://excess.org/urwid/wiki/UserInput>`_ on how key strings are formatted.
-.. _cofig.key-bingings.defaults:
+.. _config.key-bingings.defaults:
-.. rubric:: Default bindings
+Default bindings
+----------------
User-defined bindings are combined with the default bindings listed below.
.. literalinclude:: ../../../alot/defaults/default.bindings
:language: ini
-.. rubric:: Overwriting defaults
+Overwriting defaults
+--------------------
To disable a global binding you can redefine it in your config to point to an empty command string.
For example, to add a new global binding for key `a`, which is bound to `toggletags inbox` in search