Unneed norepeat compat section
[xorg/xkeyboard-config] / README
1 X Keyboard Extension
2 --------------------
3
4 The X Keyboard Extension essentially replaces the core protocol definition of
5 keyboard. The extension makes possible to clearly and explicitly specify most
6 aspects of keyboard behaviour on per-key basis and to more closely track the
7 logical and physical state of the keyboard. It also includes a number of
8 keyboard controls designed to make keyboards more accessible to people with
9 physical impairments.
10
11 There are five types of components in the server database corresponing to five
12 xkb symbolic names: symbols, geometry, keycodes, compat and types which
13 determine the keyboard behaviour. These five components can combined together
14 into a resulting keyboard mapping using the 'rules' component.
15
16 The complete specification can be found on
17 http://xfree86.org/current/XKBproto.pdf
18
19 For XKB configuration information see 'docs/README.config' file.
20
21 For information how to further enhance XKB configuration see 'docs/README.enhancing'
22 file.
23
24 For information how to replace existing XKB configuration database with 
25 XKeyboardConfig see 'docs/HOWTO.transition' file.
26
27 Contribution guidelines are described at
28 http://www.freedesktop.org/wiki/Software/XKeyboardConfig/Rules