Edit

kc3-lang/libxkbcommon

Branch :

  • Show log

    Commit

  • Author : Pierre Le Marre
    Date : 2025-08-16 12:59:20
    Hash : 135b3204
    Message : compose: Add fallback for custom locales Before this commit, loading a Compose file based on the locale would fail if the locale is not in the X11 Compose locale registry. While there are workarounds (e.g. `~/.XCompose` file or `$XCOMPOSEFILE`), it does not work if the corresponding file has `include "%L"`. This commit adds the fallback `en_US.UTF-8` in case the locale is installed but not registered in the X11 Compose locale registry. The choice is motivated by the fact that most locales use `en_US.UTF-8` anyway. Ideally we should have a mechanism to extend the Compose locale registry at the *system* level. Mechanisms at the user level (e.g. custom Compose file, environment variable) are deemed sufficient. We could still improve it by first trying to fallback to the locale without the country bits, but there is no function to do such function in the stdlib and we do not want to mess with locales manually. Unfortunately is not possible to test it in our test suite. One can still check it works following these instructions: 1. Create a custom locale, e.g. `en_XX.UTF-8`. `glibc-i18ndata` or similar package may be required to get the required files in `/usr/share/i18n/`. `sudo localedef -i en_US -f UTF-8 en_XX.UTF-8` 2. `xkbcli compile-compose --verbose --locale en_XX.UTF-8`

  • Properties
  • Git HTTP https://git.kmx.io/kc3-lang/libxkbcommon.git
    Git SSH git@git.kmx.io:kc3-lang/libxkbcommon.git
    Public ? true
    Name
    Description

    keymap handling library for toolkits and window systems
    Users
    -
    +     		thodg git_deploy kc3_lang_org thodg_l thodg_m thodg_w www_kmx_io
    Tags

  • 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, 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.