summaryrefslogtreecommitdiff
path: root/docs/source/usage/modes/search.rst
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2012-02-11 11:28:32 +0000
committerPatrick Totzke <patricktotzke@gmail.com>2012-02-11 11:28:32 +0000
commitccb576780e37da9c29e08c6aea901d561f298ee0 (patch)
tree20541d5dc1a36549058dee16c3576432142714b8 /docs/source/usage/modes/search.rst
parentc3561539399dc70021045ac57ed31c9b46e8df78 (diff)
joined and cleaned up user/api docs
Diffstat (limited to 'docs/source/usage/modes/search.rst')
-rw-r--r--docs/source/usage/modes/search.rst108
1 files changed, 108 insertions, 0 deletions
diff --git a/docs/source/usage/modes/search.rst b/docs/source/usage/modes/search.rst
new file mode 100644
index 00000000..6a8632d5
--- /dev/null
+++ b/docs/source/usage/modes/search.rst
@@ -0,0 +1,108 @@
+search
+------
+The following commands are available in search mode
+
+.. index:: sort
+
+sort
+____
+
+set sort order
+
+argument
+ sort order. valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`.
+
+
+.. index:: untag
+
+untag
+_____
+
+remove tags from all messages in the thread
+
+argument
+ comma separated list of tags
+
+optional arguments
+ :---no-flush: postpone a writeout to the index (Defaults to: 'True').
+
+.. index:: retag
+
+retag
+_____
+
+set tags of all messages in the thread
+
+argument
+ comma separated list of tags
+
+optional arguments
+ :---no-flush: postpone a writeout to the index (Defaults to: 'True').
+
+.. index:: refineprompt
+
+refineprompt
+____________
+
+prompt to change this buffers querystring
+
+
+.. index:: tag
+
+tag
+___
+
+add tags to all messages in the thread
+
+argument
+ comma separated list of tags
+
+optional arguments
+ :---no-flush: postpone a writeout to the index (Defaults to: 'True').
+
+.. index:: refine
+
+refine
+______
+
+refine query
+
+argument
+ search string
+
+optional arguments
+ :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`.
+
+.. index:: retagprompt
+
+retagprompt
+___________
+
+prompt to retag selected threads' tags
+
+
+.. index:: toggletags
+
+toggletags
+__________
+
+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
+ comma separated list of tags
+
+optional arguments
+ :---no-flush: postpone a writeout to the index (Defaults to: 'True').
+
+.. index:: select
+
+select
+______
+
+open thread in a new buffer
+
+