diff options
| -rw-r--r-- | alot/__main__.py | 8 | ||||
| -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 |
5 files changed, 14 insertions, 13 deletions
diff --git a/alot/__main__.py b/alot/__main__.py index b504dd50..80c0da12 100644 --- a/alot/__main__.py +++ b/alot/__main__.py @@ -27,17 +27,17 @@ def parser(): parser.add_argument('-v', '--version', action='version', version=alot.__version__) parser.add_argument('-r', '--read-only', action='store_true', - help='open db in read only mode') + help='open notmuch database in read-only mode') parser.add_argument('-c', '--config', action=cargparse.ValidatedStoreAction, validator=cargparse.require_file, - help='config file') + help='configuration file') parser.add_argument('-n', '--notmuch-config', default=os.environ.get( 'NOTMUCH_CONFIG', os.path.expanduser('~/.notmuch-config')), action=cargparse.ValidatedStoreAction, validator=cargparse.require_file, - help='notmuch config') + help='notmuch configuration file') parser.add_argument('-C', '--colour-mode', choices=(1, 16, 256), type=int, help='terminal colour mode') @@ -51,7 +51,7 @@ def parser(): parser.add_argument('-l', '--logfile', default='/dev/null', action=cargparse.ValidatedStoreAction, validator=cargparse.optional_file_like, - help='logfile [default: %(default)s]') + help='log file [default: %(default)s]') # We will handle the subcommands in a separate run of argparse as argparse # does not support optional subcommands until now. parser.add_argument('command', nargs=argparse.REMAINDER, 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 |