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