diff options
| author | Michael Witten <mfwitten@gmail.com> | 2014-11-12 08:35:44 +1000 |
|---|---|---|
| committer | Peter Hutterer <peter.hutterer@who-t.net> | 2014-11-12 08:37:05 +1000 |
| commit | b664d7fb8aab9b0f834dd9c81d273c7809561b34 (patch) | |
| tree | 51511a9441671b1faf0d030f9b35a7ea3a5929f6 | |
| parent | 0d4c3d9d891536aa1ec4f1fff5e3df51cfd2718d (diff) | |
README: Clean up grammar/formatting, and mention bugzilla
https://bugs.freedesktop.org/show_bug.cgi?id=51307
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
| -rw-r--r-- | README | 54 |
1 files changed, 36 insertions, 18 deletions
@@ -1,28 +1,46 @@ X Keyboard Extension -------------------- -The X Keyboard Extension essentially replaces the core protocol definition -of the keyboard. The extension makes it possible to clearly and explicitly -specify most aspects of keyboard behaviour on a 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. +The X Keyboard (XKB) Extension essentially replaces the core protocol +definition of a keyboard. The extension makes it possible to specify +clearly and explicitly most aspects of keyboard behaviour on a per-key +basis, and to track more closely the logical and physical state of a +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 corresponding to -five xkb symbolic names (symbols, geometry, keycodes, compat, and types) -which determine the keyboard behaviour. These five components can be -combined into a resulting keyboard mapping using the 'rules' component. +There are five components that define a complete keyboard mapping: +symbols, geometry, keycodes, compat, and types; these five components +can be combined together using the 'rules' component of the database +provided by this project, xkeyboard-config. -The complete specification can be found in: - http://www.x.org/current/doc/kbproto/xkbproto.pdf +The complete specification for the XKB Extension can be found here: -For XKB configuration information, see the 'docs/README.config' file. + http://xfree86.org/current/XKBproto.pdf -For information on how to further enhance XKB configuration, see the -'docs/README.enhancing' file. +xkeyboard-config +---------------- -For information on how to replace an existing XKB configuration database -with XKeyboardConfig, see the 'docs/HOWTO.transition' file. +This project provides a consistent, well-structured, frequently +released, open source database of keyboard configuration data. The +project is targeted to XKB-based systems. + +For XKB configuration information, see: + + docs/README.config + +For information on how to enhance the database itself, see: + + docs/README.enhancing + +For information on how to replace an older XKB configuration database +with the one provided by this project, see: + + docs/HOWTO.transition + +For guidelines to making contributions to this project, see: -Contribution guidelines are described on: http://www.freedesktop.org/wiki/Software/XKeyboardConfig/Rules + +To submit bug reports (and patches), please use the bugzilla system: + + https://bugs.freedesktop.org/enter_bug.cgi?product=xkeyboard-config |