kbd.xml 13 KB

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