diff options
| author | William Erik Baxter <web@superscript.com> | 2012-09-08 20:37:49 -0400 |
|---|---|---|
| committer | Patrick Totzke <patricktotzke@gmail.com> | 2012-09-23 14:05:02 +0100 |
| commit | ac018a00f61c96ec95ac3ef1ad1cdbf986c81b24 (patch) | |
| tree | 21bde2cc9562f72dc9a43347f7e57388b3d5eb6b /docs | |
| parent | ad744db5666c953b17b2ddf82f28d8edcd83f560 (diff) | |
Add docs for search modification functions.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/configuration/alotrc_table | 2 | ||||
| -rw-r--r-- | docs/source/usage/modes/search.rst | 53 |
2 files changed, 55 insertions, 0 deletions
diff --git a/docs/source/configuration/alotrc_table b/docs/source/configuration/alotrc_table index 64f415f5..92ba32b1 100644 --- a/docs/source/configuration/alotrc_table +++ b/docs/source/configuration/alotrc_table @@ -101,6 +101,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 |