keymap handling library for toolkits and window systems
C Yacc Meson M4 Makefile Shell Other
Clone or download
bluetech Bump version to 0.8.2
Signed-off-by: Ran Benita <>
Latest commit f8134c8 Aug 5, 2018
Failed to load latest commit information.
bench bench: simplify the bench helpers Jul 5, 2018
doc build: make doxygen run from the source tree Aug 1, 2017
fuzz Add fuzzing infrastructure Jul 30, 2018
m4 Remove m4/.gitkeep Feb 8, 2014
scripts build: make doxygen run from the source tree Aug 1, 2017
src Fail expression lookup on invalid atoms Aug 3, 2018
test keysym-utf: reject out-of-range Unicode codepoints in xkb_keysym_to_u… Jun 23, 2018
xkbcommon doc: improve the description of the consumed modifier modes Jan 26, 2018
.autom4te.cfg build: use build-aux as autom4te cache directory Aug 15, 2013
.gitignore build: add meson build system Jul 31, 2017
.travis.yml travis: pin meson to an older version so it works with Python 3.4 Jun 23, 2018
.uncrustify.cfg Run source tree through uncrustify Jul 17, 2012
LICENSE test: Add interactive-wayland Apr 12, 2016 build/autotools: remove redundant ACLOCAL_AMFLAGS Feb 27, 2018
NEWS Update NEWS Aug 5, 2018
PACKAGING README,PACKAGING: use the new meson unified command format Dec 15, 2017 Convert http:// -> https:// where possible Dec 21, 2017 autogen: use --force instead of --symlink Oct 23, 2012 Bump version to 0.8.2 Aug 5, 2018 Bump version to 0.8.2 Aug 5, 2018
meson_options.txt build: add meson build system Jul 31, 2017 Change initial symbol file versions to V_0.5.0 Oct 18, 2014 x11: add XKB protocol keymap and state creation support Feb 2, 2014 keysym: add xkb_keysym_to_{lower,upper} to public API Dec 11, 2017 Remove xproto and kbproto from pkg-config file Apr 9, 2012


libxkbcommon is a keyboard keymap compiler and support library which processes a reduced subset of keymaps as defined by the XKB (X Keyboard Extension) specification. It also contains a module for handling Compose and dead keys.

Quick Guide

See Quick Guide.


libxkbcommon is built with Meson:

meson setup build
ninja -C build

To build for use with Wayland, you can disable X11 support while still using the X11 keyboard configuration resource files thusly:

meson setup build \
    -Denable-x11=false \
    -Dxkb-config-root=/usr/share/X11/xkb \
ninja -C build


While libxkbcommon's API is somewhat derived from the classic XKB API as found in X11/extensions/XKB.h and friends, it has been substantially reworked to expose fewer internal details to clients.

See the API Documentation.


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:

The dataset for Compose is distributed in libX11, as part of the X locale data.

Relation to X11

See Compatibility notes.


An extremely rudimentary homepage can be found at

xkbcommon is maintained in git at

Patches are always welcome, and may be sent to either or or through github.

Bug reports are also welcome, and may be filed either at Bugzilla or Github

The maintainers are


Many thanks are due to Dan Nicholson for his heroic work in getting xkbcommon off the ground initially.