summaryrefslogtreecommitdiff
path: root/docs/source/usage/modes/search.rst
diff options
context:
space:
mode:
authorDylan Baker <dylan@pnwbakers.com>2018-02-28 09:21:30 -0800
committerDylan Baker <dylan@pnwbakers.com>2018-03-01 10:35:20 -0800
commit72fe673a82b5b973951e3d5612a16089903f0b47 (patch)
treed5b19079a56a32990663a12b31414ea9a62fed90 /docs/source/usage/modes/search.rst
parent4405696c67ca0f5d6d9249744eb0e34059a6f774 (diff)
docs: regenerate again, hopefully for the last time
Diffstat (limited to 'docs/source/usage/modes/search.rst')
-rw-r--r--docs/source/usage/modes/search.rst86
1 files changed, 43 insertions, 43 deletions
diff --git a/docs/source/usage/modes/search.rst b/docs/source/usage/modes/search.rst
index ed632e83..c95d1a01 100644
--- a/docs/source/usage/modes/search.rst
+++ b/docs/source/usage/modes/search.rst
@@ -5,28 +5,40 @@ Commands in `search` mode
-------------------------
The following commands are available in search mode
-.. _cmd.search.sort:
+.. _cmd.search.move:
-.. describe:: sort
+.. describe:: move
- set sort order
+ move focus in search buffer
argument
- sort order. valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`.
+ last
-.. _cmd.search.retagprompt:
+.. _cmd.search.refine:
-.. describe:: retagprompt
+.. describe:: refine
- prompt to retag selected threads' tags
+ refine query
+ argument
+ search string
-.. _cmd.search.untag:
+ optional arguments
+ :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`.
-.. describe:: untag
+.. _cmd.search.refineprompt:
- remove tags from all messages in the thread that match the query
+.. describe:: refineprompt
+
+ prompt to change this buffers querystring
+
+
+.. _cmd.search.retag:
+
+.. describe:: retag
+
+ set tags of all messages in the thread that match the current query
argument
comma separated list of tags
@@ -35,27 +47,29 @@ The following commands are available in search mode
:---no-flush: postpone a writeout to the index (Defaults to: 'True').
:---all: retag all messages in search result.
-.. _cmd.search.move:
+.. _cmd.search.retagprompt:
-.. describe:: move
+.. describe:: retagprompt
- move focus in search buffer
+ prompt to retag selected threads' tags
- argument
- last
+.. _cmd.search.select:
-.. _cmd.search.toggletags:
+.. describe:: select
-.. describe:: toggletags
+ open thread in a new buffer
- flip presence of tags on this thread. A tag is considered present if at least one message contained in this thread is tagged with it. In that case this command will remove the tag from every message in the thread.
+
+.. _cmd.search.sort:
+
+.. describe:: sort
+
+ set sort order
argument
- comma separated list of tags
+ sort order. valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`.
- optional arguments
- :---no-flush: postpone a writeout to the index (Defaults to: 'True').
.. _cmd.search.tag:
@@ -70,30 +84,23 @@ The following commands are available in search mode
:---no-flush: postpone a writeout to the index (Defaults to: 'True').
:---all: retag all messages in search result.
-.. _cmd.search.refine:
+.. _cmd.search.toggletags:
-.. describe:: refine
+.. describe:: toggletags
- refine query
+ flip presence of tags on this thread. A tag is considered present if at least one message contained in this thread is tagged with it. In that case this command will remove the tag from every message in the thread.
argument
- search string
+ comma separated list of tags
optional arguments
- :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`.
-
-.. _cmd.search.refineprompt:
-
-.. describe:: refineprompt
-
- prompt to change this buffers querystring
-
+ :---no-flush: postpone a writeout to the index (Defaults to: 'True').
-.. _cmd.search.retag:
+.. _cmd.search.untag:
-.. describe:: retag
+.. describe:: untag
- set tags of all messages in the thread that match the current query
+ remove tags from all messages in the thread that match the query
argument
comma separated list of tags
@@ -102,10 +109,3 @@ The following commands are available in search mode
:---no-flush: postpone a writeout to the index (Defaults to: 'True').
:---all: retag all messages in search result.
-.. _cmd.search.select:
-
-.. describe:: select
-
- open thread in a new buffer
-
-