diff options
| author | Alexander Shpilkin <ashpilkin@gmail.com> | 2018-07-24 21:36:04 +0200 |
|---|---|---|
| committer | Alexander Shpilkin <ashpilkin@gmail.com> | 2018-07-25 00:39:55 +0200 |
| commit | 0c93409da2477dbb2c8b89ca4b55ade7e9720746 (patch) | |
| tree | 88ddf59264b16879f57ffa3ee5d370ea1331eced /docs | |
| parent | 1a66f6764ead424c6bc83b50ad016db581489650 (diff) | |
Avoid abbreviations in documentation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/configuration/config_options.rst | 4 | ||||
| -rw-r--r-- | docs/source/usage/cli_commands.rst | 2 | ||||
| -rw-r--r-- | docs/source/usage/cli_options.rst | 9 | ||||
| -rw-r--r-- | docs/source/usage/index.rst | 4 |
4 files changed, 10 insertions, 9 deletions
diff --git a/docs/source/configuration/config_options.rst b/docs/source/configuration/config_options.rst index c654a102..05027207 100644 --- a/docs/source/configuration/config_options.rst +++ b/docs/source/configuration/config_options.rst @@ -1,7 +1,7 @@ .. _config.options: -Config options -============== +Configuration Options +===================== The following lists all available config options with their type and default values. The type of an option is used to validate a given value. For instance, diff --git a/docs/source/usage/cli_commands.rst b/docs/source/usage/cli_commands.rst index c8cedef5..0d595ba0 100644 --- a/docs/source/usage/cli_commands.rst +++ b/docs/source/usage/cli_commands.rst @@ -1,5 +1,5 @@ search - start in a search buffer using the querystring provided as + start in a search buffer using the query string provided as parameter (see :manpage:`notmuch-search-terms(7)`) compose diff --git a/docs/source/usage/cli_options.rst b/docs/source/usage/cli_options.rst index 342c8f46..b7f5aa02 100644 --- a/docs/source/usage/cli_options.rst +++ b/docs/source/usage/cli_options.rst @@ -1,8 +1,9 @@ --r, --read-only open db in read only mode +-r, --read-only open notmuch database in read-only mode -c FILENAME, --config=FILENAME - config file (default: ~/.config/alot/config) + configuration file (default: ~/.config/alot/config) -n FILENAME, --notmuch-config=FILENAME - notmuch config (default: $NOTMUCH_CONFIG or ~/.notmuch-config) + notmuch configuration file (default: $NOTMUCH_CONFIG + or ~/.notmuch-config) -C COLOUR, --colour-mode=COLOUR terminal colour; must be 1, 16 or 256 -p PATH, --mailindex-path=PATH @@ -11,6 +12,6 @@ debug level; must be one of debug, info, warning or error (default: info) -l FILENAME, --logfile=FILENAME - logfile (default: /dev/null) + log file (default: /dev/null) -v, --version display version string and exit -h, --help display help and exit diff --git a/docs/source/usage/index.rst b/docs/source/usage/index.rst index 8fb96cd2..506d9748 100644 --- a/docs/source/usage/index.rst +++ b/docs/source/usage/index.rst @@ -2,8 +2,8 @@ Usage ***** -Commandline invocation -====================== +Command-Line Invocation +======================= .. rubric:: Synopsis .. include:: synopsis.rst |