diff options
author | Philipp Gesang <phg@phi-gamma.net> | 2021-12-12 01:35:28 +0100 |
---|---|---|
committer | Philipp Gesang <phg@phi-gamma.net> | 2021-12-12 01:36:05 +0100 |
commit | 39e5145258d6cdf189d973b7acf9d8fb98f7e5ee (patch) | |
tree | 6da5a3a97421eb8ba93da07adcfbbc566fddeceb | |
parent | f86892c2639f0256a99d66bd34f40a572acc070c (diff) | |
download | vtcol-39e5145258d6cdf189d973b7acf9d8fb98f7e5ee.tar.gz |
doc: describe led setting in readme and manpage
-rw-r--r-- | Cargo.toml | 2 | ||||
-rw-r--r-- | README.rst | 5 | ||||
-rw-r--r-- | doc/vtcol.rst | 16 |
3 files changed, 18 insertions, 5 deletions
@@ -5,7 +5,7 @@ [package] name = "vtcol" description = "Set Linux console color scheme" -version = "0.42.6" +version = "0.42.7" authors = [ "Philipp Gesang <phg@phi-gamma.net>" ] repository = "https://github.com/phi-gamma/vtcol" keywords = [ "linux", "virtual_terminal", "tty", "console", "system" ] @@ -78,6 +78,11 @@ Show the current state of the keyboard LEDs: :: $ vtcol leds get caps: false, num: true, scroll: false +Set the state of the Caps Lock LED (does *not* affect the Caps Lock state, just +the LED itself): :: + + $ vtcol leds set --caps on + Building ------------------------------------------------------------------------------- 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 ------------------------------------------------------------------------------- |