From c765ebd6041a845a800cc9fd30705102ae2d040f Mon Sep 17 00:00:00 2001 From: Patrick Totzke Date: Thu, 14 Feb 2013 15:01:57 +0000 Subject: docs: updated autogenerated command docs --- docs/source/usage/modes/bufferlist.rst | 4 +-- docs/source/usage/modes/global.rst | 24 ++++----------- docs/source/usage/modes/search.rst | 56 ++-------------------------------- docs/source/usage/modes/thread.rst | 35 ++++++++++++--------- 4 files changed, 32 insertions(+), 87 deletions(-) (limited to 'docs/source') diff --git a/docs/source/usage/modes/bufferlist.rst b/docs/source/usage/modes/bufferlist.rst index 79ec2e34..7de661e9 100644 --- a/docs/source/usage/modes/bufferlist.rst +++ b/docs/source/usage/modes/bufferlist.rst @@ -12,9 +12,9 @@ The following commands are available in bufferlist mode close focussed buffer -.. _cmd.bufferlist.select: +.. _cmd.bufferlist.open: -.. describe:: select +.. describe:: open focus selected buffer diff --git a/docs/source/usage/modes/global.rst b/docs/source/usage/modes/global.rst index ce105f2f..d5ca2ca1 100644 --- a/docs/source/usage/modes/global.rst +++ b/docs/source/usage/modes/global.rst @@ -11,6 +11,8 @@ The following commands are available globally close a buffer + optional arguments + :---force: never ask for confirmation. .. _cmd.global.bprevious: @@ -71,14 +73,14 @@ The following commands are available globally command or 'bindings' -.. _cmd.global.move: +.. _cmd.global.buffer: -.. describe:: move +.. describe:: buffer - move focus + focus buffer with given index argument - direction + buffer index to focus .. _cmd.global.shellescape: @@ -102,13 +104,6 @@ The following commands are available globally refresh the current buffer -.. _cmd.global.cancel: - -.. describe:: cancel - - send cancel event - - .. _cmd.global.pyshell: .. describe:: pyshell @@ -154,13 +149,6 @@ The following commands are available globally focus next buffer -.. _cmd.global.select: - -.. describe:: select - - send select event - - .. _cmd.global.taglist: .. describe:: taglist diff --git a/docs/source/usage/modes/search.rst b/docs/source/usage/modes/search.rst index 990d8f7a..39049864 100644 --- a/docs/source/usage/modes/search.rst +++ b/docs/source/usage/modes/search.rst @@ -26,18 +26,7 @@ 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'). + :---all: retag all messages in search result. .. _cmd.search.retag: @@ -50,18 +39,7 @@ 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'). + :---all: retag all messages in search result. .. _cmd.search.refineprompt: @@ -81,18 +59,7 @@ 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'). + :---all: retag all messages in search result. .. _cmd.search.refine: @@ -129,23 +96,6 @@ 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 diff --git a/docs/source/usage/modes/thread.rst b/docs/source/usage/modes/thread.rst index 40e475cc..83623259 100644 --- a/docs/source/usage/modes/thread.rst +++ b/docs/source/usage/modes/thread.rst @@ -21,7 +21,7 @@ The following commands are available in thread mode :---background: don't stop the interface. :---add_tags: add 'Tags' header to the message. :---shell: let the shell interpret the command. - :---notify_stdout: display command's stdout as notification message. + :---notify_stdout: display cmd's stdout as notification. .. _cmd.thread.editnew: @@ -32,6 +32,19 @@ The following commands are available in thread mode optional arguments :---spawn: open editor in new window. +.. _cmd.thread.untag: + +.. describe:: untag + + remove tags from message(s) + + argument + comma separated list of tags + + optional arguments + :---all: tag all messages in thread. + :---no-flush: postpone a writeout to the index (Defaults to: 'True'). + .. _cmd.thread.toggleheaders: .. describe:: toggleheaders @@ -53,14 +66,12 @@ The following commands are available in thread mode :---separately: call print command once for each message. :---add_tags: add 'Tags' header to the message. -.. _cmd.thread.remove: +.. _cmd.thread.bounce: -.. describe:: remove +.. describe:: bounce - remove message(s) from the index + directly re-send selected message - optional arguments - :---all: remove whole thread. .. _cmd.thread.togglesource: @@ -106,18 +117,14 @@ The following commands are available in thread mode :---all: tag all messages in thread. :---no-flush: postpone a writeout to the index (Defaults to: 'True'). -.. _cmd.thread.untag: - -.. describe:: untag +.. _cmd.thread.remove: - remove tags from message(s) +.. describe:: remove - argument - comma separated list of tags + remove message(s) from the index optional arguments - :---all: tag all messages in thread. - :---no-flush: postpone a writeout to the index (Defaults to: 'True'). + :---all: remove whole thread. .. _cmd.thread.unfold: -- cgit v1.2.3