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

sysvinit
Last change on this file since 427e466 was b27081c4, checked in by Chris Staub <chris@…>, 9 years ago

Put one configure option per line

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