Pierre Le Marre da5caabbcd Add RMLVO builder API
Before this commit, the API to work with RMLVO was quite minimal: it
only uses raw strings from the `xkb_rule_names` struct. However:

- it forces the users to deal with error-prone string formatting;
- it does not enforce tying together layouts and variants;
- it limits adding new features by requiring defining delimiter
  characters and the corresponding parsing.

Added the following API:

- `xkb_rmlvo_builder_new()`
- `xkb_rmlvo_builder_append_layout()`
- `xkb_rmlvo_builder_append_option()`
- `xkb_rmlvo_builder_unref()`

There is no intermediate `layout` nor `option` object, in order to
to keep the API simple. The only foreseen extension is enabling
configuring layout-specific options.
2025-06-16 17:13:41 +02:00
2025-06-16 17:13:41 +02:00
2025-06-11 20:04:08 +02:00
2025-06-16 17:13:41 +02:00
2025-06-16 17:13:41 +02:00
2025-06-11 20:04:08 +02:00
2025-02-14 16:28:36 +01:00
2025-02-10 00:24:53 +02:00
2023-05-04 11:58:48 +03:00
2025-06-16 17:13:41 +02:00
2025-05-22 09:24:32 +02:00
2025-05-08 17:12:40 +02:00
2025-05-16 10:48:35 +02:00
2025-05-21 20:19:09 +02:00
2025-05-21 20:19:09 +02:00
2025-06-16 17:13:41 +02:00

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, a separate registry library for listing available keyboard layouts and a fair set of CLI tools.

Quick Guide

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 build
Complete list of user options @include meson_options.txt

API

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.

Tools

Libxkbcommon has a fair set of CLI tools, grouped under the xkbcli application:

xkbcli compile-keymap
Compile an XKB keymap
xkbcli compile-compose
Compile a compose file
xkbcli how-to-type
Show how to type a given Unicode codepoint
xkbcli interactive-wayland
Interactive debugger for XKB keymaps for Wayland
xkbcli interactive-x11
Interactive debugger for XKB keymaps for X11
xkbcli interactive-evdev
Interactive debugger for XKB keymaps for evdev
xkbcli dump-keymap-wayland
Dump a XKB keymap from a Wayland compositor
xkbcli dump-keymap-x11
Dump a XKB keymap from a X server
xkbcli list
List available layouts and more

It may require the installation of the package libxkbcommon-tools or similar name.

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 project’s 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:

License

See the LICENSE file.

Credits

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

S
Description
No description provided
Readme
13 MiB
0 Stars 1 Watchers 0 Forks
Languages
C 86.8%
Python 8.7%
Meson 1.2%
Yacc 1.1%
Jinja 1%
Other 1.2%