Debian Codegraph @

upstream/mageia-cauldron/man1/dumpkeys.1

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