Bug: 111264136

Clone this repo:
  1. 91f3839 Upgrade libxkbcommon to xkbcommon-1.0.3 by Haibo Huang · 9 weeks ago master
  2. cda6b37 Fix license_type. Contains GPL code. by Bob Badour · 5 days ago
  3. 494ce04 Mark ab/6881855 as merged by Xin Li · 9 weeks ago
  4. a948866 Merge "Add the janitors to OWNERS." am: 8adc8495c6 by Treehugger Robot · 3 months ago
  5. 8adc849 Merge "Add the janitors to OWNERS." by Treehugger Robot · 3 months ago


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 and a separate library for listing available keyboard layouts.

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: https://www.freedesktop.org/wiki/Software/XKeyboardConfig

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 https://xkbcommon.org

xkbcommon is maintained in git at https://github.com/xkbcommon/libxkbcommon

Patches are always welcome, and may be sent to either xorg-devel@lists.x.org or wayland-devel@lists.freedesktop.org or in a GitHub pull request.

Bug reports (and usage questions) are also welcome, and may be filed at GitHub.

The maintainers are


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