logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

dumpkeys.1 (5929B)


  1. .\" @(#)loadkeys.1 1.0 93/09/1 RK
  2. .TH DUMPKEYS 1 "1 Sep 1993" "kbd"
  3. .SH NAME
  4. dumpkeys \- dump keyboard translation tables
  5. .SH SYNOPSIS
  6. .B dumpkeys
  7. [
  8. .\".B \-1Vdfhiklnstv
  9. .B \-h \-\-help \-i \-\-short\-info \-l \-s \-\-long\-info
  10. .B \-n \-\-numeric \-f \-\-full\-table \-1 \-\-separate-lines
  11. .BI \-S shape
  12. .BI \-\-shape= shape
  13. .B \-t \-\-funcs\-only \-k \-\-keys\-only \-d \-\-compose\-only
  14. .BI \-c charset
  15. .BI \-\-charset= charset
  16. .B \-v \-\-verbose \-V \-\-version
  17. ]
  18. .SH DESCRIPTION
  19. .IX "dumpkeys command" "" "\fLdumpkeys\fR command"
  20. .LP
  21. .B dumpkeys
  22. writes, to the standard output, the current contents of the keyboard
  23. driver's translation tables, in the format specified by
  24. .BR keymaps (5).
  25. .LP
  26. Using the various options, the format of the output can be controlled
  27. and also other information from the kernel and the programs
  28. .BR dumpkeys (1)
  29. and
  30. .BR loadkeys (1)
  31. can be obtained.
  32. .SH OPTIONS
  33. .TP
  34. .B \-h \-\-help
  35. Prints the program's version number and a short usage message to the
  36. program's standard error output and exits.
  37. .TP
  38. .B \-i \-\-short-info
  39. Prints some characteristics of the kernel's keyboard driver. The items
  40. shown are:
  41. .LP
  42. .RS
  43. Keycode range supported by the kernel
  44. .LP
  45. .RS
  46. This tells what values can be used after the
  47. .B keycode
  48. keyword in keytable files. See
  49. .BR keymaps (5)
  50. for more information and the syntax of these files.
  51. .RE
  52. .LP
  53. Number of actions bindable to a key
  54. .LP
  55. .RS
  56. This tells how many different actions a single key can output using
  57. various modifier keys. If the value is 16 for example, you can define up
  58. to 16 different actions to a key combined with modifiers. When the value
  59. is 16, the kernel probably knows about four modifier keys, which you can
  60. press in different combinations with the key to access all the bound
  61. actions.
  62. .RE
  63. .LP
  64. Ranges of action codes supported by the kernel
  65. .LP
  66. .RS
  67. This item contains a list of action code ranges in hexadecimal notation.
  68. These are the values that can be used in the right hand side of a key
  69. definition, ie. the
  70. .IR vv 's
  71. in a line
  72. .LP
  73. .RS
  74. .B keycode
  75. .I xx
  76. =
  77. .I vv vv vv vv
  78. .RE
  79. .LP
  80. (see
  81. .BR keymaps (5)
  82. for more information about the format of key definition lines).
  83. .BR dumpkeys (1)
  84. and
  85. .BR loadkeys (1)
  86. support a symbolic notation, which is preferable to the numeric one, as
  87. the action codes may vary from kernel to kernel while the symbolic names
  88. usually remain the same. However, the list of action code ranges can be
  89. used to determine, if the kernel actually supports all the symbols
  90. .BR loadkeys (1)
  91. knows, or are there maybe some actions supported by the kernel that
  92. have no symbolic name in your
  93. .BR loadkeys (1)
  94. program. To see this, you compare the range list with the action symbol
  95. list, see option
  96. .B --long-info
  97. below.
  98. .RE
  99. .LP
  100. Number of function keys supported by kernel
  101. .LP
  102. .RS
  103. This tells the number of action codes that can be used to output
  104. strings of characters. These action codes are traditionally bound to
  105. the various function and editing keys of the keyboard and are defined
  106. to send standard escape sequences. However, you can redefine these to
  107. send common command lines, email addresses or whatever you like.
  108. Especially if the number of this item is greater than the number of
  109. function and editing keys in your keyboard, you may have some "spare"
  110. action codes that you can bind to AltGr-letter combinations, for example,
  111. to send some useful strings. See
  112. .BR loadkeys (1)
  113. for more details.
  114. .RE
  115. .LP
  116. Function strings
  117. .LP
  118. .RS
  119. You can see you current function key definitions with the command
  120. .LP
  121. .RS
  122. .B dumpkeys --funcs-only
  123. .RE
  124. .LP
  125. .RE
  126. .RE
  127. .LP
  128. .TP
  129. .B \-l \-s \-\-long-info
  130. This option instructs
  131. .B dumpkeys
  132. to print a long information listing. The output is the same as with the
  133. .B --short-info
  134. appended with the list of action symbols supported by
  135. .BR loadkeys (1)
  136. and
  137. .BR dumpkeys (1),
  138. along with the symbols' numeric values.
  139. .LP
  140. .TP
  141. .B \-n \-\-numeric
  142. This option causes
  143. .B dumpkeys
  144. to by-pass the conversion of action code values to symbolic notation and
  145. to print the in hexadecimal format instead.
  146. .LP
  147. .TP
  148. .B \-f \-\-full-table
  149. This makes
  150. .B dumpkeys
  151. skip all the short-hand heuristics (see
  152. .BR keymaps (5))
  153. and output the key bindings in the canonical form. First a keymaps
  154. line describing the currently defined modifier combinations
  155. is printed. Then for each key a row with a column for each
  156. modifier combination is printed. For
  157. example, if the current keymap in use uses seven modifiers,
  158. every row will have seven action code columns. This format
  159. can be useful for example to programs that post-process the
  160. output of
  161. .BR dumpkeys .
  162. .LP
  163. .TP
  164. .BI \-S shape " " " " \-\-shape= shape
  165. .LP
  166. .TP
  167. .B \-t \-\-funcs-only
  168. When this option is given,
  169. .B dumpkeys
  170. prints only the function key string definitions. Normally
  171. .B dumpkeys
  172. prints both the key bindings and the string definitions.
  173. .LP
  174. .TP
  175. .B \-k \-\-keys-only
  176. When this option is given,
  177. .B dumpkeys
  178. prints only the key bindings. Normally
  179. .B dumpkeys
  180. prints both the key bindings and the string definitions.
  181. .LP
  182. .TP
  183. .B \-d \-\-compose-only
  184. When this option is given,
  185. .B dumpkeys
  186. prints only the compose key combinations.
  187. This option is available only if your kernel has compose key support.
  188. .LP
  189. .TP
  190. .BI \-c charset " " " " \-\-charset= charset
  191. This instructs
  192. .B dumpkeys
  193. to interpret character code values according to the specified character
  194. set. This affects only the translation of character code values to
  195. symbolic names. Valid values for
  196. .I charset
  197. currently are
  198. .BR iso-8859-X ,
  199. Where X is a digit in 1-9. If no
  200. .I charset
  201. is specified,
  202. .B iso-8859-1
  203. is used as a default.
  204. This option produces an output line `charset "iso-8859-X"', telling
  205. loadkeys how to interpret the keymap. (For example, "division" is
  206. 0xf7 in iso-8859-1 but 0xba in iso-8859-8.)
  207. .LP
  208. .TP
  209. .B \-v \-\-verbose
  210. .LP
  211. .TP
  212. .B \-V \-\-version
  213. Prints version number and exits.
  214. .LP
  215. .SH FILES
  216. .TP
  217. .I /share/kbd/keymaps
  218. The recommended directory for keytable files.
  219. .LP
  220. .SH "SEE ALSO"
  221. .BR loadkeys (1),
  222. .BR keymaps (5)