summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPhilipp Gesang <phg@phi-gamma.net>2021-12-12 01:35:28 +0100
committerPhilipp Gesang <phg@phi-gamma.net>2021-12-12 01:36:05 +0100
commit39e5145258d6cdf189d973b7acf9d8fb98f7e5ee (patch)
tree6da5a3a97421eb8ba93da07adcfbbc566fddeceb /doc
parentf86892c2639f0256a99d66bd34f40a572acc070c (diff)
downloadvtcol-39e5145258d6cdf189d973b7acf9d8fb98f7e5ee.tar.gz
doc: describe led setting in readme and manpage
Diffstat (limited to 'doc')
-rw-r--r--doc/vtcol.rst16
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/vtcol.rst b/doc/vtcol.rst
index 8531a18..a93cdf4 100644
--- a/doc/vtcol.rst
+++ b/doc/vtcol.rst
@@ -6,8 +6,8 @@
color schemes for the Linux™ console
*******************************************************************************
-:Date: 2021-12-11
-:Version: 0.42.6
+:Date: 2021-12-12
+:Version: 0.42.7
:Manual section: 1
:Manual group: console
@@ -105,14 +105,22 @@ vtcol leds commands
**get**
- Get the current led state. Example: ::
+ Get the current LED state. Example: ::
$ vtcol leds get
caps: false, num: false, scroll: false
**set**
-.. TODO:: unimplemented!()
+ Set the state of individual keyboard LEDs: ::
+
+ $ vtcol leds set --caps on --num off
+
+ Not that this command only affects the LEDs themselves. It will not change
+ the state of the corresponding modifier locks. Revert the LEDs to normal:
+ ::
+
+ $ vtcol leds set --revert
colors set options
-------------------------------------------------------------------------------