docs: usage cleanup

1 files changed, 28 insertions, 0 deletions

diff --git a/docs/source/usage/synopsis.rst b/docs/source/usage/synopsis.rst
new file mode 100644
index 00000000..a6e776d4
--- /dev/null
+++ b/docs/source/usage/synopsis.rst
@@ -0,0 +1,28 @@
+.. 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
+
+
+Subommands
+
+    search
+        start in a search buffer using the querystring provided as
+        parameter. See also the SEARCH SYNTAX section of notmuch(1)
+        and the output of `alot search --help`.
+    compose
+        compose a new message
+        See the output of `alot compose --help` for more info on parameters.