source: chapter06/kbd.xml@ df8334f

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../general.ent">
  %general-entities;
]>
<sect1 id="ch-system-kbd" xreflabel="Kbd" role="wrap">
<title>Kbd-&kbd-version;</title>
<?dbhtml filename="kbd.html"?>

<indexterm zone="ch-system-kbd"><primary sortas="a-Kbd">Kbd</primary></indexterm>

<sect2 role="package"><title/>
<para>The Kbd package contains key-table files and keyboard utilities.</para>

<segmentedlist>
<segtitle>&buildtime;</segtitle>
<segtitle>&diskspace;</segtitle>
<seglistitem><seg>0.1 SBU</seg><seg>12 MB</seg></seglistitem>
</segmentedlist>

<segmentedlist>
<segtitle>Kbd installation depends on</segtitle>
<seglistitem><seg>Bash, Binutils, Bison, Coreutils,
Diffutils, Flex, GCC, Gettext, Glibc, Grep, Gzip, M4, Make, Sed</seg></seglistitem>
</segmentedlist>
</sect2>

<sect2 role="installation">
<title>Installation of Kbd</title>

<para>Prepare Kbd for compilation:</para>

<screen><userinput>./configure</userinput></screen>

<para>Compile the package:</para>

<screen><userinput>make</userinput></screen>

<para>Now install it:</para>

<screen><userinput>make install</userinput></screen>

</sect2>

<!-- The "Configuring your keyboard" section has been moved to
Chapter 7 and renamed to "Configuring Linux console" -->

<sect2 id="contents-kbd" role="content"><title>Contents of Kbd</title>

<segmentedlist>
<segtitle>Installed programs</segtitle>
<seglistitem><seg>chvt, deallocvt, dumpkeys,
fgconsole, getkeycodes, getunimap, kbd_mode, kbdrate, loadkeys, loadunimap,
mapscrn, openvt, psfaddtable (link to psfxtable), psfgettable (link to
psfxtable), psfstriptable (link to psfxtable), psfxtable, resizecons,
setfont, setkeycodes, setleds, setlogcons, setmetamode, setvesablank,
showconsolefont, showkey, unicode_start and unicode_stop</seg></seglistitem>
</segmentedlist>

<variablelist><title>Short descriptions</title>

<varlistentry>
<term id="chvt"><command>chvt</command></term>
<listitem>
<indexterm zone="ch-system-kbd chvt"><primary sortas="b-chvt">chvt</primary></indexterm>
<para>changes the foreground virtual terminal.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="deallocvt"><command>deallocvt</command></term>
<listitem>
<indexterm zone="ch-system-kbd deallocvt"><primary sortas="b-deallocvt">deallocvt</primary></indexterm>
<para>deallocates unused virtual terminals.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="dumpkeys"><command>dumpkeys</command></term>
<listitem>
<indexterm zone="ch-system-kbd dumpkeys"><primary sortas="b-dumpkeys">dumpkeys</primary></indexterm>
<para>dumps the keyboard translation tables.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="fgconsole"><command>fgconsole</command></term>
<listitem>
<indexterm zone="ch-system-kbd fgconsole"><primary sortas="b-fgconsole">fgconsole</primary></indexterm>
<para>prints the number of the active virtual terminal.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="getkeycodes"><command>getkeycodes</command></term>
<listitem>
<indexterm zone="ch-system-kbd getkeycodes"><primary sortas="b-getkeycodes">getkeycodes</primary></indexterm>
<para>prints the kernel scancode-to-keycode mapping table.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="getunimap"><command>getunimap</command></term>
<listitem>
<indexterm zone="ch-system-kbd getunimap"><primary sortas="b-getunimap">getunimap</primary></indexterm>
<para>prints the currently used unimap.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="kbd_mode"><command>kbd_mode</command></term>
<listitem>
<indexterm zone="ch-system-kbd kbd_mode"><primary sortas="b-kbd_mode">kbd_mode</primary></indexterm>
<para>reports or sets the keyboard mode.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="kbdrate"><command>kbdrate</command></term>
<listitem>
<indexterm zone="ch-system-kbd kbdrate"><primary sortas="b-kbdrate">kbdrate</primary></indexterm>
<para>sets the keyboard repeat and delay rates.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="loadkeys"><command>loadkeys</command></term>
<listitem>
<indexterm zone="ch-system-kbd loadkeys"><primary sortas="b-loadkeys">loadkeys</primary></indexterm>
<para>loads the keyboard translation tables.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="loadunimap"><command>loadunimap</command></term>
<listitem>
<indexterm zone="ch-system-kbd loadunimap"><primary sortas="b-loadunimap">loadunimap</primary></indexterm>
<para>loads the kernel unicode-to-font mapping table.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="mapscrn"><command>mapscrn</command></term>
<listitem>
<indexterm zone="ch-system-kbd mapscrn"><primary sortas="b-mapscrn">mapscrn</primary></indexterm>
<para>is an obsolete program that used to load
a user-defined output character mapping table into the console driver. This is
now done by setfont.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="openvt"><command>openvt</command></term>
<listitem>
<indexterm zone="ch-system-kbd openvt"><primary sortas="b-openvt">openvt</primary></indexterm>
<para>starts a program on a new virtual terminal (VT).</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="psf"><command>psf*</command></term>
<listitem>
<indexterm zone="ch-system-kbd psf"><primary sortas="b-psf*">psf*</primary></indexterm>
<para>are a set of tools for handling Unicode character tables for console fonts.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="resizecons"><command>resizecons</command></term>
<listitem>
<indexterm zone="ch-system-kbd resizecons"><primary sortas="b-resizecons">resizecons</primary></indexterm>
<para>changes the kernel idea of the console size.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="setfont"><command>setfont</command></term>
<listitem>
<indexterm zone="ch-system-kbd setfont"><primary sortas="b-setfont">setfont</primary></indexterm>
<para>lets you change the EGA/VGA fonts on the console.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="setkeycodes"><command>setkeycodes</command></term>
<listitem>
<indexterm zone="ch-system-kbd setkeycodes"><primary sortas="b-setkeycodes">setkeycodes</primary></indexterm>
<para>loads kernel scancode-to-keycode
mapping table entries, useful if you have some unusual keys on your keyboard.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="setleds"><command>setleds</command></term>
<listitem>
<indexterm zone="ch-system-kbd setleds"><primary sortas="b-setleds">setleds</primary></indexterm>
<para>sets the keyboard flags and LEDs. Many
people find it useful to have "Num Lock" on by default, setleds +num achieves this.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="setlogcons"><command>setlogcons</command></term>
<listitem>
<indexterm zone="ch-system-kbd setlogcons"><primary sortas="b-setlogcons">setlogcons</primary></indexterm>
<para>sends kernel messages to the console.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="setmetamode"><command>setmetamode</command></term>
<listitem>
<indexterm zone="ch-system-kbd setmetamode"><primary sortas="b-setmetamode">setmetamode</primary></indexterm>
<para>defines the keyboard meta-key handling.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="setvesablank"><command>setvesablank</command></term>
<listitem>
<indexterm zone="ch-system-kbd setvesablank"><primary sortas="b-setvesablank">setvesablank</primary></indexterm>
<para>lets you fiddle with the built-in
hardware screensaver (no toasters, just a blank screen).</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="showconsolefont"><command>showconsolefont</command></term>
<listitem>
<indexterm zone="ch-system-kbd showconsolefont"><primary sortas="b-showconsolefont">showconsolefont</primary></indexterm>
<para>shows the current EGA/VGA console screen font.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="showkey"><command>showkey</command></term>
<listitem>
<indexterm zone="ch-system-kbd showkey"><primary sortas="b-showkey">showkey</primary></indexterm>
<para>reports the scancodes and keycodes and
ASCII codes of the keys pressed on the keyboard.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="unicode_start"><command>unicode_start</command></term>
<listitem>
<indexterm zone="ch-system-kbd unicode_start"><primary sortas="b-unicode_start">unicode_start</primary></indexterm>
<para>puts the keyboard and console in UNICODE mode. Never use it on LFS, 
because applications are not configured to support UNICODE.</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="unicode_stop"><command>unicode_stop</command></term>
<listitem>
<indexterm zone="ch-system-kbd unicode_stop"><primary sortas="b-unicode_stop">unicode_stop</primary></indexterm>
<para>reverts keyboard and console from UNICODE mode.</para>
</listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>