~ubuntu-branches/ubuntu/trusty/kbd/trusty

« back to all changes in this revision

Viewing changes to man/man1/dumpkeys.1

  • Committer: Package Import Robot
  • Author(s): Colin Watson
  • Date: 2013-02-18 13:25:55 UTC
  • mfrom: (1.1.22 sid)
  • Revision ID: package-import@ubuntu.com-20130218132555-9aiwvswlo12fo32s
Tags: 1.15.5-1ubuntu1
* Resynchronise with Debian.  Remaining changes:
  - Add setfont, kbd_mode, and loadkeys to initramfs for console-setup.
  - Use ckbcomp to get the keyboard layout if other data files are not
    available.
  - Depend on console-setup, and remove config file; we now only support
    systems using console-setup and so it no longer serves a purpose. The
    removed config file for console-screen has changed names from
    /etc/init.d/console-screen.kbd.sh to /etc/init.d/kbd.
  - Change loadkeys to find any console not in raw mode when invoked
    without an explicit console parameter, in case the foreground console
    is in raw mode.
  - Simplify maintainer scripts for conffile removal, using new features
    in debhelper 8.1.0.
  - Add setvtrgb to kbd-udeb.
* Fix incorrect keymap sanity check in loadkeys_ckbcomp.diff.

Show diffs side-by-side

added added

removed removed

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