123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407 |
- <?xml version="1.0" encoding="ISO-8859-1"?>
- <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
- <!ENTITY % general-entities SYSTEM "../general.ent">
- %general-entities;
- ]>
- <!-- FIXME: upstream git has been persuaded by SuSe to build resizecons on x86_64,
- so the sed will need attention if that change is not removed before the next release -->
- <sect1 id="ch-system-kbd" role="wrap">
- <?dbhtml filename="kbd.html"?>
- <sect1info condition="script">
- <productname>kbd</productname>
- <productnumber>&kbd-version;</productnumber>
- <address>&kbd-url;</address>
- </sect1info>
- <title>Kbd-&kbd-version;</title>
- <indexterm zone="ch-system-kbd">
- <primary sortas="a-Kbd">Kbd</primary>
- </indexterm>
- <sect2 role="package">
- <title/>
- <para>The Kbd package contains key-table files, console fonts, and keyboard
- utilities.</para>
- <segmentedlist>
- <segtitle>&buildtime;</segtitle>
- <segtitle>&diskspace;</segtitle>
- <seglistitem>
- <seg>&kbd-ch6-sbu;</seg>
- <seg>&kbd-ch6-du;</seg>
- </seglistitem>
- </segmentedlist>
- </sect2>
- <sect2 role="installation">
- <title>Installation of Kbd</title>
- <para>The behaviour of <command>loadkeys</command> when run without a
- filename was broken in this release. The following patch fixes this:</para>
- <screen><userinput remap="pre">patch -Np1 -i ../&kbd-fixes-patch;</userinput></screen>
- <para>The behaviour of the Backspace and Delete keys is not consistent
- across the keymaps in the Kbd package. The following patch fixes this
- issue for i386 keymaps:</para>
- <screen><userinput remap="pre">patch -Np1 -i ../&kbd-backspace-patch;</userinput></screen>
- <para>After patching, the Backspace key generates the character with code 127,
- and the Delete key generates a well-known escape sequence.</para>
- <para>Fix a bug in the Spanish message translations which prevents kbd from
- building with gettext-&gettext-version;:</para>
- <screen><userinput remap="pre">sed -i '/guardado\ el/s/\(^.*en\ %\)\(.*\)/\14\$\2/' po/es.po</userinput></screen>
- <para>Remove the redundant <command>resizecons</command> program (32-bit x86
- only, needs the defunct svgalib, which predates linux-2.6 and is incompatible
- with modern KMS, to provide the video mode files - for normal use
- <command>setfont</command> sizes the console appropriately) and its manpage.</para>
- <para>The shipped version of <filename>configure.ac</filename> is newer than
- <filename>aclocal.m4</filename>, so autotools will be run by <command>make</command>
- which will overwrite the change to <filename>configure</filename>. Alter the date
- and time of <filename>configure.ac</filename> - this uses the system timezone, so we
- pick a time that is sufficiently old in all timezones.</para>
- <screen><userinput remap="pre">sed -i 's/\(RESIZECONS_PROGS=\)yes/\1no/' configure &&
- sed -i 's/resizecons.8 //' man/man8/Makefile.in &&
- touch -d '2011-05-07 08:30' configure.ac</userinput></screen>
- <para>Prepare Kbd for compilation:</para>
- <screen><userinput remap="configure">./configure --prefix=/usr --datadir=/lib/kbd</userinput></screen>
- <variablelist>
- <title>The meaning of the configure options:</title>
- <varlistentry>
- <term><parameter>--datadir=/lib/kbd</parameter></term>
- <listitem>
- <para>This option puts keyboard layout data in a directory that will
- always be on the root partition instead of the default <filename
- class="directory">/usr/share/kbd</filename>.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <para>Compile the package:</para>
- <screen><userinput remap="make">make</userinput></screen>
- <para>This package does not come with a test suite.</para>
- <para>Install the package:</para>
- <screen><userinput remap="install">make install</userinput></screen>
- <note>
- <para>For some languages (e.g., Belarusian) the Kbd package doesn't
- provide a useful keymap where the stock <quote>by</quote> keymap assumes
- the ISO-8859-5 encoding, and the CP1251 keymap is normally used. Users of
- such languages have to download working keymaps separately.</para>
- </note>
- <para>Some of the scripts in the LFS-Bootscripts package depend on
- <command>kbd_mode</command>, <command>loadkeys</command>,
- <command>openvt</command>, and
- <command>setfont</command>. As <filename class="directory">/usr</filename>
- may not be available during the early stages of booting, those binaries
- need to be on the root partition:</para>
- <screen><userinput remap="install">mv -v /usr/bin/{kbd_mode,loadkeys,openvt,setfont} /bin</userinput></screen>
- <para>If desired, install the documentation:</para>
- <screen><userinput remap="install">mkdir -v /usr/share/doc/kbd-&kbd-version;
- cp -R -v doc/* \
- /usr/share/doc/kbd-&kbd-version;</userinput></screen>
- </sect2>
- <sect2 id="contents-kbd" role="content">
- <title>Contents of Kbd</title>
- <segmentedlist>
- <segtitle>Installed programs</segtitle>
- <segtitle>Installed directory</segtitle>
- <seglistitem>
- <seg>chvt, deallocvt, dumpkeys, fgconsole, getkeycodes, kbd_mode,
- kbdrate, loadkeys, loadunimap,
- mapscrn, openvt, psfaddtable (link to psfxtable), psfgettable (link to
- psfxtable), psfstriptable (link to psfxtable), psfxtable, <!--resizecons,-->
- setfont, setkeycodes, setleds, setmetamode,
- showconsolefont, showkey, unicode_start, and unicode_stop</seg>
- <seg>/lib/kbd</seg>
- </seglistitem>
- </segmentedlist>
- <variablelist>
- <bridgehead renderas="sect3">Short Descriptions</bridgehead>
- <?dbfo list-presentation="list"?>
- <?dbhtml list-presentation="table"?>
- <varlistentry id="chvt">
- <term><command>chvt</command></term>
- <listitem>
- <para>Changes the foreground virtual terminal</para>
- <indexterm zone="ch-system-kbd chvt">
- <primary sortas="b-chvt">chvt</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="deallocvt">
- <term><command>deallocvt</command></term>
- <listitem>
- <para>Deallocates unused virtual terminals</para>
- <indexterm zone="ch-system-kbd deallocvt">
- <primary sortas="b-deallocvt">deallocvt</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="dumpkeys">
- <term><command>dumpkeys</command></term>
- <listitem>
- <para>Dumps the keyboard translation tables</para>
- <indexterm zone="ch-system-kbd dumpkeys">
- <primary sortas="b-dumpkeys">dumpkeys</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="fgconsole">
- <term><command>fgconsole</command></term>
- <listitem>
- <para>Prints the number of the active virtual terminal</para>
- <indexterm zone="ch-system-kbd fgconsole">
- <primary sortas="b-fgconsole">fgconsole</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="getkeycodes">
- <term><command>getkeycodes</command></term>
- <listitem>
- <para>Prints the kernel scancode-to-keycode mapping table</para>
- <indexterm zone="ch-system-kbd getkeycodes">
- <primary sortas="b-getkeycodes">getkeycodes</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="kbd_mode">
- <term><command>kbd_mode</command></term>
- <listitem>
- <para>Reports or sets the keyboard mode</para>
- <indexterm zone="ch-system-kbd kbd_mode">
- <primary sortas="b-kbd_mode">kbd_mode</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="kbdrate">
- <term><command>kbdrate</command></term>
- <listitem>
- <para>Sets the keyboard repeat and delay rates</para>
- <indexterm zone="ch-system-kbd kbdrate">
- <primary sortas="b-kbdrate">kbdrate</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="loadkeys">
- <term><command>loadkeys</command></term>
- <listitem>
- <para>Loads the keyboard translation tables</para>
- <indexterm zone="ch-system-kbd loadkeys">
- <primary sortas="b-loadkeys">loadkeys</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="loadunimap">
- <term><command>loadunimap</command></term>
- <listitem>
- <para>Loads the kernel unicode-to-font mapping table</para>
- <indexterm zone="ch-system-kbd loadunimap">
- <primary sortas="b-loadunimap">loadunimap</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="mapscrn">
- <term><command>mapscrn</command></term>
- <listitem>
- <para>An obsolete program that used to load a user-defined output
- character mapping table into the console driver; this is now done
- by <command>setfont</command></para>
- <indexterm zone="ch-system-kbd mapscrn">
- <primary sortas="b-mapscrn">mapscrn</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="openvt">
- <term><command>openvt</command></term>
- <listitem>
- <para>Starts a program on a new virtual terminal (VT)</para>
- <indexterm zone="ch-system-kbd openvt">
- <primary sortas="b-openvt">openvt</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="psfaddtable">
- <term><command>psfaddtable</command></term>
- <listitem>
- <para>A link to <command>psfxtable</command></para>
- <indexterm zone="ch-system-kbd psfaddtable">
- <primary sortas="b-psfaddtable">psfaddtable</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="psfgettable">
- <term><command>psfgettable</command></term>
- <listitem>
- <para>A link to <command>psfxtable</command></para>
- <indexterm zone="ch-system-kbd psfgettable">
- <primary sortas="b-psfgettable">psfgettable</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="psfstriptable">
- <term><command>psfstriptable</command></term>
- <listitem>
- <para>A link to <command>psfxtable</command></para>
- <indexterm zone="ch-system-kbd psfstriptable">
- <primary sortas="b-psfstriptable">psfstriptable</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="psfxtable">
- <term><command>psfxtable</command></term>
- <listitem>
- <para>Handle Unicode character tables for console fonts</para>
- <indexterm zone="ch-system-kbd psfxtable">
- <primary sortas="b-psfxtable">psfxtable</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <!--<varlistentry id="resizecons">
- <term><command>resizecons</command></term>
- <listitem>
- <para>Changes the kernel idea of the console size</para>
- <indexterm zone="ch-system-kbd resizecons">
- <primary sortas="b-resizecons">resizecons</primary>
- </indexterm>
- </listitem>
- </varlistentry>-->
- <varlistentry id="setfont">
- <term><command>setfont</command></term>
- <listitem>
- <para>Changes the Enhanced Graphic Adapter (EGA) and Video Graphics
- Array (VGA) fonts on the console</para>
- <indexterm zone="ch-system-kbd setfont">
- <primary sortas="b-setfont">setfont</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="setkeycodes">
- <term><command>setkeycodes</command></term>
- <listitem>
- <para>Loads kernel scancode-to-keycode mapping table entries; this is
- useful if there are unusual keys on the keyboard</para>
- <indexterm zone="ch-system-kbd setkeycodes">
- <primary sortas="b-setkeycodes">setkeycodes</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="setleds">
- <term><command>setleds</command></term>
- <listitem>
- <para>Sets the keyboard flags and Light Emitting Diodes (LEDs)</para>
- <indexterm zone="ch-system-kbd setleds">
- <primary sortas="b-setleds">setleds</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="setmetamode">
- <term><command>setmetamode</command></term>
- <listitem>
- <para>Defines the keyboard meta-key handling</para>
- <indexterm zone="ch-system-kbd setmetamode">
- <primary sortas="b-setmetamode">setmetamode</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="showconsolefont">
- <term><command>showconsolefont</command></term>
- <listitem>
- <para>Shows the current EGA/VGA console screen font</para>
- <indexterm zone="ch-system-kbd showconsolefont">
- <primary sortas="b-showconsolefont">showconsolefont</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="showkey">
- <term><command>showkey</command></term>
- <listitem>
- <para>Reports the scancodes, keycodes, and ASCII codes of the keys
- pressed on the keyboard</para>
- <indexterm zone="ch-system-kbd showkey">
- <primary sortas="b-showkey">showkey</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="unicode_start">
- <term><command>unicode_start</command></term>
- <listitem>
- <para>Puts the keyboard and console in UNICODE mode. Don't use this
- program unless your keymap file is in the ISO-8859-1 encoding. For
- other encodings, this utility produces incorrect results.</para>
- <indexterm zone="ch-system-kbd unicode_start">
- <primary sortas="b-unicode_start">unicode_start</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- <varlistentry id="unicode_stop">
- <term><command>unicode_stop</command></term>
- <listitem>
- <para>Reverts keyboard and console from UNICODE mode</para>
- <indexterm zone="ch-system-kbd unicode_stop">
- <primary sortas="b-unicode_stop">unicode_stop</primary>
- </indexterm>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
- </sect1>
|