diff options
Diffstat (limited to 'docs/source/usage/modes/global.rst')
| -rw-r--r-- | docs/source/usage/modes/global.rst | 174 |
1 files changed, 87 insertions, 87 deletions
diff --git a/docs/source/usage/modes/global.rst b/docs/source/usage/modes/global.rst index ee3955fd..6e79c67a 100644 --- a/docs/source/usage/modes/global.rst +++ b/docs/source/usage/modes/global.rst @@ -5,41 +5,38 @@ Global Commands --------------- The following commands are available globally -.. _cmd.global.search: - -.. describe:: search +.. _cmd.global.bclose: - open a new search buffer. Search obeys the notmuch - :ref:`search.exclude_tags <search.exclude_tags>` setting. +.. describe:: bclose - argument - search string + close a buffer optional arguments - :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. + :---redraw: redraw current buffer after command has finished. + :---force: never ask for confirmation. -.. _cmd.global.prompt: +.. _cmd.global.bnext: -.. describe:: prompt +.. describe:: bnext - prompts for commandline and interprets it upon select + focus next buffer - argument - initial content +.. _cmd.global.bprevious: -.. _cmd.global.bnext: +.. describe:: bprevious -.. describe:: bnext + focus previous buffer - focus next buffer +.. _cmd.global.buffer: -.. _cmd.global.reload: +.. describe:: buffer -.. describe:: reload + focus buffer with given index - Reload all configuration files + argument + buffer index to focus .. _cmd.global.bufferlist: @@ -49,15 +46,36 @@ The following commands are available globally open a list of active buffers -.. _cmd.global.bclose: +.. _cmd.global.call: -.. describe:: bclose +.. describe:: call - close a buffer + Executes python code + + argument + python command string to call + + +.. _cmd.global.compose: + +.. describe:: compose + + compose a new email + + argument + None optional arguments - :---redraw: redraw current buffer after command has finished. - :---force: never ask for confirmation. + :---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.exit: @@ -71,19 +89,12 @@ The following commands are available globally -.. _cmd.global.shellescape: +.. _cmd.global.flush: -.. describe:: shellescape +.. describe:: flush - run external command + flush write operations or retry until committed - argument - command line to execute - - optional arguments - :---spawn: run in terminal window. - :---thread: run in separate thread. - :---refocus: refocus current buffer after command has finished. .. _cmd.global.help: @@ -96,98 +107,87 @@ The following commands are available globally command or 'bindings' -.. _cmd.global.call: +.. _cmd.global.move: -.. describe:: call +.. describe:: move - Executes python code + move focus in current buffer argument - python command string to call - - -.. _cmd.global.taglist: - -.. describe:: taglist - - opens taglist buffer + up, down, [half]page up, [half]page down, first, last - optional arguments - :---tags: tags to display. -.. _cmd.global.compose: +.. _cmd.global.prompt: -.. describe:: compose +.. describe:: prompt - compose a new email + prompts for commandline and interprets it upon select argument - None + initial content - 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.bprevious: +.. _cmd.global.pyshell: -.. describe:: bprevious +.. describe:: pyshell - focus previous buffer + open an interactive python shell for introspection -.. _cmd.global.buffer: +.. _cmd.global.refresh: -.. describe:: buffer +.. describe:: refresh - focus buffer with given index + refresh the current buffer - argument - buffer index to focus +.. _cmd.global.reload: -.. _cmd.global.flush: +.. describe:: reload -.. describe:: flush + Reload all configuration files - flush write operations or retry until committed +.. _cmd.global.repeat: -.. _cmd.global.refresh: +.. describe:: repeat -.. describe:: refresh + Repeats the command executed last time - refresh the current buffer +.. _cmd.global.search: -.. _cmd.global.repeat: +.. describe:: search -.. describe:: repeat + open a new search buffer. Search obeys the notmuch + :ref:`search.exclude_tags <search.exclude_tags>` setting. - Repeats the command executed last time + argument + search string + optional arguments + :---sort: sort order. Valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`. -.. _cmd.global.pyshell: +.. _cmd.global.shellescape: -.. describe:: pyshell +.. describe:: shellescape - open an interactive python shell for introspection + run external command + argument + command line to execute -.. _cmd.global.move: + optional arguments + :---spawn: run in terminal window. + :---thread: run in separate thread. + :---refocus: refocus current buffer after command has finished. -.. describe:: move +.. _cmd.global.taglist: - move focus in current buffer +.. describe:: taglist - argument - up, down, [half]page up, [half]page down, first, last + opens taglist buffer + optional arguments + :---tags: tags to display. |