summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst12
1 files changed, 10 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index 79f7cac..2631ac8 100644
--- a/README.rst
+++ b/README.rst
@@ -79,12 +79,14 @@ This will print the color definitions contained in the scheme; if the specified
name does not resolve to a pre-defined scheme it will be interpreted as a file
name instead.
-Keyboard LEDs
+Keyboard LEDs and flags
-------------------------------------------------------------------------------
+Keyboard handling is grouped under the ``vtcol kb`` subcommand.
+
Show the current state of the keyboard LEDs: ::
- $ vtcol leds get
+ $ vtcol kb leds get
caps: false, num: true, scroll: false
Set the state of the Caps Lock LED (does *not* affect the Caps Lock state, just
@@ -92,6 +94,12 @@ the LED itself): ::
$ vtcol leds set --caps on
+Likewise for the keyboad state (*not* the LEDs): ::
+
+ $ vtcol kb flags get
+ [flags: caps: false, num: false, scroll: false; default: caps: false, num: false, scroll: false]
+
+
Building
-------------------------------------------------------------------------------