3 libxkbcommon is a keyboard keymap compiler and support library which
4 processes a reduced subset of keymaps as defined by the XKB (X Keyboard
5 Extension) specification. It also contains a module for handling Compose
10 See [Quick Guide](doc/quick-guide.md).
14 libxkbcommon is built the typical autoconf way:
19 To build for use with Wayland, you can disable X11 support while still
20 using the X11 keyboard configuration resource files thusly:
22 ./autogen.sh --disable-x11 \
23 --with-xkb-config-root=/usr/share/X11/xkb \
24 --with-x-locale-root=/usr/share/X11/locale
29 While libxkbcommon's API is somewhat derived from the classic XKB API as found
30 in X11/extensions/XKB.h and friends, it has been substantially reworked to
31 expose fewer internal details to clients.
33 See the [API Documentation](http://xkbcommon.org/doc/current/modules.html).
37 libxkbcommon does not distribute a keymap dataset itself, other than for
38 testing purposes. The most common dataset is xkeyboard-config, which is used
39 by all current distributions for their X11 XKB data. More information on
40 xkeyboard-config is available here:
41 http://www.freedesktop.org/wiki/Software/XKeyboardConfig
43 The dataset for Compose is distributed in libX11, as part of the X locale
48 See [Compatibility](doc/compat.md) notes.
52 An extremely rudimentary homepage can be found at
55 xkbcommon is maintained in git at
56 https://github.com/xkbcommon/libxkbcommon
58 Patches are always welcome, and may be sent to either
59 <xorg-devel@lists.x.org> or <wayland-devel@lists.freedesktop.org>
62 Bug reports are also welcome, and may be filed either at
63 Bugzilla https://bugs.freedesktop.org/describecomponents.cgi?product=libxkbcommon
65 Github https://github.com/xkbcommon/libxkbcommon/issues
68 - Daniel Stone <daniel@fooishbar.org>
69 - Ran Benita <ran234@gmail.com>
73 Many thanks are due to Dan Nicholson for his heroic work in getting xkbcommon
74 off the ground initially.