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

clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 2256e5a was c873165, checked in by William Harrington <kb0iic@…>, 11 years ago

Install documentation with versioned directory and add/update installed directories.

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