source: clfs-sysroot/BOOK/final-system/common/kbd.xml

Last change on this file was 12e6567, checked in by Joe Ciccone <jciccone@…>, 10 years ago

Added a sysroot wrapper.
Updated the build variables section of the book, each package uses its own.

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