README
1X Keyboard Extension
2--------------------
3
4The X Keyboard (XKB) Extension essentially replaces the core protocol
5definition of a keyboard. The extension makes it possible to specify
6clearly and explicitly most aspects of keyboard behaviour on a per-key
7basis, and to track more closely the logical and physical state of a
8keyboard. It also includes a number of keyboard controls designed to
9make keyboards more accessible to people with physical impairments.
10
11There are five components that define a complete keyboard mapping:
12symbols, geometry, keycodes, compat, and types; these five components
13can be combined together using the 'rules' component of the database
14provided by this project, xkeyboard-config.
15
16The complete specification for the XKB Extension can be found here:
17
18 http://xfree86.org/current/XKBproto.pdf
19
20xkeyboard-config
21----------------
22
23This project provides a consistent, well-structured, frequently
24released, open source database of keyboard configuration data.
25The project is targeted at XKB-based systems.
26
27For XKB configuration information, see:
28
29 docs/README.config
30
31For information on how to enhance the database itself, see:
32
33 docs/README.enhancing
34
35For guidelines to making contributions to this project, see:
36
37 http://www.freedesktop.org/wiki/Software/XKeyboardConfig/Rules
38
39To submit bug reports (and patches), please use the issue system in
40freedesktop.org's gitlab instance:
41
42 https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config/issues
43