source: chapter08/kbd.xml@ 3d13efb

xry111/arm64 xry111/arm64-12.0
Last change on this file since 3d13efb was 3d13efb, checked in by Xi Ruoyao <xry111@…>, 20 months ago

arm64: add a note explaining "i386" in keymap patch

TL;DR: don't skip the patch.

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