summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2012-11-07 09:26:52 +0000
committerPatrick Totzke <patricktotzke@gmail.com>2012-11-07 09:26:52 +0000
commitdd784938d4fbc14372e0f73abfe4b622c81dd9a1 (patch)
tree664f80f94f548d35341d93cd5a7cffa4bf339804 /docs
parent793e090bf29017abb041f696c8b1601261c425df (diff)
parentf2d65413f5e9fdb56831c633aff70b1ea552b46a (diff)
Merge remote-tracking branch 'origin/0.3.3-feature-tagsearch-517'
Conflicts: alot/commands/thread.py
Diffstat (limited to 'docs')
-rw-r--r--docs/source/configuration/alotrc_table2
-rw-r--r--docs/source/usage/modes/search.rst53
2 files changed, 55 insertions, 0 deletions
diff --git a/docs/source/configuration/alotrc_table b/docs/source/configuration/alotrc_table
index e2a20e50..ec0e8abb 100644
--- a/docs/source/configuration/alotrc_table
+++ b/docs/source/configuration/alotrc_table
@@ -111,6 +111,8 @@
:default: From, To, Cc, Bcc, Subject
+ The pseudo-header "Tags" displays message tags.
+
.. _edit-headers-blacklist:
.. describe:: edit_headers_blacklist
diff --git a/docs/source/usage/modes/search.rst b/docs/source/usage/modes/search.rst
index 5347e44d..990d8f7a 100644
--- a/docs/source/usage/modes/search.rst
+++ b/docs/source/usage/modes/search.rst
@@ -27,6 +27,18 @@ The following commands are available in search mode
optional arguments
:---no-flush: postpone a writeout to the index (Defaults to: 'True').
+.. _cmd.search.untagsearch:
+
+.. describe:: untagsearch
+
+ remove tags from all messages in threads in the search results
+
+ argument
+ comma separated list of tags
+
+ optional arguments
+ :---no-flush: postpone a writeout to the index (Defaults to: 'True').
+
.. _cmd.search.retag:
.. describe:: retag
@@ -39,6 +51,18 @@ The following commands are available in search mode
optional arguments
:---no-flush: postpone a writeout to the index (Defaults to: 'True').
+.. _cmd.search.retagsearch:
+
+.. describe:: retagsearch
+
+ set tags of all messages in all threads in the search results
+
+ argument
+ comma separated list of tags
+
+ optional arguments
+ :---no-flush: postpone a writeout to the index (Defaults to: 'True').
+
.. _cmd.search.refineprompt:
.. describe:: refineprompt
@@ -58,6 +82,18 @@ The following commands are available in search mode
optional arguments
:---no-flush: postpone a writeout to the index (Defaults to: 'True').
+.. _cmd.search.tagsearch:
+
+.. describe:: tagsearch
+
+ add tags to all messages in all threads in the search results
+
+ argument
+ comma separated list of tags
+
+ optional arguments
+ :---no-flush: postpone a writeout to the index (Defaults to: 'True').
+
.. _cmd.search.refine:
.. describe:: refine
@@ -93,6 +129,23 @@ The following commands are available in search mode
optional arguments
:---no-flush: postpone a writeout to the index (Defaults to: 'True').
+.. _cmd.search.toggletagssearch:
+
+.. describe:: toggletagssearch
+
+ flip presence of tags on threads in the search results.
+ 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').
+
+
.. _cmd.search.select:
.. describe:: select