1
0

kbd.xml 13 KB

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