summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPhilipp Gesang <phg@phi-gamma.net>2021-12-22 17:41:59 +0100
committerPhilipp Gesang <phg@phi-gamma.net>2021-12-22 17:41:59 +0100
commitbb6e409e3a5f8d1b2d92eb7c5a3c4de73ea42985 (patch)
tree04c7ecc671232000bc29ad7f859de4b19ca46a4b /doc
parent3bb3213576933dc1f43f5ed6f933cc7a8030014b (diff)
downloadvtcol-bb6e409e3a5f8d1b2d92eb7c5a3c4de73ea42985.tar.gz
expand docs to cover “kb {leds,flags}” split
Diffstat (limited to 'doc')
-rw-r--r--doc/vtcol.rst25
1 files changed, 21 insertions, 4 deletions
diff --git a/doc/vtcol.rst b/doc/vtcol.rst
index e601fdd..7166c72 100644
--- a/doc/vtcol.rst
+++ b/doc/vtcol.rst
@@ -36,9 +36,9 @@ they operate on:
Inspect and manipulate the console palette.
-**leds**
+**kb**
- Keyboad LED state.
+ Keyboard manipulation (LEds, modifiers).
vtcol colors commands
#####################
@@ -100,8 +100,8 @@ vtcol colors commands
$ vtcol colors fade --ms 1337 --from solarized --to solarized_light
-vtcol leds commands
-###################
+vtcol kb leds commands
+######################
**get**
@@ -122,6 +122,23 @@ vtcol leds commands
$ vtcol leds set --revert
+vtcol kb flags commands
+######################
+
+**get**
+
+ Get the current keyboard flags. Example: ::
+
+ $ vtcol -C /dev/tty6 kb flags get
+ [flags: caps: false, num: false, scroll: false; default: caps: false, num: false, scroll: false]
+
+**set**
+
+ Set the state of individual keyboard LEDs: ::
+
+ $ vtcol flags set --caps on --num off
+
+
global options
-------------------------------------------------------------------------------