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

clfs-3.0.0-systemd systemd
Last change on this file since d0ed54ea was 7adbc2f, checked in by Chris Staub <chris@…>, 11 years ago

Kbd does have a testsuite

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