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

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

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