diff options
Diffstat (limited to 'docs/source/usage/modes/thread.rst')
| -rw-r--r-- | docs/source/usage/modes/thread.rst | 172 |
1 files changed, 86 insertions, 86 deletions
diff --git a/docs/source/usage/modes/thread.rst b/docs/source/usage/modes/thread.rst index 29a7850a..447e543a 100644 --- a/docs/source/usage/modes/thread.rst +++ b/docs/source/usage/modes/thread.rst @@ -5,24 +5,12 @@ Commands in `thread` mode ------------------------- The following commands are available in thread mode -.. _cmd.thread.pipeto: - -.. describe:: pipeto +.. _cmd.thread.bounce: - pipe message(s) to stdin of a shellcommand +.. describe:: bounce - argument - shellcommand to pipe to + directly re-send selected message - 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: @@ -33,15 +21,25 @@ The following commands are available in thread mode optional arguments :---spawn: open editor in new window. -.. _cmd.thread.move: +.. _cmd.thread.fold: -.. describe:: move +.. describe:: fold - move focus in current buffer + fold message(s) 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 + query used to filter messages to affect + +.. _cmd.thread.forward: + +.. describe:: forward + + forward message + + optional arguments + :---attach: attach original mail. + :---spawn: open editor in new window. .. _cmd.thread.indent: @@ -53,28 +51,34 @@ The following commands are available in thread mode None -.. _cmd.thread.toggleheaders: +.. _cmd.thread.move: -.. describe:: toggleheaders +.. describe:: move - display all headers + move focus in current buffer argument - query used to filter messages to affect + 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.retag: +.. _cmd.thread.pipeto: -.. describe:: retag +.. describe:: pipeto - set message(s) tags. + pipe message(s) to stdin of a shellcommand argument - comma separated list of tags + shellcommand to pipe to optional arguments - :---all: tag all messages in thread. - :---no-flush: postpone a writeout to the index (Defaults to: 'True'). + :---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.print: @@ -88,28 +92,31 @@ 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.bounce: - -.. describe:: bounce +.. _cmd.thread.remove: - directly re-send selected message +.. describe:: remove + remove message(s) from the index -.. _cmd.thread.togglesource: + optional arguments + :---all: remove whole thread. -.. describe:: togglesource +.. _cmd.thread.reply: - display message source +.. describe:: reply - argument - query used to filter messages to affect + reply to message + optional arguments + :---all: reply to all. + :---list: reply to list. + :---spawn: open editor in new window. -.. _cmd.thread.untag: +.. _cmd.thread.retag: -.. describe:: untag +.. describe:: retag - remove tags from message(s) + set message(s) tags. argument comma separated list of tags @@ -118,14 +125,25 @@ 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.fold: +.. _cmd.thread.save: -.. describe:: fold +.. describe:: save - fold message(s) + save attachment(s) argument - query used to filter messages to affect + path to save to + + optional arguments + :---all: save all attachments. + +.. _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.tag: @@ -141,63 +159,54 @@ 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.toggleheaders: -.. describe:: remove +.. describe:: toggleheaders - remove message(s) from the index + display all headers - optional arguments - :---all: remove whole thread. + argument + query used to filter messages to affect -.. _cmd.thread.unfold: -.. describe:: unfold +.. _cmd.thread.togglesource: - unfold message(s) +.. describe:: togglesource + + display message source argument query used to filter messages to affect -.. _cmd.thread.forward: - -.. describe:: forward - - forward message - - optional arguments - :---attach: attach original mail. - :---spawn: open editor in new window. +.. _cmd.thread.toggletags: -.. _cmd.thread.reply: +.. describe:: toggletags -.. describe:: reply + flip presence of tags on message(s) - reply to message + 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: +.. _cmd.thread.unfold: -.. describe:: save +.. describe:: unfold - save attachment(s) + unfold message(s) argument - path to save to + query used to filter messages to affect - optional arguments - :---all: save all attachments. -.. _cmd.thread.toggletags: +.. _cmd.thread.untag: -.. describe:: toggletags +.. describe:: untag - flip presence of tags on message(s) + remove tags from message(s) argument comma separated list of tags @@ -206,12 +215,3 @@ 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.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 - - |