summaryrefslogtreecommitdiff
path: root/README
blob: d91eda6e64bc42d43cce6550cdf06f81381365f3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
X Keyboard Extension
--------------------

The X Keyboard Extension essentially replaces the core protocol definition of
keyboard. The extension makes possible to clearly and explicitly specify most
aspects of keyboard behaviour on per-key basis and to more closely track the
logical and physical state of the keyboard. It also includes a number of
keyboard controls designed to make keyboards more accessible to people with
physical impairments.

There are five types of components in the server database corresponing to five
xkb symbolic names: symbols, geometry, keycodes, compat and types which
determine the keyboard behaviour. These five components can combined together
into a resulting keyboard mapping using the 'rules' component.

The complete specification can be found on
http://xfree86.org/current/XKBproto.pdf

For XKB configuration information see 'docs/README.config' file.

For information how to further enhance XKB configuration see 'docs/README.enhancing'
file.

For information how to replace existing XKB configuration database with 
XKeyboardConfig see 'docs/HOWTO.transition' file.

Contribution guidelines are described at
http://www.freedesktop.org/wiki/Software/XKeyboardConfig/Rules