kbd.xml 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400
  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. <screen><userinput remap="pre">sed -i 's/\(RESIZECONS_PROGS=\)yes/\1no/' configure &amp;&amp;
  52. sed -i 's/resizecons.8 //' man/man8/Makefile.in</userinput></screen>
  53. <para>Prepare Kbd for compilation:</para>
  54. <screen><userinput remap="configure">./configure --prefix=/usr --datadir=/lib/kbd</userinput></screen>
  55. <variablelist>
  56. <title>The meaning of the configure options:</title>
  57. <varlistentry>
  58. <term><parameter>--datadir=/lib/kbd</parameter></term>
  59. <listitem>
  60. <para>This option puts keyboard layout data in a directory that will
  61. always be on the root partition instead of the default <filename
  62. class="directory">/usr/share/kbd</filename>.</para>
  63. </listitem>
  64. </varlistentry>
  65. </variablelist>
  66. <para>Compile the package:</para>
  67. <screen><userinput remap="make">make</userinput></screen>
  68. <para>This package does not come with a test suite.</para>
  69. <para>Install the package:</para>
  70. <screen><userinput remap="install">make install</userinput></screen>
  71. <note>
  72. <para>For some languages (e.g., Belarusian) the Kbd package doesn't
  73. provide a useful keymap where the stock <quote>by</quote> keymap assumes
  74. the ISO-8859-5 encoding, and the CP1251 keymap is normally used. Users of
  75. such languages have to download working keymaps separately.</para>
  76. </note>
  77. <para>Some of the scripts in the LFS-Bootscripts package depend on
  78. <command>kbd_mode</command>, <command>loadkeys</command>,
  79. <command>openvt</command>, and
  80. <command>setfont</command>. As <filename class="directory">/usr</filename>
  81. may not be available during the early stages of booting, those binaries
  82. need to be on the root partition:</para>
  83. <screen><userinput remap="install">mv -v /usr/bin/{kbd_mode,loadkeys,openvt,setfont} /bin</userinput></screen>
  84. <para>If desired, install the documentation:</para>
  85. <screen><userinput remap="install">mkdir -v /usr/share/doc/kbd-&kbd-version;
  86. cp -R -v doc/* \
  87. /usr/share/doc/kbd-&kbd-version;</userinput></screen>
  88. </sect2>
  89. <sect2 id="contents-kbd" role="content">
  90. <title>Contents of Kbd</title>
  91. <segmentedlist>
  92. <segtitle>Installed programs</segtitle>
  93. <segtitle>Installed directory</segtitle>
  94. <seglistitem>
  95. <seg>chvt, deallocvt, dumpkeys, fgconsole, getkeycodes, kbd_mode,
  96. kbdrate, loadkeys, loadunimap,
  97. mapscrn, openvt, psfaddtable (link to psfxtable), psfgettable (link to
  98. psfxtable), psfstriptable (link to psfxtable), psfxtable, <!--resizecons,-->
  99. setfont, setkeycodes, setleds, setmetamode,
  100. showconsolefont, showkey, unicode_start, and unicode_stop</seg>
  101. <seg>/lib/kbd</seg>
  102. </seglistitem>
  103. </segmentedlist>
  104. <variablelist>
  105. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  106. <?dbfo list-presentation="list"?>
  107. <?dbhtml list-presentation="table"?>
  108. <varlistentry id="chvt">
  109. <term><command>chvt</command></term>
  110. <listitem>
  111. <para>Changes the foreground virtual terminal</para>
  112. <indexterm zone="ch-system-kbd chvt">
  113. <primary sortas="b-chvt">chvt</primary>
  114. </indexterm>
  115. </listitem>
  116. </varlistentry>
  117. <varlistentry id="deallocvt">
  118. <term><command>deallocvt</command></term>
  119. <listitem>
  120. <para>Deallocates unused virtual terminals</para>
  121. <indexterm zone="ch-system-kbd deallocvt">
  122. <primary sortas="b-deallocvt">deallocvt</primary>
  123. </indexterm>
  124. </listitem>
  125. </varlistentry>
  126. <varlistentry id="dumpkeys">
  127. <term><command>dumpkeys</command></term>
  128. <listitem>
  129. <para>Dumps the keyboard translation tables</para>
  130. <indexterm zone="ch-system-kbd dumpkeys">
  131. <primary sortas="b-dumpkeys">dumpkeys</primary>
  132. </indexterm>
  133. </listitem>
  134. </varlistentry>
  135. <varlistentry id="fgconsole">
  136. <term><command>fgconsole</command></term>
  137. <listitem>
  138. <para>Prints the number of the active virtual terminal</para>
  139. <indexterm zone="ch-system-kbd fgconsole">
  140. <primary sortas="b-fgconsole">fgconsole</primary>
  141. </indexterm>
  142. </listitem>
  143. </varlistentry>
  144. <varlistentry id="getkeycodes">
  145. <term><command>getkeycodes</command></term>
  146. <listitem>
  147. <para>Prints the kernel scancode-to-keycode mapping table</para>
  148. <indexterm zone="ch-system-kbd getkeycodes">
  149. <primary sortas="b-getkeycodes">getkeycodes</primary>
  150. </indexterm>
  151. </listitem>
  152. </varlistentry>
  153. <varlistentry id="kbd_mode">
  154. <term><command>kbd_mode</command></term>
  155. <listitem>
  156. <para>Reports or sets the keyboard mode</para>
  157. <indexterm zone="ch-system-kbd kbd_mode">
  158. <primary sortas="b-kbd_mode">kbd_mode</primary>
  159. </indexterm>
  160. </listitem>
  161. </varlistentry>
  162. <varlistentry id="kbdrate">
  163. <term><command>kbdrate</command></term>
  164. <listitem>
  165. <para>Sets the keyboard repeat and delay rates</para>
  166. <indexterm zone="ch-system-kbd kbdrate">
  167. <primary sortas="b-kbdrate">kbdrate</primary>
  168. </indexterm>
  169. </listitem>
  170. </varlistentry>
  171. <varlistentry id="loadkeys">
  172. <term><command>loadkeys</command></term>
  173. <listitem>
  174. <para>Loads the keyboard translation tables</para>
  175. <indexterm zone="ch-system-kbd loadkeys">
  176. <primary sortas="b-loadkeys">loadkeys</primary>
  177. </indexterm>
  178. </listitem>
  179. </varlistentry>
  180. <varlistentry id="loadunimap">
  181. <term><command>loadunimap</command></term>
  182. <listitem>
  183. <para>Loads the kernel unicode-to-font mapping table</para>
  184. <indexterm zone="ch-system-kbd loadunimap">
  185. <primary sortas="b-loadunimap">loadunimap</primary>
  186. </indexterm>
  187. </listitem>
  188. </varlistentry>
  189. <varlistentry id="mapscrn">
  190. <term><command>mapscrn</command></term>
  191. <listitem>
  192. <para>An obsolete program that used to load a user-defined output
  193. character mapping table into the console driver; this is now done
  194. by <command>setfont</command></para>
  195. <indexterm zone="ch-system-kbd mapscrn">
  196. <primary sortas="b-mapscrn">mapscrn</primary>
  197. </indexterm>
  198. </listitem>
  199. </varlistentry>
  200. <varlistentry id="openvt">
  201. <term><command>openvt</command></term>
  202. <listitem>
  203. <para>Starts a program on a new virtual terminal (VT)</para>
  204. <indexterm zone="ch-system-kbd openvt">
  205. <primary sortas="b-openvt">openvt</primary>
  206. </indexterm>
  207. </listitem>
  208. </varlistentry>
  209. <varlistentry id="psfaddtable">
  210. <term><command>psfaddtable</command></term>
  211. <listitem>
  212. <para>A link to <command>psfxtable</command></para>
  213. <indexterm zone="ch-system-kbd psfaddtable">
  214. <primary sortas="b-psfaddtable">psfaddtable</primary>
  215. </indexterm>
  216. </listitem>
  217. </varlistentry>
  218. <varlistentry id="psfgettable">
  219. <term><command>psfgettable</command></term>
  220. <listitem>
  221. <para>A link to <command>psfxtable</command></para>
  222. <indexterm zone="ch-system-kbd psfgettable">
  223. <primary sortas="b-psfgettable">psfgettable</primary>
  224. </indexterm>
  225. </listitem>
  226. </varlistentry>
  227. <varlistentry id="psfstriptable">
  228. <term><command>psfstriptable</command></term>
  229. <listitem>
  230. <para>A link to <command>psfxtable</command></para>
  231. <indexterm zone="ch-system-kbd psfstriptable">
  232. <primary sortas="b-psfstriptable">psfstriptable</primary>
  233. </indexterm>
  234. </listitem>
  235. </varlistentry>
  236. <varlistentry id="psfxtable">
  237. <term><command>psfxtable</command></term>
  238. <listitem>
  239. <para>Handle Unicode character tables for console fonts</para>
  240. <indexterm zone="ch-system-kbd psfxtable">
  241. <primary sortas="b-psfxtable">psfxtable</primary>
  242. </indexterm>
  243. </listitem>
  244. </varlistentry>
  245. <!--<varlistentry id="resizecons">
  246. <term><command>resizecons</command></term>
  247. <listitem>
  248. <para>Changes the kernel idea of the console size</para>
  249. <indexterm zone="ch-system-kbd resizecons">
  250. <primary sortas="b-resizecons">resizecons</primary>
  251. </indexterm>
  252. </listitem>
  253. </varlistentry>-->
  254. <varlistentry id="setfont">
  255. <term><command>setfont</command></term>
  256. <listitem>
  257. <para>Changes the Enhanced Graphic Adapter (EGA) and Video Graphics
  258. Array (VGA) fonts on the console</para>
  259. <indexterm zone="ch-system-kbd setfont">
  260. <primary sortas="b-setfont">setfont</primary>
  261. </indexterm>
  262. </listitem>
  263. </varlistentry>
  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. <varlistentry id="setleds">
  275. <term><command>setleds</command></term>
  276. <listitem>
  277. <para>Sets the keyboard flags and Light Emitting Diodes (LEDs)</para>
  278. <indexterm zone="ch-system-kbd setleds">
  279. <primary sortas="b-setleds">setleds</primary>
  280. </indexterm>
  281. </listitem>
  282. </varlistentry>
  283. <varlistentry id="setmetamode">
  284. <term><command>setmetamode</command></term>
  285. <listitem>
  286. <para>Defines the keyboard meta-key handling</para>
  287. <indexterm zone="ch-system-kbd setmetamode">
  288. <primary sortas="b-setmetamode">setmetamode</primary>
  289. </indexterm>
  290. </listitem>
  291. </varlistentry>
  292. <varlistentry id="showconsolefont">
  293. <term><command>showconsolefont</command></term>
  294. <listitem>
  295. <para>Shows the current EGA/VGA console screen font</para>
  296. <indexterm zone="ch-system-kbd showconsolefont">
  297. <primary sortas="b-showconsolefont">showconsolefont</primary>
  298. </indexterm>
  299. </listitem>
  300. </varlistentry>
  301. <varlistentry id="showkey">
  302. <term><command>showkey</command></term>
  303. <listitem>
  304. <para>Reports the scancodes, keycodes, and ASCII codes of the keys
  305. pressed on the keyboard</para>
  306. <indexterm zone="ch-system-kbd showkey">
  307. <primary sortas="b-showkey">showkey</primary>
  308. </indexterm>
  309. </listitem>
  310. </varlistentry>
  311. <varlistentry id="unicode_start">
  312. <term><command>unicode_start</command></term>
  313. <listitem>
  314. <para>Puts the keyboard and console in UNICODE mode. Don't use this
  315. program unless your keymap file is in the ISO-8859-1 encoding. For
  316. other encodings, this utility produces incorrect results.</para>
  317. <indexterm zone="ch-system-kbd unicode_start">
  318. <primary sortas="b-unicode_start">unicode_start</primary>
  319. </indexterm>
  320. </listitem>
  321. </varlistentry>
  322. <varlistentry id="unicode_stop">
  323. <term><command>unicode_stop</command></term>
  324. <listitem>
  325. <para>Reverts keyboard and console from UNICODE mode</para>
  326. <indexterm zone="ch-system-kbd unicode_stop">
  327. <primary sortas="b-unicode_stop">unicode_stop</primary>
  328. </indexterm>
  329. </listitem>
  330. </varlistentry>
  331. </variablelist>
  332. </sect2>
  333. </sect1>