kbd.xml 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407
  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. <!-- FIXME: upstream git has been persuaded by SuSe to build resizecons on x86_64,
  8. so the sed will need attention if that change is not removed before the next release -->
  9. <sect1 id="ch-system-kbd" role="wrap">
  10. <?dbhtml filename="kbd.html"?>
  11. <sect1info condition="script">
  12. <productname>kbd</productname>
  13. <productnumber>&kbd-version;</productnumber>
  14. <address>&kbd-url;</address>
  15. </sect1info>
  16. <title>Kbd-&kbd-version;</title>
  17. <indexterm zone="ch-system-kbd">
  18. <primary sortas="a-Kbd">Kbd</primary>
  19. </indexterm>
  20. <sect2 role="package">
  21. <title/>
  22. <para>The Kbd package contains key-table files, console fonts, and keyboard
  23. utilities.</para>
  24. <segmentedlist>
  25. <segtitle>&buildtime;</segtitle>
  26. <segtitle>&diskspace;</segtitle>
  27. <seglistitem>
  28. <seg>&kbd-ch6-sbu;</seg>
  29. <seg>&kbd-ch6-du;</seg>
  30. </seglistitem>
  31. </segmentedlist>
  32. </sect2>
  33. <sect2 role="installation">
  34. <title>Installation of Kbd</title>
  35. <para>The behaviour of <command>loadkeys</command> when run without a
  36. filename was broken in this release. The following patch fixes this:</para>
  37. <screen><userinput remap="pre">patch -Np1 -i ../&kbd-fixes-patch;</userinput></screen>
  38. <para>The behaviour of the Backspace and Delete keys is not consistent
  39. across the keymaps in the Kbd package. The following patch fixes this
  40. issue for i386 keymaps:</para>
  41. <screen><userinput remap="pre">patch -Np1 -i ../&kbd-backspace-patch;</userinput></screen>
  42. <para>After patching, the Backspace key generates the character with code 127,
  43. and the Delete key generates a well-known escape sequence.</para>
  44. <para>Fix a bug in the Spanish message translations which prevents kbd from
  45. building with gettext-&gettext-version;:</para>
  46. <screen><userinput remap="pre">sed -i '/guardado\ el/s/\(^.*en\ %\)\(.*\)/\14\$\2/' po/es.po</userinput></screen>
  47. <para>Remove the redundant <command>resizecons</command> program (32-bit x86
  48. only, needs the defunct svgalib, which predates linux-2.6 and is incompatible
  49. with modern KMS, to provide the video mode files - for normal use
  50. <command>setfont</command> sizes the console appropriately) and its manpage.</para>
  51. <para>The shipped version of <filename>configure.ac</filename> is newer than
  52. <filename>aclocal.m4</filename>, so autotools will be run by <command>make</command>
  53. which will overwrite the change to <filename>configure</filename>. Alter the date
  54. and time of <filename>configure.ac</filename> - this uses the system timezone, so we
  55. pick a time that is sufficiently old in all timezones.</para>
  56. <screen><userinput remap="pre">sed -i 's/\(RESIZECONS_PROGS=\)yes/\1no/' configure &amp;&amp;
  57. sed -i 's/resizecons.8 //' man/man8/Makefile.in &amp;&amp;
  58. touch -d '2011-05-07 08:30' configure.ac</userinput></screen>
  59. <para>Prepare Kbd for compilation:</para>
  60. <screen><userinput remap="configure">./configure --prefix=/usr --datadir=/lib/kbd</userinput></screen>
  61. <variablelist>
  62. <title>The meaning of the configure options:</title>
  63. <varlistentry>
  64. <term><parameter>--datadir=/lib/kbd</parameter></term>
  65. <listitem>
  66. <para>This option puts keyboard layout data in a directory that will
  67. always be on the root partition instead of the default <filename
  68. class="directory">/usr/share/kbd</filename>.</para>
  69. </listitem>
  70. </varlistentry>
  71. </variablelist>
  72. <para>Compile the package:</para>
  73. <screen><userinput remap="make">make</userinput></screen>
  74. <para>This package does not come with a test suite.</para>
  75. <para>Install the package:</para>
  76. <screen><userinput remap="install">make install</userinput></screen>
  77. <note>
  78. <para>For some languages (e.g., Belarusian) the Kbd package doesn't
  79. provide a useful keymap where the stock <quote>by</quote> keymap assumes
  80. the ISO-8859-5 encoding, and the CP1251 keymap is normally used. Users of
  81. such languages have to download working keymaps separately.</para>
  82. </note>
  83. <para>Some of the scripts in the LFS-Bootscripts package depend on
  84. <command>kbd_mode</command>, <command>loadkeys</command>,
  85. <command>openvt</command>, and
  86. <command>setfont</command>. As <filename class="directory">/usr</filename>
  87. may not be available during the early stages of booting, those binaries
  88. need to be on the root partition:</para>
  89. <screen><userinput remap="install">mv -v /usr/bin/{kbd_mode,loadkeys,openvt,setfont} /bin</userinput></screen>
  90. <para>If desired, install the documentation:</para>
  91. <screen><userinput remap="install">mkdir -v /usr/share/doc/kbd-&kbd-version;
  92. cp -R -v doc/* \
  93. /usr/share/doc/kbd-&kbd-version;</userinput></screen>
  94. </sect2>
  95. <sect2 id="contents-kbd" role="content">
  96. <title>Contents of Kbd</title>
  97. <segmentedlist>
  98. <segtitle>Installed programs</segtitle>
  99. <segtitle>Installed directory</segtitle>
  100. <seglistitem>
  101. <seg>chvt, deallocvt, dumpkeys, fgconsole, getkeycodes, kbd_mode,
  102. kbdrate, loadkeys, loadunimap,
  103. mapscrn, openvt, psfaddtable (link to psfxtable), psfgettable (link to
  104. psfxtable), psfstriptable (link to psfxtable), psfxtable, <!--resizecons,-->
  105. setfont, setkeycodes, setleds, setmetamode,
  106. showconsolefont, showkey, unicode_start, and unicode_stop</seg>
  107. <seg>/lib/kbd</seg>
  108. </seglistitem>
  109. </segmentedlist>
  110. <variablelist>
  111. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  112. <?dbfo list-presentation="list"?>
  113. <?dbhtml list-presentation="table"?>
  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. <varlistentry id="deallocvt">
  124. <term><command>deallocvt</command></term>
  125. <listitem>
  126. <para>Deallocates unused virtual terminals</para>
  127. <indexterm zone="ch-system-kbd deallocvt">
  128. <primary sortas="b-deallocvt">deallocvt</primary>
  129. </indexterm>
  130. </listitem>
  131. </varlistentry>
  132. <varlistentry id="dumpkeys">
  133. <term><command>dumpkeys</command></term>
  134. <listitem>
  135. <para>Dumps the keyboard translation tables</para>
  136. <indexterm zone="ch-system-kbd dumpkeys">
  137. <primary sortas="b-dumpkeys">dumpkeys</primary>
  138. </indexterm>
  139. </listitem>
  140. </varlistentry>
  141. <varlistentry id="fgconsole">
  142. <term><command>fgconsole</command></term>
  143. <listitem>
  144. <para>Prints the number of the active virtual terminal</para>
  145. <indexterm zone="ch-system-kbd fgconsole">
  146. <primary sortas="b-fgconsole">fgconsole</primary>
  147. </indexterm>
  148. </listitem>
  149. </varlistentry>
  150. <varlistentry id="getkeycodes">
  151. <term><command>getkeycodes</command></term>
  152. <listitem>
  153. <para>Prints the kernel scancode-to-keycode mapping table</para>
  154. <indexterm zone="ch-system-kbd getkeycodes">
  155. <primary sortas="b-getkeycodes">getkeycodes</primary>
  156. </indexterm>
  157. </listitem>
  158. </varlistentry>
  159. <varlistentry id="kbd_mode">
  160. <term><command>kbd_mode</command></term>
  161. <listitem>
  162. <para>Reports or sets the keyboard mode</para>
  163. <indexterm zone="ch-system-kbd kbd_mode">
  164. <primary sortas="b-kbd_mode">kbd_mode</primary>
  165. </indexterm>
  166. </listitem>
  167. </varlistentry>
  168. <varlistentry id="kbdrate">
  169. <term><command>kbdrate</command></term>
  170. <listitem>
  171. <para>Sets the keyboard repeat and delay rates</para>
  172. <indexterm zone="ch-system-kbd kbdrate">
  173. <primary sortas="b-kbdrate">kbdrate</primary>
  174. </indexterm>
  175. </listitem>
  176. </varlistentry>
  177. <varlistentry id="loadkeys">
  178. <term><command>loadkeys</command></term>
  179. <listitem>
  180. <para>Loads the keyboard translation tables</para>
  181. <indexterm zone="ch-system-kbd loadkeys">
  182. <primary sortas="b-loadkeys">loadkeys</primary>
  183. </indexterm>
  184. </listitem>
  185. </varlistentry>
  186. <varlistentry id="loadunimap">
  187. <term><command>loadunimap</command></term>
  188. <listitem>
  189. <para>Loads the kernel unicode-to-font mapping table</para>
  190. <indexterm zone="ch-system-kbd loadunimap">
  191. <primary sortas="b-loadunimap">loadunimap</primary>
  192. </indexterm>
  193. </listitem>
  194. </varlistentry>
  195. <varlistentry id="mapscrn">
  196. <term><command>mapscrn</command></term>
  197. <listitem>
  198. <para>An obsolete program that used to load a user-defined output
  199. character mapping table into the console driver; this is now done
  200. by <command>setfont</command></para>
  201. <indexterm zone="ch-system-kbd mapscrn">
  202. <primary sortas="b-mapscrn">mapscrn</primary>
  203. </indexterm>
  204. </listitem>
  205. </varlistentry>
  206. <varlistentry id="openvt">
  207. <term><command>openvt</command></term>
  208. <listitem>
  209. <para>Starts a program on a new virtual terminal (VT)</para>
  210. <indexterm zone="ch-system-kbd openvt">
  211. <primary sortas="b-openvt">openvt</primary>
  212. </indexterm>
  213. </listitem>
  214. </varlistentry>
  215. <varlistentry id="psfaddtable">
  216. <term><command>psfaddtable</command></term>
  217. <listitem>
  218. <para>A link to <command>psfxtable</command></para>
  219. <indexterm zone="ch-system-kbd psfaddtable">
  220. <primary sortas="b-psfaddtable">psfaddtable</primary>
  221. </indexterm>
  222. </listitem>
  223. </varlistentry>
  224. <varlistentry id="psfgettable">
  225. <term><command>psfgettable</command></term>
  226. <listitem>
  227. <para>A link to <command>psfxtable</command></para>
  228. <indexterm zone="ch-system-kbd psfgettable">
  229. <primary sortas="b-psfgettable">psfgettable</primary>
  230. </indexterm>
  231. </listitem>
  232. </varlistentry>
  233. <varlistentry id="psfstriptable">
  234. <term><command>psfstriptable</command></term>
  235. <listitem>
  236. <para>A link to <command>psfxtable</command></para>
  237. <indexterm zone="ch-system-kbd psfstriptable">
  238. <primary sortas="b-psfstriptable">psfstriptable</primary>
  239. </indexterm>
  240. </listitem>
  241. </varlistentry>
  242. <varlistentry id="psfxtable">
  243. <term><command>psfxtable</command></term>
  244. <listitem>
  245. <para>Handle Unicode character tables for console fonts</para>
  246. <indexterm zone="ch-system-kbd psfxtable">
  247. <primary sortas="b-psfxtable">psfxtable</primary>
  248. </indexterm>
  249. </listitem>
  250. </varlistentry>
  251. <!--<varlistentry id="resizecons">
  252. <term><command>resizecons</command></term>
  253. <listitem>
  254. <para>Changes the kernel idea of the console size</para>
  255. <indexterm zone="ch-system-kbd resizecons">
  256. <primary sortas="b-resizecons">resizecons</primary>
  257. </indexterm>
  258. </listitem>
  259. </varlistentry>-->
  260. <varlistentry id="setfont">
  261. <term><command>setfont</command></term>
  262. <listitem>
  263. <para>Changes the Enhanced Graphic Adapter (EGA) and Video Graphics
  264. Array (VGA) fonts on the console</para>
  265. <indexterm zone="ch-system-kbd setfont">
  266. <primary sortas="b-setfont">setfont</primary>
  267. </indexterm>
  268. </listitem>
  269. </varlistentry>
  270. <varlistentry id="setkeycodes">
  271. <term><command>setkeycodes</command></term>
  272. <listitem>
  273. <para>Loads kernel scancode-to-keycode mapping table entries; this is
  274. useful if there are unusual keys on the keyboard</para>
  275. <indexterm zone="ch-system-kbd setkeycodes">
  276. <primary sortas="b-setkeycodes">setkeycodes</primary>
  277. </indexterm>
  278. </listitem>
  279. </varlistentry>
  280. <varlistentry id="setleds">
  281. <term><command>setleds</command></term>
  282. <listitem>
  283. <para>Sets the keyboard flags and Light Emitting Diodes (LEDs)</para>
  284. <indexterm zone="ch-system-kbd setleds">
  285. <primary sortas="b-setleds">setleds</primary>
  286. </indexterm>
  287. </listitem>
  288. </varlistentry>
  289. <varlistentry id="setmetamode">
  290. <term><command>setmetamode</command></term>
  291. <listitem>
  292. <para>Defines the keyboard meta-key handling</para>
  293. <indexterm zone="ch-system-kbd setmetamode">
  294. <primary sortas="b-setmetamode">setmetamode</primary>
  295. </indexterm>
  296. </listitem>
  297. </varlistentry>
  298. <varlistentry id="showconsolefont">
  299. <term><command>showconsolefont</command></term>
  300. <listitem>
  301. <para>Shows the current EGA/VGA console screen font</para>
  302. <indexterm zone="ch-system-kbd showconsolefont">
  303. <primary sortas="b-showconsolefont">showconsolefont</primary>
  304. </indexterm>
  305. </listitem>
  306. </varlistentry>
  307. <varlistentry id="showkey">
  308. <term><command>showkey</command></term>
  309. <listitem>
  310. <para>Reports the scancodes, keycodes, and ASCII codes of the keys
  311. pressed on the keyboard</para>
  312. <indexterm zone="ch-system-kbd showkey">
  313. <primary sortas="b-showkey">showkey</primary>
  314. </indexterm>
  315. </listitem>
  316. </varlistentry>
  317. <varlistentry id="unicode_start">
  318. <term><command>unicode_start</command></term>
  319. <listitem>
  320. <para>Puts the keyboard and console in UNICODE mode. Don't use this
  321. program unless your keymap file is in the ISO-8859-1 encoding. For
  322. other encodings, this utility produces incorrect results.</para>
  323. <indexterm zone="ch-system-kbd unicode_start">
  324. <primary sortas="b-unicode_start">unicode_start</primary>
  325. </indexterm>
  326. </listitem>
  327. </varlistentry>
  328. <varlistentry id="unicode_stop">
  329. <term><command>unicode_stop</command></term>
  330. <listitem>
  331. <para>Reverts keyboard and console from UNICODE mode</para>
  332. <indexterm zone="ch-system-kbd unicode_stop">
  333. <primary sortas="b-unicode_stop">unicode_stop</primary>
  334. </indexterm>
  335. </listitem>
  336. </varlistentry>
  337. </variablelist>
  338. </sect2>
  339. </sect1>