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
6 and dead keys and a separate library for listing available keyboard layouts.
10 See [Quick Guide](doc/quick-guide.md).
14 libxkbcommon is built with [Meson](http://mesonbuild.com/):
18 ninja -C build test # Run the tests.
20 To build for use with Wayland, you can disable X11 support while still
21 using the X11 keyboard configuration resource files thusly:
25 -Dxkb-config-root=/usr/share/X11/xkb \
26 -Dx-locale-root=/usr/share/X11/locale
31 While libxkbcommon's API is somewhat derived from the classic XKB API as found
32 in X11/extensions/XKB.h and friends, it has been substantially reworked to
33 expose fewer internal details to clients.
35 See the [API Documentation](https://xkbcommon.org/doc/current/modules.html).
39 libxkbcommon does not distribute a keymap dataset itself, other than for
40 testing purposes. The most common dataset is xkeyboard-config, which is used
41 by all current distributions for their X11 XKB data. More information on
42 xkeyboard-config is available here:
43 https://www.freedesktop.org/wiki/Software/XKeyboardConfig
45 The dataset for Compose is distributed in libX11, as part of the X locale
50 See [Compatibility](doc/compat.md) notes.
54 An extremely rudimentary homepage can be found at
57 xkbcommon is maintained in git at
58 https://github.com/xkbcommon/libxkbcommon
60 Patches are always welcome, and may be sent to either
61 <xorg-devel@lists.x.org> or <wayland-devel@lists.freedesktop.org>
62 or in a [GitHub](https://github.com/xkbcommon/libxkbcommon) pull request.
64 Bug reports (and usage questions) are also welcome, and may be filed at
65 [GitHub](https://github.com/xkbcommon/libxkbcommon/issues).
68 - Daniel Stone <daniel@fooishbar.org>
69 - Ran Benita <ran@unusedvar.com>
73 Many thanks are due to Dan Nicholson for his heroic work in getting xkbcommon
74 off the ground initially.