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

clfs-3.0.0-systemdsystemd
Last change on this file since a3e4883 was a3e4883, checked in by Chris Staub <chris@…>, 8 years ago

Text fix

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