source: clfs-sysroot/BOOK/final-system/arm/kbd.xml@ 9caeffe

Last change on this file since 9caeffe was 583f283, checked in by Joe Ciccone <jciccone@…>, 18 years ago

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