1# libxkbcommon 2 3libxkbcommon is a keyboard keymap compiler and support library which 4processes a reduced subset of keymaps as defined by the XKB (X Keyboard 5Extension) specification. It also contains a module for handling Compose 6and dead keys. 7 8## Quick Guide 9 10See [Quick Guide](doc/quick-guide.md). 11 12## API 13 14While libxkbcommon's API is somewhat derived from the classic XKB API as found 15in X11/extensions/XKB.h and friends, it has been substantially reworked to 16expose fewer internal details to clients. 17 18See the [API Documentation](http://xkbcommon.org/doc/current/modules.html). 19 20## Dataset 21 22libxkbcommon does not distribute a keymap dataset itself, other than for 23testing purposes. The most common dataset is xkeyboard-config, which is used 24by all current distributions for their X11 XKB data. More information on 25xkeyboard-config is available here: 26 http://www.freedesktop.org/wiki/Software/XKeyboardConfig 27 28The dataset for Compose is distributed in libX11, as part of the X locale 29data. 30 31## Relation to X11 32 33See [Compatibility](doc/compat.md) notes. 34 35## Development 36 37An extremely rudimentary homepage can be found at 38 http://xkbcommon.org 39 40xkbcommon is maintained in git at 41 https://github.com/xkbcommon/libxkbcommon 42 43Patches are always welcome, and may be sent to either 44 <xorg-devel@lists.x.org> or <wayland-devel@lists.freedesktop.org> 45or through github. 46 47Bugs are also welcome, and may be reported either at 48 Bugzilla https://bugs.freedesktop.org/describecomponents.cgi?product=libxkbcommon 49or 50 Github https://github.com/xkbcommon/libxkbcommon/issues 51 52The maintainers are 53- Daniel Stone <daniel@fooishbar.org> 54- Ran Benita <ran234@gmail.com> 55 56## Credits 57 58Many thanks are due to Dan Nicholson for his heroic work in getting xkbcommon 59off the ground initially. 60