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