summaryrefslogtreecommitdiff
path: root/docs/source/usage
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/usage')
-rw-r--r--docs/source/usage/commands29
-rw-r--r--docs/source/usage/first_steps10
-rw-r--r--docs/source/usage/synopsis26
3 files changed, 65 insertions, 0 deletions
diff --git a/docs/source/usage/commands b/docs/source/usage/commands
new file mode 100644
index 00000000..ec0be2eb
--- /dev/null
+++ b/docs/source/usage/commands
@@ -0,0 +1,29 @@
+.. _commands:
+
+Commands
+========
+
+:doc:`modes/global`
+ globally available commands
+:doc:`modes/search`
+ shows a result list of threads for a query
+:doc:`modes/thread`
+ displays a thread as a tree of messages
+:doc:`modes/envelope`
+ message composition mode
+:doc:`modes/bufferlist`
+ lists all active buffers
+:doc:`modes/taglist`
+ lists all tagstrings present in the notmuch database
+
+.. toctree::
+ :maxdepth: 2
+ :hidden:
+
+ modes/global
+ modes/search
+ modes/thread
+ modes/envelope
+ modes/bufferlist
+ modes/taglist
+
diff --git a/docs/source/usage/first_steps b/docs/source/usage/first_steps
new file mode 100644
index 00000000..e99c44ce
--- /dev/null
+++ b/docs/source/usage/first_steps
@@ -0,0 +1,10 @@
+The arrow keys, `page-up/down`, `j`, `k` and `Space` can be used to move the focus.
+`Escape` cancels prompts and `Enter` selects. Hit `:` at any time and type in commands
+to the prompt.
+
+The interface shows one buffer at a time, you can use `tab` and `Shift-Tab` to switch
+between them, close the current buffer with `d` and list them all with `;`.
+
+The buffer type or *mode* (displayed at the bottom left) determines which prompt commands
+are available. Usage information on any command can be listed by typing `help YOURCOMMAND`
+to the prompt; The key bindings for the current mode are listed upon pressing `?`.
diff --git a/docs/source/usage/synopsis b/docs/source/usage/synopsis
new file mode 100644
index 00000000..5bfb8e88
--- /dev/null
+++ b/docs/source/usage/synopsis
@@ -0,0 +1,26 @@
+.. code-block:: none
+
+ alot [-r] [-c CONFIGFILE] [-n NOTMUCHCONFIGFILE] [-C {1,16,256}] [-p DB_PATH]
+ [-d {debug,info,warning,error}] [-l LOGFILE] [--version] [--help]
+ [command]
+
+Options
+
+ -r, --read-only open db in read only mode
+ -c, --config=FILENAME config file (default: ~/.config/alot/config)
+ -n, --notmuch-config=FILENAME notmuch config (default: $NOTMUCH_CONFIG or ~/.notmuch-config)
+ -C, --colour-mode=COLOUR terminal colour mode (default: 256). Must be 1, 16 or 256
+ -p, --mailindex-path=PATH path to notmuch index
+ -d, --debug-level=LEVEL debug log (default: info). Must be one of debug,info,warning or error
+ -l, --logfile=FILENAME logfile (default: /dev/null)
+ --version Display version string and exit
+ --help Display help and exit
+
+
+Commands
+
+ search
+ start in a search buffer using the querystring provided as
+ parameter. See the SEARCH SYNTAX section of notmuch(1).
+ compose
+ compose a new message