source: BOOK/final-system/common/kbd.xml@ c1c9615

clfs-3.0.0-sysvinit sysvinit
Last change on this file since c1c9615 was c1c9615, checked in by Chris Staub <chris@…>, 11 years ago

Better commands descriptions for Kbd progs
  • Property mode set to 100644
File size: 12.5 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6]>
7
8<sect1 id="ch-system-kbd" role="wrap">
9 <?dbhtml filename="kbd.html"?>
10
11 <title>Kbd-&kbd-version;</title>
12
13 <indexterm zone="ch-system-kbd">
14 <primary sortas="a-Kbd">Kbd</primary>
15 </indexterm>
16
17 <sect2 role="package">
18 <title/>
19
20 <para>The Kbd package contains key-table files and keyboard
21 utilities.</para>
22
23 </sect2>
24
25 <sect2 role="installation">
26 <title>Installation of Kbd</title>
27
28 <para os="a">Prepare Kbd for compilation:</para>
29
30<screen os="b"><userinput>PKG_CONFIG_PATH="/tools/lib/pkgconfig" \
31 ./configure --prefix=/usr --disable-vlock --enable-optional-progs</userinput></screen>
32
33 <variablelist os="c">
34 <title>The meaning of the configure option:</title>
35
36 <varlistentry>
37 <term><envar>PKG_CONFIG_PATH</envar></term>
38 <listitem>
39 <para>Use pkg-config to obtain the location of the test library
40 metadata built in <xref linkend="ch-temp-system-check"/>.</para>
41 </listitem>
42 </varlistentry>
43 </variablelist>
44
45 <para os="d">Compile the package:</para>
46
47<screen os="e"><userinput>make</userinput></screen>
48
49 <para os="f">To test the results, issue:</para>
50
51<screen os="g"><userinput remap="test">make check</userinput></screen>
52
53 <para os="h">Install the package:</para>
54
55<screen os="i"><userinput>make install</userinput></screen>
56
57 <para os="j">Some of the programs from Kbd are used by the CLFS Bootscripts
58 to initialize the system, so those binaries need to be on the root
59 partition:</para>
60
61<screen os="k"><userinput>mv -v /usr/bin/{dumpkeys,kbd_mode,loadkeys,setfont} /bin</userinput></screen>
62
63 <para os="l">Install the documentation:</para>
64
65<screen os="m"><userinput>mkdir -v /usr/share/doc/kbd-&kbd-version;
66cp -R -v docs/doc/* /usr/share/doc/kbd-&kbd-version;</userinput></screen>
67
68 </sect2>
69
70 <sect2 id="contents-kbd" role="content">
71 <title>Contents of Kbd</title>
72
73 <segmentedlist>
74 <segtitle>Installed programs</segtitle>
75 <segtitle>Installed directories</segtitle>
76
77 <seglistitem>
78 <seg>chvt, deallocvt, dumpkeys, fgconsole, getkeycodes, kbdinfo,
79 kbd_mode, kbdrate, loadkeys, loadunimap, mapscrn, openvt, psfaddtable
80 (link to psfxtable), psfgettable (link to psfxtable), psfstriptable
81 (link to psfxtable), psfxtable, resizecons, setfont, setkeycodes,
82 setleds, setmetamode, setvtrgb, showconsolefont, showkey,
83 unicode_start, unicode_stop</seg>
84 <seg>/usr/share/consolefonts, /usr/share/consoletrans,
85 /usr/share/doc/kbd-&kbd-version;,
86 /usr/share/keymaps, /usr/share/unimaps</seg>
87 </seglistitem>
88 </segmentedlist>
89
90 <variablelist>
91 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
92 <?dbfo list-presentation="list"?>
93 <?dbhtml list-presentation="table"?>
94
95 <varlistentry id="chvt">
96 <term><command>chvt</command></term>
97 <listitem>
98 <para>Changes the foreground virtual terminal</para>
99 <indexterm zone="ch-system-kbd chvt">
100 <primary sortas="b-chvt">chvt</primary>
101 </indexterm>
102 </listitem>
103 </varlistentry>
104
105 <varlistentry id="deallocvt">
106 <term><command>deallocvt</command></term>
107 <listitem>
108 <para>Deallocates unused virtual terminals</para>
109 <indexterm zone="ch-system-kbd deallocvt">
110 <primary sortas="b-deallocvt">deallocvt</primary>
111 </indexterm>
112 </listitem>
113 </varlistentry>
114
115 <varlistentry id="dumpkeys">
116 <term><command>dumpkeys</command></term>
117 <listitem>
118 <para>Dumps the keyboard translation tables</para>
119 <indexterm zone="ch-system-kbd dumpkeys">
120 <primary sortas="b-dumpkeys">dumpkeys</primary>
121 </indexterm>
122 </listitem>
123 </varlistentry>
124
125 <varlistentry id="fgconsole">
126 <term><command>fgconsole</command></term>
127 <listitem>
128 <para>Prints the number of the active virtual terminal</para>
129 <indexterm zone="ch-system-kbd fgconsole">
130 <primary sortas="b-fgconsole">fgconsole</primary>
131 </indexterm>
132 </listitem>
133 </varlistentry>
134
135 <varlistentry id="getkeycodes">
136 <term><command>getkeycodes</command></term>
137 <listitem>
138 <para>Prints the kernel scancode-to-keycode mapping table</para>
139 <indexterm zone="ch-system-kbd getkeycodes">
140 <primary sortas="b-getkeycodes">getkeycodes</primary>
141 </indexterm>
142 </listitem>
143 </varlistentry>
144
145 <varlistentry id="kbdinfo">
146 <term><command>kbdinfo</command></term>
147 <listitem>
148 <para>Obtains information about the console</para>
149 <indexterm zone="ch-system-kbd kbdinfo">
150 <primary sortas="b-kbdinfo">kbdinfo</primary>
151 </indexterm>
152 </listitem>
153 </varlistentry>
154
155 <varlistentry id="kbd_mode">
156 <term><command>kbd_mode</command></term>
157 <listitem>
158 <para>Reports or sets the keyboard mode</para>
159 <indexterm zone="ch-system-kbd kbd_mode">
160 <primary sortas="b-kbd_mode">kbd_mode</primary>
161 </indexterm>
162 </listitem>
163 </varlistentry>
164
165 <varlistentry id="kbdrate">
166 <term><command>kbdrate</command></term>
167 <listitem>
168 <para>Sets the keyboard repeat and delay rates</para>
169 <indexterm zone="ch-system-kbd kbdrate">
170 <primary sortas="b-kbdrate">kbdrate</primary>
171 </indexterm>
172 </listitem>
173 </varlistentry>
174
175 <varlistentry id="loadkeys">
176 <term><command>loadkeys</command></term>
177 <listitem>
178 <para>Loads the keyboard translation tables</para>
179 <indexterm zone="ch-system-kbd loadkeys">
180 <primary sortas="b-loadkeys">loadkeys</primary>
181 </indexterm>
182 </listitem>
183 </varlistentry>
184
185 <varlistentry id="loadunimap">
186 <term><command>loadunimap</command></term>
187 <listitem>
188 <para>Loads the kernel unicode-to-font mapping table</para>
189 <indexterm zone="ch-system-kbd loadunimap">
190 <primary sortas="b-loadunimap">loadunimap</primary>
191 </indexterm>
192 </listitem>
193 </varlistentry>
194
195 <varlistentry id="mapscrn">
196 <term><command>mapscrn</command></term>
197 <listitem>
198 <para>An obsolete program that used to load a user-defined output
199 character mapping table into the console driver; this is now done
200 by <command>setfont</command></para>
201 <indexterm zone="ch-system-kbd mapscrn">
202 <primary sortas="b-mapscrn">mapscrn</primary>
203 </indexterm>
204 </listitem>
205 </varlistentry>
206
207 <varlistentry id="openvt">
208 <term><command>openvt</command></term>
209 <listitem>
210 <para>Starts a program on a new virtual terminal (VT)</para>
211 <indexterm zone="ch-system-kbd openvt">
212 <primary sortas="b-openvt">openvt</primary>
213 </indexterm>
214 </listitem>
215 </varlistentry>
216
217 <varlistentry id="psfaddtable">
218 <term><command>psfaddtable</command></term>
219 <listitem>
220 <para>Adds a Unicode character table to a console font</para>
221 <indexterm zone="ch-system-kbd psfaddtable">
222 <primary sortas="b-psfaddtable">psfaddtable</primary>
223 </indexterm>
224 </listitem>
225 </varlistentry>
226
227 <varlistentry id="psfgettable">
228 <term><command>psfgettable</command></term>
229 <listitem>
230 <para>Extracts the embedded Unicode character table from a console
231 font</para>
232 <indexterm zone="ch-system-kbd psfgettable">
233 <primary sortas="b-psfgettable">psfgettable</primary>
234 </indexterm>
235 </listitem>
236 </varlistentry>
237
238 <varlistentry id="psfstriptable">
239 <term><command>psfstriptable</command></term>
240 <listitem>
241 <para>Removes the embedded Unicode character table from a console
242 font</para>
243 <indexterm zone="ch-system-kbd psfstriptable">
244 <primary sortas="b-psfstriptable">psfstriptable</primary>
245 </indexterm>
246 </listitem>
247 </varlistentry>
248
249 <varlistentry id="psfxtable">
250 <term><command>psfxtable</command></term>
251 <listitem>
252 <para>Handle Unicode character tables for console fonts</para>
253 <indexterm zone="ch-system-kbd psfxtable">
254 <primary sortas="b-psfxtable">psfxtable</primary>
255 </indexterm>
256 </listitem>
257 </varlistentry>
258
259 <varlistentry id="resizecons">
260 <term><command>resizecons</command></term>
261 <listitem>
262 <para>Changes the kernel idea of the console size</para>
263 <indexterm zone="ch-system-kbd resizecons">
264 <primary sortas="b-resizecons">resizecons</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry id="setfont">
270 <term><command>setfont</command></term>
271 <listitem>
272 <para>Changes the Enhanced Graphic Adapter (EGA) and Video Graphics
273 Array (VGA) fonts on the console</para>
274 <indexterm zone="ch-system-kbd setfont">
275 <primary sortas="b-setfont">setfont</primary>
276 </indexterm>
277 </listitem>
278 </varlistentry>
279
280 <varlistentry id="setkeycodes">
281 <term><command>setkeycodes</command></term>
282 <listitem>
283 <para>Loads kernel scancode-to-keycode mapping table entries; this is
284 useful if there are unusual keys on the keyboard</para>
285 <indexterm zone="ch-system-kbd setkeycodes">
286 <primary sortas="b-setkeycodes">setkeycodes</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="setleds">
292 <term><command>setleds</command></term>
293 <listitem>
294 <para>Sets the keyboard flags and Light Emitting Diodes (LEDs)</para>
295 <indexterm zone="ch-system-kbd setleds">
296 <primary sortas="b-setleds">setleds</primary>
297 </indexterm>
298 </listitem>
299 </varlistentry>
300
301 <varlistentry id="setmetamode">
302 <term><command>setmetamode</command></term>
303 <listitem>
304 <para>Defines the keyboard meta-key handling</para>
305 <indexterm zone="ch-system-kbd setmetamode">
306 <primary sortas="b-setmetamode">setmetamode</primary>
307 </indexterm>
308 </listitem>
309 </varlistentry>
310
311 <varlistentry id="setvtrgb">
312 <term><command>setvtrgb</command></term>
313 <listitem>
314 <para>Sets the virtal terminal RGB colors</para>
315 <indexterm zone="ch-system-kbd setvtrgb">
316 <primary sortas="b-setvtrgb">setvtrgb</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 <varlistentry id="showconsolefont">
322 <term><command>showconsolefont</command></term>
323 <listitem>
324 <para>Shows the current EGA/VGA console screen font</para>
325 <indexterm zone="ch-system-kbd showconsolefont">
326 <primary sortas="b-showconsolefont">showconsolefont</primary>
327 </indexterm>
328 </listitem>
329 </varlistentry>
330
331 <varlistentry id="showkey">
332 <term><command>showkey</command></term>
333 <listitem>
334 <para>Reports the scancodes, keycodes, and ASCII codes of the keys
335 pressed on the keyboard</para>
336 <indexterm zone="ch-system-kbd showkey">
337 <primary sortas="b-showkey">showkey</primary>
338 </indexterm>
339 </listitem>
340 </varlistentry>
341
342 <varlistentry id="unicode_start">
343 <term><command>unicode_start</command></term>
344 <listitem>
345 <para>Puts the keyboard and console in UNICODE mode. Never use it on
346 CLFS, because applications are not configured to support UNICODE.</para>
347 <indexterm zone="ch-system-kbd unicode_start">
348 <primary sortas="b-unicode_start">unicode_start</primary>
349 </indexterm>
350 </listitem>
351 </varlistentry>
352
353 <varlistentry id="unicode_stop">
354 <term><command>unicode_stop</command></term>
355 <listitem>
356 <para>Reverts keyboard and console from UNICODE mode</para>
357 <indexterm zone="ch-system-kbd unicode_stop">
358 <primary sortas="b-unicode_stop">unicode_stop</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 </variablelist>
364
365 </sect2>
366
367</sect1>
Note: See TracBrowser for help on using the repository browser.