summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2017-01-10 18:31:10 +0000
committerGitHub <noreply@github.com>2017-01-10 18:31:10 +0000
commit4645c4b2eb2b3aa93305f0c10fd3567cfeeb41c7 (patch)
tree56a5b4f124924a5740dd6b46ce5633ca109e5008 /docs
parent20bffed730e54c9e3a6e69c5c854dcce6d6eeb59 (diff)
parent6a164565e66207cf59f5b183ef7a947a0b4c87da (diff)
Merge pull request #944 from lucc/argparse
Replace twisted command line parsing with argparse
Diffstat (limited to 'docs')
-rw-r--r--docs/source/usage/synopsis.rst12
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/source/usage/synopsis.rst b/docs/source/usage/synopsis.rst
index e507ef82..159b9fcb 100644
--- a/docs/source/usage/synopsis.rst
+++ b/docs/source/usage/synopsis.rst
@@ -1,20 +1,19 @@
.. 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]
+ [-d {debug,info,warning,error}] [-l LOGFILE] [-v] [-h] [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
+ -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
+ -v, --version Display version string and exit
+ -h, --help Display help and exit
UNIX Signals
SIGUSR1
@@ -31,3 +30,6 @@ Subommands
compose
compose a new message
See the output of `alot compose --help` for more info on parameters.
+ pyshell
+ start the interactive python shell inside alot
+ See the output of `alot pyshell --help` for more info on parameters.