1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
===============================================================================
vtcol
===============================================================================
*******************************************************************************
color schemes for the Linux™ console
*******************************************************************************
:Date: 2021-12-12
:Version: 0.42.7
:Manual section: 1
:Manual group: console
Synopsis
-------------------------------------------------------------------------------
**vtcol** [--help] [--version] [--verbose] <command> [<args>]
Description
-------------------------------------------------------------------------------
**vtcol** manipulates and inspects the color map of the Linux console
using ``ioctl_console(2)`` syscalls.
vtcol commands
-------------------------------------------------------------------------------
``vtcol`` actions are grouped into subcommands depending on the functionality
they operate on:
**help**
Prints this message or the help of the given subcommand(s)
**colors**
Inspect and manipulate the console palette.
**leds**
Keyboad LED state.
vtcol colors commands
#####################
**set**
Set the scheme for the current terminal with ``PIO_CMAP``. ::
$ vtcol colors set solarized
**list**
List predefined schemes. ::
$ vtcol colors list
4 color schemes available:
* solarized
* solarized_light
* default
* phosphor
These are only the schemes built into the ``vtcol`` binary. Any
other scheme can be loaded using the ``--file`` argument.
**dump**
Print the palette of the specified scheme in more or less human readable
representation.
**get**
Get the current color scheme with ``GIO_CMAP``. The result is matched
against the builtin schemes; if a scheme matches, only its preferred name
is printed (e. g. ``solarized_light``). ::
$ vtcol colors get
solarized
Otherwise the palette is printed as with the ``dump`` subcommand.
**toggle**
Like ``vtcol colors set`` but supports two ``SCHEME`` arguments.
First the active scheme is checked against *the first positional argument*;
if there is a match, the scheme specified by the *second argument* will be
loaded, otherwise the first one. The effect is that in repeated invocations
of the same command the scheme is toggled between the two arguments. E. g.
use: ::
$ vtcol colors toggle solarized solarized_light
to cycle the console palette between “dark mode” and “light mode”.
**fade**
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 leds commands
###################
**get**
Get the current LED state. Example: ::
$ vtcol leds get
caps: false, num: false, scroll: false
**set**
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
-------------------------------------------------------------------------------
::
vtcol colors set [--file FILE]
vtcol colors set [SCHEME]
``SCHEME``
Load the predefined color scheme *SCHEME*. For a list of options, use
``vtcol colors list``. Alternatively, ``-`` can be used to specify *stdin*.
``-f FILE, --file FILE``
Load color scheme from *FILE* which can be a filesystem path or the special
argument ``-`` to specify *stdin*.
Mutually exclusive with *SCHEME*.
colors toggle options
-------------------------------------------------------------------------------
`vtcol colors toggle ONE TWO``
``ONE``
First scheme to alternate between. Will be loaded *unless* it is the active
scheme.
``TWO``
Second scheme to alternate between. Will be loaded if *ONE* is the active
scheme.
colors fade options
-------------------------------------------------------------------------------
::
vtcol colors fade [--clear] [--frequency HZ] [--ms MS]
[--from START] --to END
``END``
The scheme to transition to. After completion this will remain the active
scheme of the current console.
``START``
Load the predefined color scheme *SCHEME* before starting the transition.
``-f HZ, --frequency HZ``
Screen update rate in ``HZ / s``.
``-m MS, --ms MS``
Duration of the transition in milliseconds.
``-c, --clear``
Whether to clear the console after each update step. This causes the
background color to be applied to the entire screen and not just the parts
that changed for a more uniform transition. The downside of ``--clear`` is
that all text is erased as well.
Scheme file syntax overview
-------------------------------------------------------------------------------
.. TODO:: unimplemented!()
Examples
-------------------------------------------------------------------------------
1. Get the current color scheme: ::
$ vtcol colors get
2. Turn your screen into an 80s style monochrome lookalike: ::
$ vtcol colors set phosphor
3. Reset console to default colors: ::
$ vtcol colors set default
4. Set color scheme from stdin: ::
$ <./schemes/zebra vtcol colors set -
5. List available builtin schemes: ::
$ vtcol colors list
6. Cycle between night mode and day mode: ::
$ vtcol colors toggle solarized solarized_light
7. Transition from dark to light scheme while dumping some data for effect: ::
$ vtcol colors fade -m 1500 -f solarized -t solarized_light & dmesg
8. Dump current scheme in binary form: ::
$ vtcol colors get --base64
Copyright
-------------------------------------------------------------------------------
Copyright: 2015-2021 Philipp Gesang
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License.
See also
-------------------------------------------------------------------------------
**ioctl_console**\(2), **tty**\(4)
The ``setcolors`` utility should be considered prior art, visit
`<https://github.com/EvanPurkhiser/linux-vt-setcolors>`.
Notes
-------------------------------------------------------------------------------
Upstream resides at `<https://gitlab.com/phgsgng/vtcol>`.
|
