summaryrefslogtreecommitdiff
path: root/docs/source/usage/modes/global.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/usage/modes/global.rst')
-rw-r--r--docs/source/usage/modes/global.rst144
1 files changed, 72 insertions, 72 deletions
diff --git a/docs/source/usage/modes/global.rst b/docs/source/usage/modes/global.rst
index dcbe4040..ee3955fd 100644
--- a/docs/source/usage/modes/global.rst
+++ b/docs/source/usage/modes/global.rst
@@ -5,23 +5,6 @@ Global Commands
---------------
The following commands are available globally
-.. _cmd.global.bclose:
-
-.. describe:: bclose
-
- close a buffer
-
- optional arguments
- :---redraw: redraw current buffer after command has finished.
- :---force: never ask for confirmation.
-
-.. _cmd.global.bprevious:
-
-.. describe:: bprevious
-
- focus previous buffer
-
-
.. _cmd.global.search:
.. describe:: search
@@ -35,13 +18,6 @@ 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:
.. describe:: prompt
@@ -52,35 +28,47 @@ The following commands are available globally
initial content
-.. _cmd.global.help:
+.. _cmd.global.bnext:
-.. describe:: help
+.. describe:: bnext
- display help for a command. Use 'bindings' to display all keybings
- interpreted in current mode.'
+ focus next buffer
- argument
- command or 'bindings'
+.. _cmd.global.reload:
-.. _cmd.global.buffer:
+.. describe:: reload
-.. describe:: buffer
+ Reload all configuration files
- focus buffer with given index
- argument
- buffer index to focus
+.. _cmd.global.bufferlist:
+.. describe:: bufferlist
-.. _cmd.global.move:
+ open a list of active buffers
-.. describe:: move
- move focus in current buffer
+.. _cmd.global.bclose:
- argument
- up, down, [half]page up, [half]page down, first, last
+.. describe:: bclose
+
+ close a buffer
+
+ optional arguments
+ :---redraw: redraw current buffer after command has finished.
+ :---force: never ask for confirmation.
+
+.. _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.shellescape:
@@ -97,26 +85,35 @@ The following commands are available globally
:---thread: run in separate thread.
:---refocus: refocus current buffer after command has finished.
-.. _cmd.global.refresh:
+.. _cmd.global.help:
-.. describe:: refresh
+.. describe:: help
- refresh the current buffer
+ display help for a command. Use 'bindings' to display all keybings
+ interpreted in current mode.'
+ argument
+ command or 'bindings'
-.. _cmd.global.reload:
-.. describe:: reload
+.. _cmd.global.call:
- Reload all configuration files
+.. describe:: call
+ Executes python code
-.. _cmd.global.pyshell:
+ argument
+ python command string to call
-.. describe:: pyshell
- open an interactive python shell for introspection
+.. _cmd.global.taglist:
+
+.. describe:: taglist
+
+ opens taglist buffer
+ optional arguments
+ :---tags: tags to display.
.. _cmd.global.compose:
@@ -139,16 +136,21 @@ The following commands are available globally
:---omit_signature: do not add signature.
:---spawn: spawn editor in new terminal.
-.. _cmd.global.exit:
+.. _cmd.global.bprevious:
-.. describe:: exit
+.. describe:: bprevious
- Shut down cleanly.
+ focus previous buffer
- 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.buffer:
+
+.. describe:: buffer
+
+ focus buffer with given index
+
+ argument
+ buffer index to focus
.. _cmd.global.flush:
@@ -158,36 +160,34 @@ The following commands are available globally
flush write operations or retry until committed
-.. _cmd.global.bufferlist:
+.. _cmd.global.refresh:
-.. describe:: bufferlist
+.. describe:: refresh
- open a list of active buffers
+ refresh the current buffer
-.. _cmd.global.call:
+.. _cmd.global.repeat:
-.. describe:: call
+.. describe:: repeat
- Executes python code
+ Repeats the command executed last time
- argument
- python command string to call
+.. _cmd.global.pyshell:
-.. _cmd.global.bnext:
+.. describe:: pyshell
-.. describe:: bnext
+ open an interactive python shell for introspection
- focus next buffer
+.. _cmd.global.move:
-.. _cmd.global.taglist:
+.. describe:: move
-.. describe:: taglist
+ move focus in current buffer
- opens taglist buffer
+ argument
+ up, down, [half]page up, [half]page down, first, last
- optional arguments
- :---tags: tags to display.