From b070edadee3583b0e5e8326e981e4117f2e85d72 Mon Sep 17 00:00:00 2001
From: Patrick Totzke <patricktotzke@gmail.com>
Date: Sat, 23 Jun 2018 17:02:47 +0100
Subject: update docs

---
 docs/source/configuration/alotrc_table   | 13 +++++++++++++
 docs/source/usage/modes/global.rst       | 33 ++++++++++++++++++++++++++++++++
 docs/source/usage/modes/namedqueries.rst | 17 ++++++++++++++++
 docs/source/usage/modes/search.rst       | 14 ++++++++++++++
 4 files changed, 77 insertions(+)
 create mode 100644 docs/source/usage/modes/namedqueries.rst

(limited to 'docs')

diff --git a/docs/source/configuration/alotrc_table b/docs/source/configuration/alotrc_table
index 5806f7bd..8cc208bd 100644
--- a/docs/source/configuration/alotrc_table
+++ b/docs/source/configuration/alotrc_table
@@ -391,6 +391,19 @@
     :default: True
 
 
+.. _namedqueries-statusbar:
+
+.. describe:: namedqueries_statusbar
+
+     Format of the status-bar in named query list 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}: namedqueries], {query_count} named queries
+
+
 .. _notify-timeout:
 
 .. describe:: notify_timeout
diff --git a/docs/source/usage/modes/global.rst b/docs/source/usage/modes/global.rst
index 6e79c67a..1831a6cb 100644
--- a/docs/source/usage/modes/global.rst
+++ b/docs/source/usage/modes/global.rst
@@ -117,6 +117,13 @@ The following commands are available globally
         up, down, [half]page up, [half]page down, first, last
 
 
+.. _cmd.global.namedqueries:
+
+.. describe:: namedqueries
+
+    opens named queries buffer
+
+
 .. _cmd.global.prompt:
 
 .. describe:: prompt
@@ -148,6 +155,18 @@ The following commands are available globally
     Reload all configuration files
 
 
+.. _cmd.global.removequery:
+
+.. describe:: removequery
+
+    removes a "named query" from the database
+
+    argument
+        alias to remove
+
+    optional arguments
+        :---no-flush: postpone a writeout to the index (Defaults to: 'True').
+
 .. _cmd.global.repeat:
 
 .. describe:: repeat
@@ -155,6 +174,20 @@ The following commands are available globally
     Repeats the command executed last time
 
 
+.. _cmd.global.savequery:
+
+.. describe:: savequery
+
+    store query string as a "named query" in the database
+
+    positional arguments
+        0: alias to use for query string
+        1: query string to store
+
+
+    optional arguments
+        :---no-flush: postpone a writeout to the index (Defaults to: 'True').
+
 .. _cmd.global.search:
 
 .. describe:: search
diff --git a/docs/source/usage/modes/namedqueries.rst b/docs/source/usage/modes/namedqueries.rst
new file mode 100644
index 00000000..ee0217a4
--- /dev/null
+++ b/docs/source/usage/modes/namedqueries.rst
@@ -0,0 +1,17 @@
+.. CAUTION: THIS FILE IS AUTO-GENERATED!
+
+
+Commands in `namedqueries` mode
+-------------------------------
+The following commands are available in namedqueries mode
+
+.. _cmd.namedqueries.select:
+
+.. describe:: select
+
+    search for messages with selected query
+
+    argument
+        additional filter to apply to query
+
+
diff --git a/docs/source/usage/modes/search.rst b/docs/source/usage/modes/search.rst
index bdfeb48b..43872eec 100644
--- a/docs/source/usage/modes/search.rst
+++ b/docs/source/usage/modes/search.rst
@@ -54,6 +54,20 @@ The following commands are available in search mode
     prompt to retag selected thread's or message's tags
 
 
+.. _cmd.search.savequery:
+
+.. describe:: savequery
+
+    store query string as a "named query" in the database. This falls back to the current search query in search buffers.
+
+    positional arguments
+        0: alias to use for query string
+        1: query string to store
+
+
+    optional arguments
+        :---no-flush: postpone a writeout to the index (Defaults to: 'True').
+
 .. _cmd.search.select:
 
 .. describe:: select
-- 
cgit v1.2.3