-
Show log
Commit
-
Hash : 3150bca8
Author :
Date : 2025-03-30T09:54:02
xkbcomp: Make all components optional We already accept *empty* components, such as: `xkb_compat {};`. Let’s accept missing components as well, so that we can reduce the boilerplate in our tests. Note that we will still explicitly serialize empty components for compatibility with previous xkbcommon versions and Xorg xkbcomp.
-
README.md
-
libxkbcommon
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 registry library for listing available keyboard layouts.
Quick Guide
- Introduction to XKB: to learn the essentials of XKB.
- User-configuration: instructions to add a custom layout or option.
- Quick Guide: introduction on how to use this library.
Building
libxkbcommon is built with Meson:
meson setup build meson compile -C build meson test -C build # Run the tests.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 \ -Dx-locale-root=/usr/share/X11/locale meson compile -C buildComplete list of user options
@include meson_options.txtAPI
While libxkbcommon’s API is somewhat derived from the classic XKB API as found in
X11/extensions/XKB.hand friends, it has been substantially reworked to expose fewer internal details to clients.See the API Documentation.
Dataset
libxkbcommon does not distribute a keyboard layout 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. Further information on xkeyboard-config is available at its homepage and at its repository.
The dataset for Compose is distributed in libX11, as part of the X locale data.
Relation to X11
See Compatibility notes.
Development
An extremely rudimentary homepage can be found at
https://xkbcommon.orgxkbcommon is maintained in git at
https://github.com/xkbcommon/libxkbcommonPatches 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:
Credits
Many thanks are due to Dan Nicholson for his heroic work in getting xkbcommon off the ground initially.