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 dcbe4040..672e43d5 100644 --- a/docs/source/usage/modes/global.rst +++ b/docs/source/usage/modes/global.rst @@ -5,21 +5,40 @@ Global Commands --------------- The following commands are available globally -.. _cmd.global.bclose: +.. _cmd.global.call: -.. describe:: bclose +.. describe:: call - close a buffer + Executes python code - optional arguments - :---redraw: redraw current buffer after command has finished. - :---force: never ask for confirmation. + argument + python command string to call -.. _cmd.global.bprevious: -.. describe:: bprevious +.. _cmd.global.refresh: - focus previous buffer +.. describe:: refresh + + refresh the current buffer + + +.. _cmd.global.exit: + +.. describe:: exit + + Shut down cleanly. + + 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.flush: + +.. describe:: flush + + flush write operations or retry until committed .. _cmd.global.search: @@ -35,53 +54,52 @@ The following commands are available globally optional arguments :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. -.. _cmd.global.repeat: - -.. describe:: repeat - - Repeats the command executed last time - - -.. _cmd.global.prompt: +.. _cmd.global.move: -.. describe:: prompt +.. describe:: move - prompts for commandline and interprets it upon select + move focus in current buffer argument - initial content - - -.. _cmd.global.help: + up, down, [half]page up, [half]page down, first, last -.. describe:: help - display help for a command. Use 'bindings' to display all keybings - interpreted in current mode.' +.. _cmd.global.taglist: - argument - command or 'bindings' +.. describe:: taglist + opens taglist buffer -.. _cmd.global.buffer: + optional arguments + :---tags: tags to display. -.. describe:: buffer +.. _cmd.global.bufferlist: - focus buffer with given index +.. describe:: bufferlist - argument - buffer index to focus + open a list of active buffers -.. _cmd.global.move: +.. _cmd.global.compose: -.. describe:: move +.. describe:: compose - move focus in current buffer + compose a new email argument - up, down, [half]page up, [half]page down, first, last + 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.shellescape: @@ -97,97 +115,79 @@ The following commands are available globally :---thread: run in separate thread. :---refocus: refocus current buffer after command has finished. -.. _cmd.global.refresh: - -.. describe:: refresh - - refresh the current buffer - +.. _cmd.global.bprevious: -.. _cmd.global.reload: +.. describe:: bprevious -.. describe:: reload + focus previous buffer - Reload all configuration files +.. _cmd.global.prompt: -.. _cmd.global.pyshell: +.. describe:: prompt -.. describe:: pyshell + prompts for commandline and interprets it upon select - open an interactive python shell for introspection + argument + initial content -.. _cmd.global.compose: +.. _cmd.global.help: -.. describe:: compose +.. describe:: help - compose a new email + display help for a command. Use 'bindings' to display all keybings + interpreted in current mode.' argument - 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. + command or 'bindings' -.. _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.repeat: -.. describe:: flush +.. describe:: repeat - flush write operations or retry until committed + Repeats the command executed last time -.. _cmd.global.bufferlist: +.. _cmd.global.bnext: -.. describe:: bufferlist +.. describe:: bnext - open a list of active buffers + focus next buffer -.. _cmd.global.call: +.. _cmd.global.buffer: -.. describe:: call +.. describe:: buffer - Executes python code + focus buffer with given index argument - python command string to call + buffer index to focus -.. _cmd.global.bnext: +.. _cmd.global.reload: -.. describe:: bnext +.. describe:: reload - focus next buffer + Reload all configuration files -.. _cmd.global.taglist: +.. _cmd.global.pyshell: -.. describe:: taglist +.. describe:: pyshell - opens taglist buffer + open an interactive python shell for introspection - optional arguments - :---tags: tags to display. |