Debian Codegraph @

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