diff options
Diffstat (limited to 'docs/source/usage/modes/thread.rst')
| -rw-r--r-- | docs/source/usage/modes/thread.rst | 196 |
1 files changed, 98 insertions, 98 deletions
diff --git a/docs/source/usage/modes/thread.rst b/docs/source/usage/modes/thread.rst index 29a7850a..7e98e327 100644 --- a/docs/source/usage/modes/thread.rst +++ b/docs/source/usage/modes/thread.rst @@ -5,52 +5,24 @@ Commands in `thread` mode ------------------------- The following commands are available in thread mode -.. _cmd.thread.pipeto: - -.. describe:: pipeto - - pipe message(s) to stdin of a shellcommand - - argument - shellcommand to pipe to - - optional arguments - :---all: pass all messages. - :---format: output format. Valid choices are: \`raw\`,\`decoded\`,\`id\`,\`filepath\` (Defaults to: 'raw'). - :---separately: call command once for each message. - :---background: don't stop the interface. - :---add_tags: add 'Tags' header to the message. - :---shell: let the shell interpret the command. - :---notify_stdout: display cmd's stdout as notification. - :---field_key: mailcap field key for decoding (Defaults to: 'copiousoutput'). - -.. _cmd.thread.editnew: - -.. describe:: editnew - - edit message in as new - - optional arguments - :---spawn: open editor in new window. - -.. _cmd.thread.move: +.. _cmd.thread.indent: -.. describe:: move +.. describe:: indent - move focus in current buffer + change message/reply indentation argument - up, down, [half]page up, [half]page down, first, last, parent, first reply, last reply, next sibling, previous sibling, next, previous, next unfolded, previous unfolded, next NOTMUCH_QUERY, previous NOTMUCH_QUERY + None -.. _cmd.thread.indent: +.. _cmd.thread.unfold: -.. describe:: indent +.. describe:: unfold - change message/reply indentation + unfold message(s) argument - None + query used to filter messages to affect .. _cmd.thread.toggleheaders: @@ -63,11 +35,20 @@ The following commands are available in thread mode query used to filter messages to affect -.. _cmd.thread.retag: +.. _cmd.thread.editnew: -.. describe:: retag +.. describe:: editnew - set message(s) tags. + edit message in as new + + optional arguments + :---spawn: open editor in new window. + +.. _cmd.thread.tag: + +.. describe:: tag + + add tags to message(s) argument comma separated list of tags @@ -76,34 +57,34 @@ 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.print: +.. _cmd.thread.forward: -.. describe:: print +.. describe:: forward - print message(s) + forward message optional arguments - :---all: print all messages. - :---raw: pass raw mail string. - :---separately: call print command once for each message. - :---add_tags: add 'Tags' header to the message. - -.. _cmd.thread.bounce: - -.. describe:: bounce - - directly re-send selected message - + :---attach: attach original mail. + :---spawn: open editor in new window. -.. _cmd.thread.togglesource: +.. _cmd.thread.pipeto: -.. describe:: togglesource +.. describe:: pipeto - display message source + pipe message(s) to stdin of a shellcommand argument - query used to filter messages to affect + shellcommand to pipe to + optional arguments + :---all: pass all messages. + :---format: output format. Valid choices are: \`raw\`,\`decoded\`,\`id\`,\`filepath\` (Defaults to: 'raw'). + :---separately: call command once for each message. + :---background: don't stop the interface. + :---add_tags: add 'Tags' header to the message. + :---shell: let the shell interpret the command. + :---notify_stdout: display cmd's stdout as notification. + :---field_key: mailcap field key for decoding (Defaults to: 'copiousoutput'). .. _cmd.thread.untag: @@ -118,6 +99,35 @@ 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.remove: + +.. describe:: remove + + remove message(s) from the index + + optional arguments + :---all: remove whole thread. + +.. _cmd.thread.reply: + +.. describe:: reply + + reply to message + + optional arguments + :---all: reply to all. + :---list: reply to list. + :---spawn: open editor in new window. + +.. _cmd.thread.select: + +.. describe:: select + + select focussed element. The fired action depends on the focus: + - if message summary, this toggles visibility of the message, + - if attachment line, this opens the attachment + + .. _cmd.thread.fold: .. describe:: fold @@ -128,11 +138,11 @@ The following commands are available in thread mode query used to filter messages to affect -.. _cmd.thread.tag: +.. _cmd.thread.retag: -.. describe:: tag +.. describe:: retag - add tags to message(s) + set message(s) tags. argument comma separated list of tags @@ -141,45 +151,47 @@ 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.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.unfold: +.. _cmd.thread.print: -.. describe:: unfold +.. describe:: print - unfold message(s) + print message(s) - argument - query used to filter messages to affect + optional arguments + :---all: print all messages. + :---raw: pass raw mail string. + :---separately: call print command once for each message. + :---add_tags: add 'Tags' header to the message. +.. _cmd.thread.togglesource: -.. _cmd.thread.forward: +.. describe:: togglesource -.. describe:: forward + display message source - forward message + argument + query used to filter messages to affect - optional arguments - :---attach: attach original mail. - :---spawn: open editor in new window. -.. _cmd.thread.reply: +.. _cmd.thread.toggletags: -.. describe:: reply +.. describe:: toggletags - reply to message + flip presence of tags on message(s) + + argument + comma separated list of tags optional arguments - :---all: reply to all. - :---list: reply to list. - :---spawn: open editor in new window. + :---all: tag all messages in thread. + :---no-flush: postpone a writeout to the index (Defaults to: 'True'). .. _cmd.thread.save: @@ -193,25 +205,13 @@ The following commands are available in thread mode optional arguments :---all: save all attachments. -.. _cmd.thread.toggletags: +.. _cmd.thread.move: -.. describe:: toggletags +.. describe:: move - flip presence of tags on message(s) + move focus in current buffer 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.select: - -.. describe:: select - - select focussed element. The fired action depends on the focus: - - if message summary, this toggles visibility of the message, - - if attachment line, this opens the attachment + up, down, [half]page up, [half]page down, first, last, parent, first reply, last reply, next sibling, previous sibling, next, previous, next unfolded, previous unfolded, next NOTMUCH_QUERY, previous NOTMUCH_QUERY |