diff options
Diffstat (limited to 'docs/source/usage/modes/global.rst')
-rw-r--r-- | docs/source/usage/modes/global.rst | 180 |
1 files changed, 90 insertions, 90 deletions
diff --git a/docs/source/usage/modes/global.rst b/docs/source/usage/modes/global.rst index 672e43d5..dcbe4040 100644 --- a/docs/source/usage/modes/global.rst +++ b/docs/source/usage/modes/global.rst @@ -5,40 +5,21 @@ Global Commands --------------- The following commands are available globally -.. _cmd.global.call: - -.. describe:: call - - Executes python code - - argument - python command string to call - - -.. _cmd.global.refresh: - -.. describe:: refresh - - refresh the current buffer - - -.. _cmd.global.exit: - -.. describe:: exit +.. _cmd.global.bclose: - Shut down cleanly. +.. describe:: bclose - The _prompt variable is for internal use only, it's used to control - prompting to close without sending, and is used by the BufferCloseCommand - if settings change after yielding to the UI. - + close a buffer + optional arguments + :---redraw: redraw current buffer after command has finished. + :---force: never ask for confirmation. -.. _cmd.global.flush: +.. _cmd.global.bprevious: -.. describe:: flush +.. describe:: bprevious - flush write operations or retry until committed + focus previous buffer .. _cmd.global.search: @@ -54,52 +35,53 @@ The following commands are available globally optional arguments :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. -.. _cmd.global.move: +.. _cmd.global.repeat: -.. describe:: move +.. describe:: repeat - move focus in current buffer + Repeats the command executed last time + + +.. _cmd.global.prompt: + +.. describe:: prompt + + prompts for commandline and interprets it upon select argument - up, down, [half]page up, [half]page down, first, last + initial content -.. _cmd.global.taglist: +.. _cmd.global.help: -.. describe:: taglist +.. describe:: help - opens taglist buffer + display help for a command. Use 'bindings' to display all keybings + interpreted in current mode.' - optional arguments - :---tags: tags to display. + argument + command or 'bindings' -.. _cmd.global.bufferlist: -.. describe:: bufferlist +.. _cmd.global.buffer: - open a list of active buffers +.. describe:: buffer + focus buffer with given index -.. _cmd.global.compose: + argument + buffer index to focus -.. describe:: compose - compose a new email +.. _cmd.global.move: + +.. describe:: move + + move focus in current buffer argument - None + up, down, [half]page up, [half]page down, first, last - optional arguments - :---sender: sender. - :---template: path to a template message file. - :---tags: comma-separated list of tags to apply to message. - :---subject: subject line. - :---to: recipients. - :---cc: copy to. - :---bcc: blind copy to. - :---attach: attach files. - :---omit_signature: do not add signature. - :---spawn: spawn editor in new terminal. .. _cmd.global.shellescape: @@ -115,79 +97,97 @@ The following commands are available globally :---thread: run in separate thread. :---refocus: refocus current buffer after command has finished. -.. _cmd.global.bprevious: +.. _cmd.global.refresh: -.. describe:: bprevious +.. describe:: refresh - focus previous buffer + refresh the current buffer -.. _cmd.global.prompt: +.. _cmd.global.reload: -.. describe:: prompt +.. describe:: reload - prompts for commandline and interprets it upon select + Reload all configuration files - argument - initial content +.. _cmd.global.pyshell: -.. _cmd.global.help: +.. describe:: pyshell -.. describe:: help + open an interactive python shell for introspection - display help for a command. Use 'bindings' to display all keybings - interpreted in current mode.' + +.. _cmd.global.compose: + +.. describe:: compose + + compose a new email argument - command or 'bindings' + None + optional arguments + :---sender: sender. + :---template: path to a template message file. + :---tags: comma-separated list of tags to apply to message. + :---subject: subject line. + :---to: recipients. + :---cc: copy to. + :---bcc: blind copy to. + :---attach: attach files. + :---omit_signature: do not add signature. + :---spawn: spawn editor in new terminal. -.. _cmd.global.bclose: +.. _cmd.global.exit: -.. describe:: bclose +.. describe:: exit - close a buffer + Shut down cleanly. - optional arguments - :---redraw: redraw current buffer after command has finished. - :---force: never ask for confirmation. + The _prompt variable is for internal use only, it's used to control + prompting to close without sending, and is used by the BufferCloseCommand + if settings change after yielding to the UI. + -.. _cmd.global.repeat: -.. describe:: repeat +.. _cmd.global.flush: - Repeats the command executed last time +.. describe:: flush + flush write operations or retry until committed -.. _cmd.global.bnext: -.. describe:: bnext +.. _cmd.global.bufferlist: - focus next buffer +.. describe:: bufferlist + open a list of active buffers -.. _cmd.global.buffer: -.. describe:: buffer +.. _cmd.global.call: - focus buffer with given index +.. describe:: call + + Executes python code argument - buffer index to focus + python command string to call -.. _cmd.global.reload: +.. _cmd.global.bnext: -.. describe:: reload +.. describe:: bnext - Reload all configuration files + focus next buffer -.. _cmd.global.pyshell: +.. _cmd.global.taglist: -.. describe:: pyshell +.. describe:: taglist - open an interactive python shell for introspection + opens taglist buffer + optional arguments + :---tags: tags to display. |