From a1e1ae7ffac99ed89a04aceb9d9c0de83b1c1d88 Mon Sep 17 00:00:00 2001
From: Philipp Gesang <phg@phi-gamma.net>
Date: Sun, 12 Dec 2021 12:35:55 +0100
Subject: doc: expand man page some more
---
doc/vtcol.rst | 44 ++++++++++++++++++++++++++++++++++++++++----
1 file changed, 40 insertions(+), 4 deletions(-)
diff --git a/doc/vtcol.rst b/doc/vtcol.rst
index a93cdf4..e601fdd 100644
--- a/doc/vtcol.rst
+++ b/doc/vtcol.rst
@@ -3,7 +3,7 @@
===============================================================================
*******************************************************************************
- color schemes for the Linux™ console
+ color schemes for the Linux™ console
*******************************************************************************
:Date: 2021-12-12
@@ -14,7 +14,7 @@
Synopsis
-------------------------------------------------------------------------------
-**vtcol** [--help] [--version] [--verbose] <command> [<args>]
+**vtcol** [--help] [--version] [--verbose] [--console <con>] <command> [<args>]
Description
-------------------------------------------------------------------------------
@@ -98,7 +98,7 @@ vtcol colors commands
Transition between two color schemes with a fading effect. If no starting
color scheme is specified, the current one is used. ::
- $ vtcol colors fade --ms 1337 --from solarized --to solarized_light
+ $ vtcol colors fade --ms 1337 --from solarized --to solarized_light
vtcol leds commands
###################
@@ -122,6 +122,25 @@ vtcol leds commands
$ vtcol leds set --revert
+global options
+-------------------------------------------------------------------------------
+
+The options described in this section are not specific to a subcommand and can
+be used everywhere on the command line.
+
+``-v, --verbose``
+
+ Enable some extra status messages.
+
+``-C, --console CON``
+
+ Operate on the console located at the path ``CON`` instead of the active
+ one. Usually this is one of the ``/dev/tty*`` devices. For example, to
+ get the scheme on a console some *getty*: ::
+
+ $ vtcol colors get \
+ --console $(readlink /proc/$(pgrep getty| head -1)/fd/0)
+
colors set options
-------------------------------------------------------------------------------
::
@@ -191,7 +210,20 @@ colors fade options
Scheme file syntax overview
-------------------------------------------------------------------------------
-.. TODO:: unimplemented!()
+Scheme files use a trivial line-based grammar: whatever hexadecimal RGB color
+expression is found first on a line is used as the next color until the whole
+palette of 16 colors is reached. ::
+
+ $ cat schemes/zebra
+ 00#000000 white
+ 01#ffffff black
+ 02#000000 white
+ …
+ 15#ffffff black
+
+Everything before and after the color expression will be ignored. If the end
+of the scheme file is reached without having assigned all colors, the remainder
+will be set to zero (RGB 0, 0, 0).
Examples
-------------------------------------------------------------------------------
@@ -228,6 +260,10 @@ Examples
$ vtcol colors get --base64
+9. Get the color scheme of a specific console: ::
+
+ $ vtcol colors get --console /dev/tty6
+
Copyright
-------------------------------------------------------------------------------
--
cgit v1.2.3