diff options
author | Patrick Totzke <patricktotzke@gmail.com> | 2012-06-19 22:38:04 +0100 |
---|---|---|
committer | Patrick Totzke <patricktotzke@gmail.com> | 2012-06-19 22:38:04 +0100 |
commit | f3be84ab6537894051da4bab6716337e76e95b5f (patch) | |
tree | 631cdfe0dd586926a614ac41cfc40543136d3ccf /docs | |
parent | f49f87c637458ffb33a765cde8746fe08dd08509 (diff) |
doc: check in generated docs for statusbar feature
Diffstat (limited to 'docs')
-rw-r--r-- | docs/source/configuration/alotrc_table.rst | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/source/configuration/alotrc_table.rst b/docs/source/configuration/alotrc_table.rst index 8c495bc8..e2f7dcde 100644 --- a/docs/source/configuration/alotrc_table.rst +++ b/docs/source/configuration/alotrc_table.rst @@ -44,6 +44,20 @@ :default: -1 +.. _bufferlist-statusbar: + +.. describe:: bufferlist_statusbar + + 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 + + :type: mixed_list + :default: [{buffer_no}: bufferlist], total: {total_messages} + + .. _bug-on-exit: .. describe:: bug_on_exit @@ -172,6 +186,21 @@ :default: In-Reply-To, References +.. _envelope-statusbar: + +.. describe:: envelope_statusbar + + Format of the status-bar in envelope mode. + 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} + + .. _flush-retry-timeout: .. describe:: flush_retry_timeout @@ -277,6 +306,21 @@ :default: `Re: ` +.. _search-statusbar: + +.. describe:: search_statusbar + + Format of the status-bar in search mode. + 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: + + * `{querystring}`: search string + + :type: mixed_list + :default: [{buffer_no}: search] for "{querystring}", total: {total_messages} + + .. _search-threads-sort-order: .. describe:: search_threads_sort_order @@ -307,6 +351,17 @@ :default: 8 +.. _taglist-statusbar: + +.. describe:: taglist_statusbar + + Format of the status-bar in taglist mode. + This is a pair of strings to be left and right aligned in the status-bar. + + :type: mixed_list + :default: [{buffer_no}: taglist], total: {total_messages} + + .. _template-dir: .. describe:: template_dir @@ -370,6 +425,22 @@ :default: True +.. _thread-statusbar: + +.. describe:: thread_statusbar + + Format of the status-bar in thread mode. + 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 + + :type: mixed_list + :default: [{buffer_no}: thread] {subject}, total: {total_messages} + + .. _timestamp-format: .. describe:: timestamp_format |