diff options
Diffstat (limited to 'docs/source/usage/modes/thread.rst')
| -rw-r--r-- | docs/source/usage/modes/thread.rst | 200 |
1 files changed, 100 insertions, 100 deletions
diff --git a/docs/source/usage/modes/thread.rst b/docs/source/usage/modes/thread.rst index 29a7850a..01c9db9c 100644 --- a/docs/source/usage/modes/thread.rst +++ b/docs/source/usage/modes/thread.rst @@ -5,33 +5,15 @@ Commands in `thread` mode ------------------------- The following commands are available in thread mode -.. _cmd.thread.pipeto: +.. _cmd.thread.toggleheaders: -.. describe:: pipeto +.. describe:: toggleheaders - pipe message(s) to stdin of a shellcommand + display all headers 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 + query used to filter messages to affect - optional arguments - :---spawn: open editor in new window. .. _cmd.thread.move: @@ -43,50 +25,45 @@ The following commands are available in thread mode 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.indent: +.. _cmd.thread.unfold: -.. describe:: indent +.. describe:: unfold - change message/reply indentation + unfold message(s) argument - None - - -.. _cmd.thread.toggleheaders: + query used to filter messages to affect -.. describe:: toggleheaders - display all headers +.. _cmd.thread.editnew: - argument - query used to filter messages to affect +.. describe:: editnew + edit message in as new -.. _cmd.thread.retag: + optional arguments + :---spawn: open editor in new window. -.. describe:: retag +.. _cmd.thread.reply: - set message(s) tags. +.. describe:: reply - argument - comma separated list of tags + reply to message optional arguments - :---all: tag all messages in thread. - :---no-flush: postpone a writeout to the index (Defaults to: 'True'). + :---all: reply to all. + :---list: reply to list. + :---spawn: open editor in new window. -.. _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. + :---attach: attach original mail. + :---spawn: open editor in new window. .. _cmd.thread.bounce: @@ -95,16 +72,46 @@ The following commands are available in thread mode directly re-send selected message -.. _cmd.thread.togglesource: +.. _cmd.thread.select: -.. describe:: togglesource +.. describe:: select - display message source + 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.save: + +.. describe:: save + + save attachment(s) + + argument + path to save to + + optional arguments + :---all: save all attachments. + +.. _cmd.thread.fold: + +.. describe:: fold + + fold message(s) argument query used to filter messages to affect +.. _cmd.thread.remove: + +.. describe:: remove + + remove message(s) from the index + + optional arguments + :---all: remove whole thread. + .. _cmd.thread.untag: .. describe:: untag @@ -118,21 +125,21 @@ 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.togglesource: -.. describe:: fold +.. describe:: togglesource - fold message(s) + display message source argument query used to filter messages to affect -.. _cmd.thread.tag: +.. _cmd.thread.toggletags: -.. describe:: tag +.. describe:: toggletags - add tags to message(s) + flip presence of tags on message(s) argument comma separated list of tags @@ -141,77 +148,70 @@ 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.tag: -.. describe:: remove +.. describe:: tag - remove message(s) from the index + add tags to message(s) + + argument + comma separated list of tags optional arguments - :---all: remove whole thread. + :---all: tag all messages in thread. + :---no-flush: postpone a writeout to the index (Defaults to: 'True'). -.. _cmd.thread.unfold: +.. _cmd.thread.retag: -.. describe:: unfold +.. describe:: retag - unfold message(s) + set message(s) tags. argument - query used to filter messages to affect - - -.. _cmd.thread.forward: - -.. describe:: forward - - forward message + comma separated list of tags optional arguments - :---attach: attach original mail. - :---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.reply: +.. _cmd.thread.print: -.. describe:: reply +.. describe:: print - reply to message + print message(s) optional arguments - :---all: reply to all. - :---list: reply to list. - :---spawn: open editor in new window. + :---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.save: +.. _cmd.thread.indent: -.. describe:: save +.. describe:: indent - save attachment(s) + change message/reply indentation argument - path to save to + None - optional arguments - :---all: save all attachments. -.. _cmd.thread.toggletags: +.. _cmd.thread.pipeto: -.. describe:: toggletags +.. describe:: pipeto - flip presence of tags on message(s) + 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'). - -.. _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 - + :---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'). |