From f1c6bede9b52086529da061c37ed83ca80f2f90b Mon Sep 17 00:00:00 2001 From: Alexander Shpilkin Date: Tue, 24 Jul 2018 21:44:12 +0200 Subject: Reword description of options -C and colourmode --- alot/__main__.py | 2 +- alot/defaults/alot.rc.spec | 2 +- docs/source/configuration/alotrc_table | 2 +- docs/source/usage/cli_options.rst | 5 +++-- 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/alot/__main__.py b/alot/__main__.py index 80c0da12..1c2a2c46 100644 --- a/alot/__main__.py +++ b/alot/__main__.py @@ -40,7 +40,7 @@ def parser(): help='notmuch configuration file') parser.add_argument('-C', '--colour-mode', choices=(1, 16, 256), type=int, - help='terminal colour mode') + help='number of colours to use') parser.add_argument('-p', '--mailindex-path', action=cargparse.ValidatedStoreAction, validator=cargparse.require_dir, diff --git a/alot/defaults/alot.rc.spec b/alot/defaults/alot.rc.spec index dfe5dd38..a2edcb37 100644 --- a/alot/defaults/alot.rc.spec +++ b/alot/defaults/alot.rc.spec @@ -23,7 +23,7 @@ bug_on_exit = boolean(default=False) # offset of next focused buffer if the current one gets closed bufferclose_focus_offset = integer(default=-1) -# number of colours to use +# number of colours to use on the terminal colourmode = option(1, 16, 256, default=256) # number of spaces used to replace tab characters diff --git a/docs/source/configuration/alotrc_table b/docs/source/configuration/alotrc_table index 8cc208bd..75708e45 100644 --- a/docs/source/configuration/alotrc_table +++ b/docs/source/configuration/alotrc_table @@ -105,7 +105,7 @@ .. describe:: colourmode - number of colours to use + number of colours to use on the terminal :type: option, one of ['1', '16', '256'] :default: 256 diff --git a/docs/source/usage/cli_options.rst b/docs/source/usage/cli_options.rst index b7f5aa02..4fd200e5 100644 --- a/docs/source/usage/cli_options.rst +++ b/docs/source/usage/cli_options.rst @@ -4,8 +4,9 @@ -n FILENAME, --notmuch-config=FILENAME notmuch configuration file (default: $NOTMUCH_CONFIG or ~/.notmuch-config) --C COLOUR, --colour-mode=COLOUR - terminal colour; must be 1, 16 or 256 +-C COLOURS, --colour-mode=COLOURS + number of colours to use on the terminal; must be 1, 16 or 256 + (default: configuration option `colourmode` or 256) -p PATH, --mailindex-path=PATH path to notmuch index -d LEVEL, --debug-level=LEVEL -- cgit v1.2.3