View Source: dumpkeys(1) - Waikato Linux Users Group

Edit PageHistory Diff Info LikePages
DUMPKEYS
!!!DUMPKEYS
NAME
SYNOPSIS
DESCRIPTION
OPTIONS
FILES
SEE ALSO
----
!!NAME


dumpkeys - dump keyboard translation tables
!!SYNOPSIS


__dumpkeys [[__ ''-hilfn1 -S''__shape__
''-c''__charset__ ''--help --short-info --long-info
--numeric --full-table --separate-lines
--shape=''__shape__ ''--funcs-only --keys-only
--compose-only --charset=''__charset ]__
!!DESCRIPTION


__dumpkeys__ writes, to the standard output, the current
contents of the keyboard driver's translation tables, in the
format specified by keymaps(5).


Using the various options, the format of the output can be
controlled and also other information from the kernel and
the programs dumpkeys(1) and loadkeys(1) can
be obtained.
!!OPTIONS


''-h --help''


Prints the program's version number and a short usage
message to the program's standard error output and
exits.


''-i --short-info''


Prints some characteristics of the kernel's keyboard driver.
The items shown are:


Keycode range supported by the kernel:


This tells what values can be used after the __keycode__
keyword in keymap files. See keymaps(5) for more
information and the syntax of these files.


Number of actions bindable to a key:


This tells how many different actions a single key can
output using various modifier keys. If the value is 16 for
example, you can define up to 16 different actions to a key
combined with modifiers. When the value is 16, the kernel
probably knows about four modifier keys, which you can press
in different combinations with the key to access all the
bound actions.


Ranges of action codes supported by the kernel:


This item contains a list of action code ranges in
hexadecimal notation. These are the values that can be used
in the right hand side of a key definition, ie. the
''vv'''s in a line


__keycode__ ''xx'' = ''vv vv vv vv''


(see keymaps(5) for more information about the format
of key definition lines). dumpkeys(1) and
loadkeys(1) support a symbolic notation, which is
preferable to the numeric one, as the action codes may vary
from kernel to kernel while the symbolic names usually
remain the same. However, the list of action code ranges can
be used to determine, if the kernel actually supports all
the symbols loadkeys(1) knows, or are there maybe
some actions supported by the kernel that have no symbolic
name in your loadkeys(1) program. To see this, you
compare the range list with the action symbol list, see
option ''--long-info'' below.


Number of function keys supported by kernel:


This tells the number of action codes that can be used to
output strings of characters. These action codes are
traditionally bound to the various function and editing keys
of the keyboard and are defined to send standard escape
sequences. However, you can redefine these to send common
command lines, email addresses or whatever you like.
Especially if the number of this item is greater than the
number of function and editing keys in your keyboard, you
may have some
loadkeys__(1) for more
details.


Function strings:


You can see you current function key definitions with the
command


__dumpkeys__''--funcs-only''


''-l --long-info''


This option instructs __dumpkeys__ to print a long
information listing. The output is the same as with the
''--short-info'' appended with the list of action symbols
supported by loadkeys(1) and dumpkeys(1),
along with the symbols' numeric values.


''-n --numeric''


This option causes __dumpkeys__ to by-pass the conversion
of action code values to symbolic notation and to print the
in hexadecimal format instead.


''-f --full-table''


This makes __dumpkeys__ skip all the short-hand
heuristics (see keymaps(5)) and output the key
bindings in the canonical form. First a keymaps line
describing the currently defined modifier combinations is
printed. Then for each key a row with a column for each
modifier combination is printed. For example, if the current
keymap in use uses seven modifiers, every row will have
seven action code columns. This format can be useful for
example to programs that post-process the output of
__dumpkeys__.


''-1 --separate-lines''


This forces __dumpkeys__ to write one line per
(modifier,keycode) pair. It prefixes the word ''plain''
for plain keycodes.


''-S --shape=''__shape__


Tells __dumpkeys__ to use the specified table shape.
Allowed shapes are __0__'':'' default shape (same as
no ''-S''); __1__: same as option ''--full-table'';
__2__: same as option ''--separate-lines''; __3__:
display one line per keycode (as in shape __1__), until
first hole is met, then use one line per (modifier,keycode)
pair (as in shape __2__).


''--funcs-only''


When this option is given, __dumpkeys__ prints only the
function key string definitions. Normally __dumpkeys__
prints both the key bindings and the string
definitions.


''--keys-only''


When this option is given, __dumpkeys__ prints only the
key bindings. Normally __dumpkeys__ prints both the key
bindings and the string definitions.


''--compose-only''


When this option is given, __dumpkeys__ prints only the
compose key combinations. This option is available only if
your kernel has compose key support.


''-c''__charset__
''--charset=''__charset__


This instructs __dumpkeys__ to interpret character code
values according to the specified character set. This
affects only the translation of character code values to
symbolic names. Valid values for ''charset'' are listed
by the ''--help'' option. If no ''charset'' is
specified, __iso-8859-1__ is used as a default. This
option produces an output line `charset
__iso-8859-1__ but 0xba in
__iso-8859-8__).
!!FILES


''/usr/share/keymaps/'' recommended directory for keymap
files
!!SEE ALSO


loadkeys(1), keymaps(5).
----
7 pages link to dumpkeys(1):
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.
Last edited on Tuesday, June 4, 2002 12:21:57 am by "perry"
Edit PageHistory Diff Info LikePages