diff options
Diffstat (limited to 'docs/source/usage/synopsis.rst')
| -rw-r--r-- | docs/source/usage/synopsis.rst | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/source/usage/synopsis.rst b/docs/source/usage/synopsis.rst new file mode 100644 index 00000000..c18bfa03 --- /dev/null +++ b/docs/source/usage/synopsis.rst @@ -0,0 +1,31 @@ +.. 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) + -C, --colour-mode=COLOR 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 + +% .. option:: -m <module>, --module <module> +% +% Run a module as a script. +% + + +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 |