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

Last change on this file since d756069 was be02e66, checked in by Joe Ciccone <jciccone@…>, 17 years ago

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