diff options
Diffstat (limited to 'docs/source/usage/commands.rst')
| -rw-r--r-- | docs/source/usage/commands.rst | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/source/usage/commands.rst b/docs/source/usage/commands.rst new file mode 100644 index 00000000..6fa99b58 --- /dev/null +++ b/docs/source/usage/commands.rst @@ -0,0 +1,37 @@ +Commands +======== + +Alot interprets user input as command line strings given via its prompt +or :ref:`bound to keys <config.key_bindings>` in the config. +Command lines are semi-colon separated command strings, each of which +starts with a command name and possibly followed by arguments. + + +See the sections below for which commands are available in which (UI) mode. +`global` commands are available independently of the mode. + + +:doc:`modes/global` + globally available commands +:doc:`modes/search` + commands available when showing thread search results +:doc:`modes/thread` + commands available while displaying a thread +:doc:`modes/envelope` + commands during message composition +:doc:`modes/bufferlist` + commands while listing active buffers +:doc:`modes/taglist` + commands while listing all tagstrings present in the notmuch database + +.. toctree:: + :maxdepth: 2 + :hidden: + + modes/global + modes/search + modes/thread + modes/envelope + modes/bufferlist + modes/taglist + |