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 01c9db9c..447e543a 100644 --- a/docs/source/usage/modes/thread.rst +++ b/docs/source/usage/modes/thread.rst @@ -5,34 +5,11 @@ Commands in `thread` mode ------------------------- The following commands are available in thread mode -.. _cmd.thread.toggleheaders: - -.. describe:: toggleheaders - - display all headers - - argument - query used to filter messages to affect - - -.. _cmd.thread.move: - -.. describe:: move - - move focus in current buffer - - 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 - - -.. _cmd.thread.unfold: - -.. describe:: unfold +.. _cmd.thread.bounce: - unfold message(s) +.. describe:: bounce - argument - query used to filter messages to affect + directly re-send selected message .. _cmd.thread.editnew: @@ -44,16 +21,15 @@ The following commands are available in thread mode optional arguments :---spawn: open editor in new window. -.. _cmd.thread.reply: +.. _cmd.thread.fold: -.. describe:: reply +.. describe:: fold - reply to message + fold message(s) + + argument + query used to filter messages to affect - optional arguments - :---all: reply to all. - :---list: reply to list. - :---spawn: open editor in new window. .. _cmd.thread.forward: @@ -65,43 +41,56 @@ The following commands are available in thread mode :---attach: attach original mail. :---spawn: open editor in new window. -.. _cmd.thread.bounce: +.. _cmd.thread.indent: -.. describe:: bounce +.. describe:: indent - directly re-send selected message + change message/reply indentation + + argument + None -.. _cmd.thread.select: +.. _cmd.thread.move: -.. describe:: select +.. describe:: move - 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 + move focus in current buffer + 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 -.. _cmd.thread.save: -.. describe:: save +.. _cmd.thread.pipeto: - save attachment(s) +.. describe:: pipeto + + pipe message(s) to stdin of a shellcommand argument - path to save to + shellcommand to pipe to optional arguments - :---all: save all attachments. - -.. _cmd.thread.fold: + :---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'). -.. describe:: fold +.. _cmd.thread.print: - fold message(s) +.. describe:: print - argument - query used to filter messages to affect + print message(s) + 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.remove: @@ -112,11 +101,22 @@ The following commands are available in thread mode optional arguments :---all: remove whole thread. -.. _cmd.thread.untag: +.. _cmd.thread.reply: -.. describe:: untag +.. describe:: reply - remove tags from message(s) + reply to message + + optional arguments + :---all: reply to all. + :---list: reply to list. + :---spawn: open editor in new window. + +.. _cmd.thread.retag: + +.. describe:: retag + + set message(s) tags. argument comma separated list of tags @@ -125,28 +125,26 @@ 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.togglesource: +.. _cmd.thread.save: -.. describe:: togglesource +.. describe:: save - display message source + save attachment(s) argument - query used to filter messages to affect - + path to save to -.. _cmd.thread.toggletags: + optional arguments + :---all: save all attachments. -.. describe:: toggletags +.. _cmd.thread.select: - flip presence of tags on message(s) +.. describe:: select - argument - comma separated list of tags + 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 - optional arguments - :---all: tag all messages in thread. - :---no-flush: postpone a writeout to the index (Defaults to: 'True'). .. _cmd.thread.tag: @@ -161,57 +159,59 @@ 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.retag: +.. _cmd.thread.toggleheaders: -.. describe:: retag +.. describe:: toggleheaders - set message(s) tags. + display all headers argument - comma separated list of tags + query used to filter messages to affect - optional arguments - :---all: tag all messages in thread. - :---no-flush: postpone a writeout to the index (Defaults to: 'True'). -.. _cmd.thread.print: +.. _cmd.thread.togglesource: -.. describe:: print +.. describe:: togglesource - print message(s) + display message source + + argument + query used to filter messages to affect + + +.. _cmd.thread.toggletags: + +.. describe:: toggletags + + flip presence of tags on message(s) + + argument + comma separated list of tags 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. + :---all: tag all messages in thread. + :---no-flush: postpone a writeout to the index (Defaults to: 'True'). -.. _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.pipeto: +.. _cmd.thread.untag: -.. describe:: pipeto +.. describe:: untag - pipe message(s) to stdin of a shellcommand + remove tags from message(s) argument - shellcommand to pipe to + comma separated list of tags 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'). + :---all: tag all messages in thread. + :---no-flush: postpone a writeout to the index (Defaults to: 'True'). |