source: chapter08/kbd.xml

trunk
Last change on this file was 7152faa, checked in by Pierre Labastie <pierre.labastie@…>, 3 months ago

Change all xml files to utf-8 encoding

  • Property mode set to 100644
File size: 13.4 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
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 <sect1info condition="script">
12 <productname>kbd</productname>
13 <productnumber>&kbd-version;</productnumber>
14 <address>&kbd-url;</address>
15 </sect1info>
16
17 <title>Kbd-&kbd-version;</title>
18
19 <indexterm zone="ch-system-kbd">
20 <primary sortas="a-Kbd">Kbd</primary>
21 </indexterm>
22
23 <sect2 role="package">
24 <title/>
25
26 <para>The Kbd package contains key-table files, console fonts, and keyboard
27 utilities.</para>
28
29 <segmentedlist>
30 <segtitle>&buildtime;</segtitle>
31 <segtitle>&diskspace;</segtitle>
32
33 <seglistitem>
34 <seg>&kbd-fin-sbu;</seg>
35 <seg>&kbd-fin-du;</seg>
36 </seglistitem>
37 </segmentedlist>
38
39 </sect2>
40
41 <sect2 role="installation">
42 <title>Installation of Kbd</title>
43
44 <para>The behavior of the backspace and delete keys is not consistent
45 across the keymaps in the Kbd package. The following patch fixes this
46 issue for i386 keymaps:</para>
47
48<screen><userinput remap="pre">patch -Np1 -i ../&kbd-backspace-patch;</userinput></screen>
49
50 <para>After patching, the backspace key generates the character with code 127,
51 and the delete key generates a well-known escape sequence.</para>
52
53 <para>Remove the redundant <command>resizecons</command> program (it requires
54 the defunct svgalib to provide the video mode files - for normal use
55 <command>setfont</command> sizes the console appropriately) together with its
56 manpage.</para>
57
58<screen><userinput remap="pre">sed -i '/RESIZECONS_PROGS=/s/yes/no/' configure
59sed -i 's/resizecons.8 //' docs/man/man8/Makefile.in</userinput></screen>
60
61 <para>Prepare Kbd for compilation:</para>
62
63<screen><userinput remap="configure">./configure --prefix=/usr --disable-vlock</userinput></screen>
64
65 <variablelist>
66 <title>The meaning of the configure option:</title>
67
68 <varlistentry>
69 <term><parameter>--disable-vlock</parameter></term>
70 <listitem>
71 <para>This option prevents the vlock utility from being built because it
72 requires the PAM library, which isn't available in the chroot
73 environment.</para>
74 </listitem>
75 </varlistentry>
76
77 </variablelist>
78
79 <para>Compile the package:</para>
80
81<screen><userinput remap="make">make</userinput></screen>
82
83 <para>To test the results, issue:</para>
84
85<screen><userinput remap="test">make check</userinput></screen>
86
87 <para>Install the package:</para>
88
89<screen><userinput remap="install">make install</userinput></screen>
90
91 <note>
92 <para>For some languages (e.g., Belarusian) the Kbd package doesn't
93 provide a useful keymap where the stock <quote>by</quote> keymap assumes
94 the ISO-8859-5 encoding, and the CP1251 keymap is normally used. Users of
95 such languages have to download working keymaps separately.</para>
96 </note>
97
98 <para>If desired, install the documentation:</para>
99
100<screen><userinput remap="install">cp -R -v docs/doc -T /usr/share/doc/kbd-&kbd-version;</userinput></screen>
101
102 </sect2>
103
104 <sect2 id="contents-kbd" role="content">
105 <title>Contents of Kbd</title>
106
107 <segmentedlist>
108 <segtitle>Installed programs</segtitle>
109 <segtitle>Installed directories</segtitle>
110
111 <seglistitem>
112 <seg>chvt, deallocvt, dumpkeys, fgconsole, getkeycodes, kbdinfo,
113 kbd_mode, kbdrate, loadkeys, loadunimap,
114 mapscrn, openvt, psfaddtable (link to psfxtable), psfgettable (link to
115 psfxtable), psfstriptable (link to psfxtable), psfxtable, <!--resizecons,-->
116 setfont, setkeycodes, setleds, setmetamode, setvtrgb,
117 showconsolefont, showkey, unicode_start, and unicode_stop</seg>
118 <seg>/usr/share/consolefonts, /usr/share/consoletrans, /usr/share/keymaps,
119 /usr/share/doc/kbd-&kbd-version;, and /usr/share/unimaps</seg>
120 </seglistitem>
121 </segmentedlist>
122
123 <variablelist>
124 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
125 <?dbfo list-presentation="list"?>
126 <?dbhtml list-presentation="table"?>
127
128 <varlistentry id="chvt">
129 <term><command>chvt</command></term>
130 <listitem>
131 <para>Changes the foreground virtual terminal</para>
132 <indexterm zone="ch-system-kbd chvt">
133 <primary sortas="b-chvt">chvt</primary>
134 </indexterm>
135 </listitem>
136 </varlistentry>
137
138 <varlistentry id="deallocvt">
139 <term><command>deallocvt</command></term>
140 <listitem>
141 <para>Deallocates unused virtual terminals</para>
142 <indexterm zone="ch-system-kbd deallocvt">
143 <primary sortas="b-deallocvt">deallocvt</primary>
144 </indexterm>
145 </listitem>
146 </varlistentry>
147
148 <varlistentry id="dumpkeys">
149 <term><command>dumpkeys</command></term>
150 <listitem>
151 <para>Dumps the keyboard translation tables</para>
152 <indexterm zone="ch-system-kbd dumpkeys">
153 <primary sortas="b-dumpkeys">dumpkeys</primary>
154 </indexterm>
155 </listitem>
156 </varlistentry>
157
158 <varlistentry id="fgconsole">
159 <term><command>fgconsole</command></term>
160 <listitem>
161 <para>Prints the number of the active virtual terminal</para>
162 <indexterm zone="ch-system-kbd fgconsole">
163 <primary sortas="b-fgconsole">fgconsole</primary>
164 </indexterm>
165 </listitem>
166 </varlistentry>
167
168 <varlistentry id="getkeycodes">
169 <term><command>getkeycodes</command></term>
170 <listitem>
171 <para>Prints the kernel scancode-to-keycode mapping table</para>
172 <indexterm zone="ch-system-kbd getkeycodes">
173 <primary sortas="b-getkeycodes">getkeycodes</primary>
174 </indexterm>
175 </listitem>
176 </varlistentry>
177
178 <varlistentry id="kbdinfo">
179 <term><command>kbdinfo</command></term>
180 <listitem>
181 <para>Obtains information about the status of a console</para>
182 <indexterm zone="ch-system-kbd kbdinfo">
183 <primary sortas="b-kbdinfo">kbdinfo</primary>
184 </indexterm>
185 </listitem>
186 </varlistentry>
187
188 <varlistentry id="kbd_mode">
189 <term><command>kbd_mode</command></term>
190 <listitem>
191 <para>Reports or sets the keyboard mode</para>
192 <indexterm zone="ch-system-kbd kbd_mode">
193 <primary sortas="b-kbd_mode">kbd_mode</primary>
194 </indexterm>
195 </listitem>
196 </varlistentry>
197
198 <varlistentry id="kbdrate">
199 <term><command>kbdrate</command></term>
200 <listitem>
201 <para>Sets the keyboard repeat and delay rates</para>
202 <indexterm zone="ch-system-kbd kbdrate">
203 <primary sortas="b-kbdrate">kbdrate</primary>
204 </indexterm>
205 </listitem>
206 </varlistentry>
207
208 <varlistentry id="loadkeys">
209 <term><command>loadkeys</command></term>
210 <listitem>
211 <para>Loads the keyboard translation tables</para>
212 <indexterm zone="ch-system-kbd loadkeys">
213 <primary sortas="b-loadkeys">loadkeys</primary>
214 </indexterm>
215 </listitem>
216 </varlistentry>
217
218 <varlistentry id="loadunimap">
219 <term><command>loadunimap</command></term>
220 <listitem>
221 <para>Loads the kernel unicode-to-font mapping table</para>
222 <indexterm zone="ch-system-kbd loadunimap">
223 <primary sortas="b-loadunimap">loadunimap</primary>
224 </indexterm>
225 </listitem>
226 </varlistentry>
227
228 <varlistentry id="mapscrn">
229 <term><command>mapscrn</command></term>
230 <listitem>
231 <para>An obsolete program that used to load a user-defined output
232 character mapping table into the console driver; this is now done
233 by <command>setfont</command></para>
234 <indexterm zone="ch-system-kbd mapscrn">
235 <primary sortas="b-mapscrn">mapscrn</primary>
236 </indexterm>
237 </listitem>
238 </varlistentry>
239
240 <varlistentry id="openvt">
241 <term><command>openvt</command></term>
242 <listitem>
243 <para>Starts a program on a new virtual terminal (VT)</para>
244 <indexterm zone="ch-system-kbd openvt">
245 <primary sortas="b-openvt">openvt</primary>
246 </indexterm>
247 </listitem>
248 </varlistentry>
249
250 <varlistentry id="psfaddtable">
251 <term><command>psfaddtable</command></term>
252 <listitem>
253 <para>Adds a Unicode character table to a console font</para>
254 <indexterm zone="ch-system-kbd psfaddtable">
255 <primary sortas="b-psfaddtable">psfaddtable</primary>
256 </indexterm>
257 </listitem>
258 </varlistentry>
259
260 <varlistentry id="psfgettable">
261 <term><command>psfgettable</command></term>
262 <listitem>
263 <para>Extracts the embedded Unicode character table from a console
264 font</para>
265 <indexterm zone="ch-system-kbd psfgettable">
266 <primary sortas="b-psfgettable">psfgettable</primary>
267 </indexterm>
268 </listitem>
269 </varlistentry>
270
271 <varlistentry id="psfstriptable">
272 <term><command>psfstriptable</command></term>
273 <listitem>
274 <para>Removes the embedded Unicode character table from a console
275 font</para>
276 <indexterm zone="ch-system-kbd psfstriptable">
277 <primary sortas="b-psfstriptable">psfstriptable</primary>
278 </indexterm>
279 </listitem>
280 </varlistentry>
281
282 <varlistentry id="psfxtable">
283 <term><command>psfxtable</command></term>
284 <listitem>
285 <para>Handles Unicode character tables for console fonts</para>
286 <indexterm zone="ch-system-kbd psfxtable">
287 <primary sortas="b-psfxtable">psfxtable</primary>
288 </indexterm>
289 </listitem>
290 </varlistentry>
291
292 <varlistentry id="setfont">
293 <term><command>setfont</command></term>
294 <listitem>
295 <para>Changes the Enhanced Graphic Adapter (EGA) and Video Graphics
296 Array (VGA) fonts on the console</para>
297 <indexterm zone="ch-system-kbd setfont">
298 <primary sortas="b-setfont">setfont</primary>
299 </indexterm>
300 </listitem>
301 </varlistentry>
302
303 <varlistentry id="setkeycodes">
304 <term><command>setkeycodes</command></term>
305 <listitem>
306 <para>Loads kernel scancode-to-keycode mapping table entries; this is
307 useful if there are unusual keys on the keyboard</para>
308 <indexterm zone="ch-system-kbd setkeycodes">
309 <primary sortas="b-setkeycodes">setkeycodes</primary>
310 </indexterm>
311 </listitem>
312 </varlistentry>
313
314 <varlistentry id="setleds">
315 <term><command>setleds</command></term>
316 <listitem>
317 <para>Sets the keyboard flags and Light Emitting Diodes (LEDs)</para>
318 <indexterm zone="ch-system-kbd setleds">
319 <primary sortas="b-setleds">setleds</primary>
320 </indexterm>
321 </listitem>
322 </varlistentry>
323
324 <varlistentry id="setmetamode">
325 <term><command>setmetamode</command></term>
326 <listitem>
327 <para>Defines the keyboard meta-key handling</para>
328 <indexterm zone="ch-system-kbd setmetamode">
329 <primary sortas="b-setmetamode">setmetamode</primary>
330 </indexterm>
331 </listitem>
332 </varlistentry>
333
334 <varlistentry id="setvtrgb">
335 <term><command>setvtrgb</command></term>
336 <listitem>
337 <para>Sets the console color map in all virtual terminals</para>
338 <indexterm zone="ch-system-kbd setvtrgb">
339 <primary sortas="b-setvtrgb">setvtrgb</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="showconsolefont">
345 <term><command>showconsolefont</command></term>
346 <listitem>
347 <para>Shows the current EGA/VGA console screen font</para>
348 <indexterm zone="ch-system-kbd showconsolefont">
349 <primary sortas="b-showconsolefont">showconsolefont</primary>
350 </indexterm>
351 </listitem>
352 </varlistentry>
353
354 <varlistentry id="showkey">
355 <term><command>showkey</command></term>
356 <listitem>
357 <para>Reports the scancodes, keycodes, and ASCII codes of the keys
358 pressed on the keyboard</para>
359 <indexterm zone="ch-system-kbd showkey">
360 <primary sortas="b-showkey">showkey</primary>
361 </indexterm>
362 </listitem>
363 </varlistentry>
364
365 <varlistentry id="unicode_start">
366 <term><command>unicode_start</command></term>
367 <listitem>
368 <para>Puts the keyboard and console in UNICODE mode [Don't use this
369 program unless your keymap file is in the ISO-8859-1 encoding. For
370 other encodings, this utility produces incorrect results.]</para>
371 <indexterm zone="ch-system-kbd unicode_start">
372 <primary sortas="b-unicode_start">unicode_start</primary>
373 </indexterm>
374 </listitem>
375 </varlistentry>
376
377 <varlistentry id="unicode_stop">
378 <term><command>unicode_stop</command></term>
379 <listitem>
380 <para>Reverts keyboard and console from UNICODE mode</para>
381 <indexterm zone="ch-system-kbd unicode_stop">
382 <primary sortas="b-unicode_stop">unicode_stop</primary>
383 </indexterm>
384 </listitem>
385 </varlistentry>
386
387 </variablelist>
388
389 </sect2>
390
391</sect1>
Note: See TracBrowser for help on using the repository browser.