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

clfs-2.1clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since acd6620 was acd6620, checked in by William Harrington <kb0iic@…>, 9 years ago

Remove Vlock from kbd configuration as it requires PAM.

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