1DUMPKEYS(1) General Commands Manual DUMPKEYS(1)
2
6 dumpkeys - dump keyboard translation tables
7
9 dumpkeys [ -h --help -i --short-info -l -s --long-info -n --numeric -f
10 --full-table -1 --separate-lines -Sshape --shape=shape -t --funcs-only
11 -k --keys-only -d --compose-only -ccharset --charset=charset -v --ver‐
12 bose -V --version ]
13
15 dumpkeys writes, to the standard output, the current contents of the
16 keyboard driver's translation tables, in the format specified by
17 keymaps(5).
18 Using the various options, the format of the output can be controlled
20 and also other information from the kernel and the programs dumpkeys(1)
21 and loadkeys(1) can be obtained.
22
24 -h --help
25 Prints the program's version number and a short usage message to
26 the program's standard error output and exits.
27 -i --short-info
29 Prints some characteristics of the kernel's keyboard driver. The
30 items shown are:
31 Keycode range supported by the kernel
33 This tells what values can be used after the keycode key‐
35 word in keytable files. See keymaps(5) for more informa‐
36 tion and the syntax of these files.
37 Number of actions bindable to a key
39 This tells how many different actions a single key can
41 output using various modifier keys. If the value is 16
42 for example, you can define up to 16 different actions to
43 a key combined with modifiers. When the value is 16, the
44 kernel probably knows about four modifier keys, which you
45 can press in different combinations with the key to
46 access all the bound actions.
47 Ranges of action codes supported by the kernel
49 This item contains a list of action code ranges in hexa‐
51 decimal notation. These are the values that can be used
52 in the right hand side of a key definition, ie. the vv's
53 in a line
54 keycode xx = vv vv vv vv
56 (see keymaps(5) for more information about the format of
58 key definition lines). dumpkeys(1) and loadkeys(1) sup‐
59 port a symbolic notation, which is preferable to the
60 numeric one, as the action codes may vary from kernel to
61 kernel while the symbolic names usually remain the same.
62 However, the list of action code ranges can be used to
63 determine, if the kernel actually supports all the sym‐
64 bols loadkeys(1) knows, or are there maybe some actions
65 supported by the kernel that have no symbolic name in
66 your loadkeys(1) program. To see this, you compare the
67 range list with the action symbol list, see option
68 --long-info below.
69 Number of function keys supported by kernel
71 This tells the number of action codes that can be used to
73 output strings of characters. These action codes are tra‐
74 ditionally bound to the various function and editing keys
75 of the keyboard and are defined to send standard escape
76 sequences. However, you can redefine these to send common
77 command lines, email addresses or whatever you like.
78 Especially if the number of this item is greater than the
79 number of function and editing keys in your keyboard, you
80 may have some "spare" action codes that you can bind to
81 AltGr-letter combinations, for example, to send some use‐
82 ful strings. See loadkeys(1) for more details.
83 Function strings
85 You can see you current function key definitions with the
87 command
88 dumpkeys --funcs-only
90 -l -s --long-info
92 This option instructs dumpkeys to print a long information list‐
93 ing. The output is the same as with the --short-info appended
94 with the list of action symbols supported by loadkeys(1) and
95 dumpkeys(1), along with the symbols' numeric values.
96 -n --numeric
98 This option causes dumpkeys to by-pass the conversion of action
99 code values to symbolic notation and to print the in hexadecimal
100 format instead.
101 -f --full-table
103 This makes dumpkeys skip all the short-hand heuristics (see
104 keymaps(5)) and output the key bindings in the canonical form.
105 First a keymaps line describing the currently defined modifier
106 combinations is printed. Then for each key a row with a column
107 for each modifier combination is printed. For example, if the
108 current keymap in use uses seven modifiers, every row will have
109 seven action code columns. This format can be useful for example
110 to programs that post-process the output of dumpkeys.
111 -Sshape --shape=shape
113 -1 --separate-lines
115 This forces dumpkeys to write one line per (modifier,keycode)
116 pair. It prefixes the word plain for plain keycodes.
117 -t --funcs-only
119 When this option is given, dumpkeys prints only the function key
120 string definitions. Normally dumpkeys prints both the key bind‐
121 ings and the string definitions.
122 -k --keys-only
124 When this option is given, dumpkeys prints only the key bind‐
125 ings. Normally dumpkeys prints both the key bindings and the
126 string definitions.
127 -d --compose-only
129 When this option is given, dumpkeys prints only the compose key
130 combinations. This option is available only if your kernel has
131 compose key support.
132 -ccharset --charset=charset
134 This instructs dumpkeys to interpret character code values
135 according to the specified character set. This affects only the
136 translation of character code values to symbolic names. Valid
137 values for charset currently are iso-8859-X, Where X is a digit
138 in 1-9. If no charset is specified, iso-8859-1 is used as a
139 default. This option produces an output line `charset
140 "iso-8859-X"', telling loadkeys how to interpret the keymap.
141 (For example, "division" is 0xf7 in iso-8859-1 but 0xba in
142 iso-8859-8.)
143 -v --verbose
145 -V --version
147 Prints version number and exits.
148
150 /usr/lib/kbd/keymaps
151 The recommended directory for keytable files.
152
154 loadkeys(1), keymaps(5)
155kbd 1 Sep 1993 DUMPKEYS(1)