summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlexander Shpilkin <ashpilkin@gmail.com>2018-07-22 20:41:23 +0200
committerAlexander Shpilkin <ashpilkin@gmail.com>2018-07-25 00:37:59 +0200
commitdc686ecc9a8ae34db2a663049e7b9cac166711bd (patch)
treefba5318a96ca0c8cc4a18df6c4c34830a4ee088f /docs
parent4cba47a8143059a68c904e40e575fc4d493bf6de (diff)
Fix typesetting of option arguments in the manual
Sphinx appears to not typeset an option properly when only the long version lists an argument. Add the arguments to the short versions as well.
Diffstat (limited to 'docs')
-rw-r--r--docs/source/usage/cli_options.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/source/usage/cli_options.rst b/docs/source/usage/cli_options.rst
index 326f61fb..9bc8c978 100644
--- a/docs/source/usage/cli_options.rst
+++ b/docs/source/usage/cli_options.rst
@@ -1,9 +1,9 @@
-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. 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)
+-c FILENAME, --config=FILENAME config file (default: ~/.config/alot/config)
+-n FILENAME, --notmuch-config=FILENAME notmuch config (default: $NOTMUCH_CONFIG or ~/.notmuch-config)
+-C COLOUR, --colour-mode=COLOUR terminal colour mode. Must be 1, 16 or 256
+-p PATH, --mailindex-path=PATH path to notmuch index
+-d LEVEL, --debug-level=LEVEL debug log (default: info). Must be one of debug,info,warning or error
+-l FILENAME, --logfile=FILENAME logfile (default: /dev/null)
-v, --version Display version string and exit
-h, --help Display help and exit