source: final-system/common/kbd.xml@ 3af72cf

Last change on this file since 3af72cf was 05e21a5, checked in by Chris Staub <chris@…>, 18 years ago

Added explanation for datadir parameter in kbd instructions

  • Property mode set to 100644
File size: 11.5 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/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="p1">The following patch fixes build issues with GCC &gcc-version;:</para>
29
30<screen os="p2"><userinput>patch -Np1 -i ../&kbd-gcc4_fixes-patch;</userinput></screen>
31
32 <para os="a">Prepare Kbd for compilation:</para>
33
34<screen os="b"><userinput>./configure --datadir=/lib/kbd</userinput></screen>
35
36 <variablelist os="c">
37 <title>The meaning of the configure options:</title>
38
39 <varlistentry>
40 <term><parameter>--datadir</parameter></term>
41 <listitem>
42 <para>This option places the Kbd data and keymap files into /lib/kbd,
43 as they are used by some of the scripts in the CLFS-Bootscripts
44 package and must be on the root partition.</para>
45 </listitem>
46 </varlistentry>
47
48 </variablelist>
49
50 <para os="d">Compile the package:</para>
51
52<screen os="e"><userinput>make</userinput></screen>
53
54 <para os="f">This package does not come with a test suite.</para>
55
56 <para os="g">Install the package:</para>
57
58<screen os="h"><userinput>make install</userinput></screen>
59
60 <para os="i">Some of the programs from Kbd are used by scripts
61 in the CLFS-Bootscripts package. As <filename
62 class="directory">/usr</filename> may not be available during the early
63 stages of booting, those binaries need to be on the root partition:</para>
64
65<screen os="j"><userinput>mv -v /usr/bin/{kbd_mode,openvt,setfont} /bin</userinput></screen>
66
67 </sect2>
68
69 <sect2 id="contents-kbd" role="content">
70 <title>Contents of Kbd</title>
71
72 <segmentedlist>
73 <segtitle>Installed programs</segtitle>
74
75 <seglistitem>
76 <seg>chvt, deallocvt, dumpkeys, fgconsole, getkeycodes, kbd_mode,
77 kbdrate, loadkeys, loadunimap, mapscrn, openvt, psfaddtable
78 (link to psfxtable), psfgettable (link to psfxtable), psfstriptable
79 (link to psfxtable), psfxtable, resizecons, setfont, setkeycodes,
80 setleds, setmetamode, showconsolefont, showkey, unicode_start, and
81 unicode_stop</seg>
82 </seglistitem>
83 </segmentedlist>
84
85 <variablelist>
86 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
87 <?dbfo list-presentation="list"?>
88 <?dbhtml list-presentation="table"?>
89
90 <varlistentry id="chvt">
91 <term><command>chvt</command></term>
92 <listitem>
93 <para>Changes the foreground virtual terminal</para>
94 <indexterm zone="ch-system-kbd chvt">
95 <primary sortas="b-chvt">chvt</primary>
96 </indexterm>
97 </listitem>
98 </varlistentry>
99
100 <varlistentry id="deallocvt">
101 <term><command>deallocvt</command></term>
102 <listitem>
103 <para>Deallocates unused virtual terminals</para>
104 <indexterm zone="ch-system-kbd deallocvt">
105 <primary sortas="b-deallocvt">deallocvt</primary>
106 </indexterm>
107 </listitem>
108 </varlistentry>
109
110 <varlistentry id="dumpkeys">
111 <term><command>dumpkeys</command></term>
112 <listitem>
113 <para>Dumps the keyboard translation tables</para>
114 <indexterm zone="ch-system-kbd dumpkeys">
115 <primary sortas="b-dumpkeys">dumpkeys</primary>
116 </indexterm>
117 </listitem>
118 </varlistentry>
119
120 <varlistentry id="fgconsole">
121 <term><command>fgconsole</command></term>
122 <listitem>
123 <para>Prints the number of the active virtual terminal</para>
124 <indexterm zone="ch-system-kbd fgconsole">
125 <primary sortas="b-fgconsole">fgconsole</primary>
126 </indexterm>
127 </listitem>
128 </varlistentry>
129
130 <varlistentry id="getkeycodes">
131 <term><command>getkeycodes</command></term>
132 <listitem>
133 <para>Prints the kernel scancode-to-keycode mapping table</para>
134 <indexterm zone="ch-system-kbd getkeycodes">
135 <primary sortas="b-getkeycodes">getkeycodes</primary>
136 </indexterm>
137 </listitem>
138 </varlistentry>
139
140 <varlistentry id="kbd_mode">
141 <term><command>kbd_mode</command></term>
142 <listitem>
143 <para>Reports or sets the keyboard mode</para>
144 <indexterm zone="ch-system-kbd kbd_mode">
145 <primary sortas="b-kbd_mode">kbd_mode</primary>
146 </indexterm>
147 </listitem>
148 </varlistentry>
149
150 <varlistentry id="kbdrate">
151 <term><command>kbdrate</command></term>
152 <listitem>
153 <para>Sets the keyboard repeat and delay rates</para>
154 <indexterm zone="ch-system-kbd kbdrate">
155 <primary sortas="b-kbdrate">kbdrate</primary>
156 </indexterm>
157 </listitem>
158 </varlistentry>
159
160 <varlistentry id="loadkeys">
161 <term><command>loadkeys</command></term>
162 <listitem>
163 <para>Loads the keyboard translation tables</para>
164 <indexterm zone="ch-system-kbd loadkeys">
165 <primary sortas="b-loadkeys">loadkeys</primary>
166 </indexterm>
167 </listitem>
168 </varlistentry>
169
170 <varlistentry id="loadunimap">
171 <term><command>loadunimap</command></term>
172 <listitem>
173 <para>Loads the kernel unicode-to-font mapping table</para>
174 <indexterm zone="ch-system-kbd loadunimap">
175 <primary sortas="b-loadunimap">loadunimap</primary>
176 </indexterm>
177 </listitem>
178 </varlistentry>
179
180 <varlistentry id="mapscrn">
181 <term><command>mapscrn</command></term>
182 <listitem>
183 <para>An obsolete program that used to load a user-defined output
184 character mapping table into the console driver; this is now done
185 by <command>setfont</command></para>
186 <indexterm zone="ch-system-kbd mapscrn">
187 <primary sortas="b-mapscrn">mapscrn</primary>
188 </indexterm>
189 </listitem>
190 </varlistentry>
191
192 <varlistentry id="openvt">
193 <term><command>openvt</command></term>
194 <listitem>
195 <para>Starts a program on a new virtual terminal (VT)</para>
196 <indexterm zone="ch-system-kbd openvt">
197 <primary sortas="b-openvt">openvt</primary>
198 </indexterm>
199 </listitem>
200 </varlistentry>
201
202 <varlistentry id="psfaddtable">
203 <term><command>psfaddtable</command></term>
204 <listitem>
205 <para>A link to <command>psfxtable</command></para>
206 <indexterm zone="ch-system-kbd psfaddtable">
207 <primary sortas="b-psfaddtable">psfaddtable</primary>
208 </indexterm>
209 </listitem>
210 </varlistentry>
211
212 <varlistentry id="psfgettable">
213 <term><command>psfgettable</command></term>
214 <listitem>
215 <para>A link to <command>psfxtable</command></para>
216 <indexterm zone="ch-system-kbd psfgettable">
217 <primary sortas="b-psfgettable">psfgettable</primary>
218 </indexterm>
219 </listitem>
220 </varlistentry>
221
222 <varlistentry id="psfstriptable">
223 <term><command>psfstriptable</command></term>
224 <listitem>
225 <para>A link to <command>psfxtable</command></para>
226 <indexterm zone="ch-system-kbd psfstriptable">
227 <primary sortas="b-psfstriptable">psfstriptable</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="psfxtable">
233 <term><command>psfxtable</command></term>
234 <listitem>
235 <para>Handle Unicode character tables for console fonts</para>
236 <indexterm zone="ch-system-kbd psfxtable">
237 <primary sortas="b-psfxtable">psfxtable</primary>
238 </indexterm>
239 </listitem>
240 </varlistentry>
241
242 <varlistentry id="resizecons">
243 <term><command>resizecons</command></term>
244 <listitem>
245 <para>Changes the kernel idea of the console size</para>
246 <indexterm zone="ch-system-kbd resizecons">
247 <primary sortas="b-resizecons">resizecons</primary>
248 </indexterm>
249 </listitem>
250 </varlistentry>
251
252 <varlistentry id="setfont">
253 <term><command>setfont</command></term>
254 <listitem>
255 <para>Changes the Enhanced Graphic Adapter (EGA) and Video Graphics
256 Array (VGA) fonts on the console</para>
257 <indexterm zone="ch-system-kbd setfont">
258 <primary sortas="b-setfont">setfont</primary>
259 </indexterm>
260 </listitem>
261 </varlistentry>
262
263 <varlistentry id="setkeycodes">
264 <term><command>setkeycodes</command></term>
265 <listitem>
266 <para>Loads kernel scancode-to-keycode mapping table entries; this is
267 useful if there are unusual keys on the keyboard</para>
268 <indexterm zone="ch-system-kbd setkeycodes">
269 <primary sortas="b-setkeycodes">setkeycodes</primary>
270 </indexterm>
271 </listitem>
272 </varlistentry>
273
274 <varlistentry id="setleds">
275 <term><command>setleds</command></term>
276 <listitem>
277 <para>Sets the keyboard flags and Light Emitting Diodes (LEDs)</para>
278 <indexterm zone="ch-system-kbd setleds">
279 <primary sortas="b-setleds">setleds</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 <varlistentry id="setmetamode">
285 <term><command>setmetamode</command></term>
286 <listitem>
287 <para>Defines the keyboard meta-key handling</para>
288 <indexterm zone="ch-system-kbd setmetamode">
289 <primary sortas="b-setmetamode">setmetamode</primary>
290 </indexterm>
291 </listitem>
292 </varlistentry>
293
294 <varlistentry id="showconsolefont">
295 <term><command>showconsolefont</command></term>
296 <listitem>
297 <para>Shows the current EGA/VGA console screen font</para>
298 <indexterm zone="ch-system-kbd showconsolefont">
299 <primary sortas="b-showconsolefont">showconsolefont</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 <varlistentry id="showkey">
305 <term><command>showkey</command></term>
306 <listitem>
307 <para>Reports the scancodes, keycodes, and ASCII codes of the keys
308 pressed on the keyboard</para>
309 <indexterm zone="ch-system-kbd showkey">
310 <primary sortas="b-showkey">showkey</primary>
311 </indexterm>
312 </listitem>
313 </varlistentry>
314
315 <varlistentry id="unicode_start">
316 <term><command>unicode_start</command></term>
317 <listitem>
318 <para>Puts the keyboard and console in UNICODE mode. Never use it on
319 CLFS, because applications are not configured to support UNICODE.</para>
320 <indexterm zone="ch-system-kbd unicode_start">
321 <primary sortas="b-unicode_start">unicode_start</primary>
322 </indexterm>
323 </listitem>
324 </varlistentry>
325
326 <varlistentry id="unicode_stop">
327 <term><command>unicode_stop</command></term>
328 <listitem>
329 <para>Reverts keyboard and console from UNICODE mode</para>
330 <indexterm zone="ch-system-kbd unicode_stop">
331 <primary sortas="b-unicode_stop">unicode_stop</primary>
332 </indexterm>
333 </listitem>
334 </varlistentry>
335
336 </variablelist>
337
338 </sect2>
339
340</sect1>
Note: See TracBrowser for help on using the repository browser.