summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2012-06-20 08:31:28 +0100
committerPatrick Totzke <patricktotzke@gmail.com>2012-06-20 08:31:28 +0100
commit08fc4031b97d00a6086d8e1449fd34dbc607848f (patch)
treef4712b0f56f89e26be7fe3d12c67baeb56b9fe9a /docs
parentf3be84ab6537894051da4bab6716337e76e95b5f (diff)
doc: update and change default right statusbar entry
.. from "total: N" to "total messages: N"
Diffstat (limited to 'docs')
-rw-r--r--docs/source/configuration/alotrc_table.rst25
-rw-r--r--docs/source/usage/modes/envelope.rst2
2 files changed, 17 insertions, 10 deletions
diff --git a/docs/source/configuration/alotrc_table.rst b/docs/source/configuration/alotrc_table.rst
index e2f7dcde..567a9c74 100644
--- a/docs/source/configuration/alotrc_table.rst
+++ b/docs/source/configuration/alotrc_table.rst
@@ -50,12 +50,13 @@
Format of the status-bar in bufferlist mode.
This is a pair of strings to be left and right aligned in the status-bar that may contain variables:
-
+
* `{buffer_no}`: index of this buffer in the global buffer list
* `{total_messages}`: total numer of messages indexed by notmuch
+ * `{pending_writes}`: number of pending write operations to the index
:type: mixed_list
- :default: [{buffer_no}: bufferlist], total: {total_messages}
+ :default: [{buffer_no}: bufferlist], total messages: {total_messages}
.. _bug-on-exit:
@@ -160,7 +161,7 @@
.. describe:: editor_spawn
use terminal_command to spawn a new terminal for the editor?
- equivalent to always providing the `--spawn` parameter to compose/edit commands
+ equivalent to always providing the `--spawn=yes` parameter to compose/edit commands
:type: boolean
:default: False
@@ -194,11 +195,11 @@
This is a pair of strings to be left and right aligned in the status-bar.
Apart from the global variables listed at :ref:`bufferlist_statusbar <bufferlist-statusbar>`
these strings may contain variables:
-
+
* `{to}`: To-header of the envelope
:type: mixed_list
- :default: [{buffer_no}: envelope], total: {total_messages}
+ :default: [{buffer_no}: envelope], total messages: {total_messages}
.. _flush-retry-timeout:
@@ -316,9 +317,11 @@
these strings may contain variables:
* `{querystring}`: search string
+ * `{result_count}`: number of matching messages
+ * `{result_count_positive}`: 's' if result count is greater than 0.
:type: mixed_list
- :default: [{buffer_no}: search] for "{querystring}", total: {total_messages}
+ :default: [{buffer_no}: search] for "{querystring}", {result_count} of {total_messages} messages
.. _search-threads-sort-order:
@@ -357,9 +360,11 @@
Format of the status-bar in taglist mode.
This is a pair of strings to be left and right aligned in the status-bar.
+ These strings may contain variables listed at :ref:`bufferlist_statusbar <bufferlist-statusbar>`
+ that will be substituted accordingly.
:type: mixed_list
- :default: [{buffer_no}: taglist], total: {total_messages}
+ :default: [{buffer_no}: taglist], total messages: {total_messages}
.. _template-dir:
@@ -433,12 +438,14 @@
This is a pair of strings to be left and right aligned in the status-bar.
Apart from the global variables listed at :ref:`bufferlist_statusbar <bufferlist-statusbar>`
these strings may contain variables:
-
+
* `{tid}`: thread id
* `{subject}`: subject line of the thread
+ * `{authors}`: abbreviated authors string for this thread
+ * `{message_count}`: number of contained messages
:type: mixed_list
- :default: [{buffer_no}: thread] {subject}, total: {total_messages}
+ :default: [{buffer_no}: thread] {subject}, total messages: {total_messages}
.. _timestamp-format:
diff --git a/docs/source/usage/modes/envelope.rst b/docs/source/usage/modes/envelope.rst
index 3422e6e5..126178fa 100644
--- a/docs/source/usage/modes/envelope.rst
+++ b/docs/source/usage/modes/envelope.rst
@@ -51,7 +51,7 @@ ____
edit mail
optional arguments
- :---spawn: spawn editor in new terminal.
+ :---spawn: force spawning of editor in a new terminal.
:---refocus: refocus envelope after editing (Defaults to: 'True').
.. _cmd_envelope_send: