2014-03-23 07:04:51 -06:00
|
|
|
# libxkbcommon
|
|
|
|
|
|
2014-10-18 04:58:56 -06:00
|
|
|
libxkbcommon is a keymap compiler and support library which processes a
|
|
|
|
|
reduced subset of keymaps as defined by the XKB specification.
|
2014-03-23 07:04:51 -06:00
|
|
|
|
|
|
|
|
## Quick Guide
|
|
|
|
|
|
|
|
|
|
See [Quick Guide](doc/quick-guide.md).
|
|
|
|
|
|
|
|
|
|
## API
|
|
|
|
|
|
2014-10-18 04:44:02 -06:00
|
|
|
While libxkbcommon's API is somewhat derived from the classic XKB API as found
|
2014-03-23 07:04:51 -06:00
|
|
|
in X11/extensions/XKB.h and friends, it has been substantially reworked to
|
2014-10-18 04:44:02 -06:00
|
|
|
expose fewer internal details to clients.
|
|
|
|
|
|
|
|
|
|
See the [API Documentation](http://xkbcommon.org/doc/current/modules.html).
|
2014-03-23 07:04:51 -06:00
|
|
|
|
2014-10-18 04:34:15 -06:00
|
|
|
## Dataset
|
|
|
|
|
|
|
|
|
|
libxkbcommon does not distribute a keymap dataset itself, other than for
|
|
|
|
|
testing purposes. The most common dataset is xkeyboard-config, which is used
|
|
|
|
|
by all current distributions for their X11 XKB data. More information on
|
|
|
|
|
xkeyboard-config is available here:
|
|
|
|
|
http://www.freedesktop.org/wiki/Software/XKeyboardConfig
|
|
|
|
|
|
2014-03-23 07:04:51 -06:00
|
|
|
## Relation to X11
|
|
|
|
|
|
2014-10-18 04:50:54 -06:00
|
|
|
See [Compatibility](doc/compat.md) notes.
|
2014-03-23 07:04:51 -06:00
|
|
|
|
|
|
|
|
## Development
|
|
|
|
|
|
|
|
|
|
An extremely rudimentary homepage can be found at
|
|
|
|
|
http://xkbcommon.org
|
|
|
|
|
|
|
|
|
|
xkbcommon is maintained in git at
|
|
|
|
|
https://github.com/xkbcommon/libxkbcommon
|
|
|
|
|
|
|
|
|
|
Patches are always welcome, and may be sent to either
|
|
|
|
|
<xorg-devel@lists.x.org> or <wayland-devel@lists.freedesktop.org>
|
|
|
|
|
|
|
|
|
|
Bugs are also welcome, and may be reported either at
|
|
|
|
|
Bugzilla https://bugs.freedesktop.org/describecomponents.cgi?product=libxkbcommon
|
|
|
|
|
or
|
|
|
|
|
Github https://github.com/xkbcommon/libxkbcommon/issues
|
|
|
|
|
|
|
|
|
|
The maintainers are
|
|
|
|
|
- Daniel Stone <daniel@fooishbar.org>
|
|
|
|
|
- Ran Benita <ran234@gmail.com>
|
|
|
|
|
|
|
|
|
|
## Credits
|
|
|
|
|
|
|
|
|
|
Many thanks are due to Dan Nicholson for his heroic work in getting xkbcommon
|
|
|
|
|
off the ground initially.
|
