Copyright (C) 2007, 2011 Anton Zinoviev <firstname.lastname@example.org> Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. This file is offered as-is, without any warranty.
NAMEckbcomp - compile a XKB keyboard description to a keymap suitable for loadkeys or kbdcontrol
SYNOPSISckbcomp [OPTION...] [XKBLAYOUT [XKBVARIANT [XKBOPTIONS]...]]
DESCRIPTIONThe ckbcomp keymap compiler converts a description of an XKB keyboard layout into a console keymap that can be read directly by loadkeys(1) or kbdcontrol(1). On its standard output ckbcomp dumps the generated keyboard definition. The most important difference between the arguments of setxkbmap(1) and the arguments of ckbcomp is the additional parameter -charmap when non-Unicode keyboard map is wanted. Without -charmap ckbcomp will generate Unicode keyboard.
- Print a usage message and exit.
- -charmap charmap
The encoding to use for the output keymap. There should be an
character mapping table defining this encoding in
Definitions of the following charmaps are provided:
Look in the top-level directory
for files included by the keymap description. This option may be used
multiple times. If a file can not be found in any of the specified
directories, it will be searched also in some other standard
locations, such as
- -v level
- Set level of detail for listing. The argument level must be a number from 1 to 10.
- Generate a compact keymap with at most two xkb groups and two levels in each or only one xkb-group and up to four levels.
- Generate a keymap for FreeBSD.
- -backspace [bs|del]
Specifies the behaviour of the
<BackSpace>and<Delete>keys. Value bs specifies VT100-conformant behaviour:<BackSpace>will generate ^H(ASCII BS)and<Delete>will generate ^?(ASCII DEL).Value del specifies VT220-conformant behavior:<BackSpace>will generate ^?(ASCII DEL)and<Delete>will generate a special function sequence.
XKB Keyboard DescriptionThe keyboard layout, variant and options components can be also specified directly on the command line. See the synopsis of the command.
- -symbols name
- Specifies the symbols component name of the XKB keyboard description.
- -keycodes name
- Specifies the keycodes component name of the XKB keyboard description.
- -rules name
- The name of the rules file to use.
- -model name
- Specifies the keyboard model used to choose the component names.
- -layout name
- Specifies the layout used to choose the component names.
- -variant name
- Specifies the layout variant used to choose the component names.
- -option name
Adds an option used to choose component names.
NOTESIf the option -freebsd is used together with -backspace del, then the key
<Delete>will generate the special code fkey70. It is your responsibility to assign the appropriate sequence to this special code by using the following command:
kbdcontrol -f 70 "`printf '\033[3~'`"