summaryrefslogtreecommitdiff
path: root/dist/xkeyboard-config/README
diff options
context:
space:
mode:
Diffstat (limited to 'dist/xkeyboard-config/README')
-rw-r--r--dist/xkeyboard-config/README25
1 files changed, 25 insertions, 0 deletions
diff --git a/dist/xkeyboard-config/README b/dist/xkeyboard-config/README
new file mode 100644
index 000000000..c95d3fd83
--- /dev/null
+++ b/dist/xkeyboard-config/README
@@ -0,0 +1,25 @@
+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.