Go to file
Weng Xuetian b064b60984 Do not clear sibling entries when override.
lokid and hikid actually stores the sibling to current node, which
should not be cleared when override. This would break the sequence with
a common prefix when override another.

Fix #286

Signed-off-by: Weng Xuetian <wengxt@gmail.com>
2022-05-15 10:07:57 +03:00
.github/workflows ci/linux: bring back `apt update` to fix `apt install` 404s 2022-03-20 13:51:14 +02:00
bench bench/compose: fix compose file path 2021-06-10 17:13:57 +03:00
doc ignore: remove no longer relevant gitignore files 2021-05-22 19:51:02 +03:00
fuzz ignore: remove no longer relevant gitignore files 2021-05-22 19:51:02 +03:00
include/xkbcommon Improve misleading comments #270 2022-02-24 12:43:20 +02:00
scripts scripts/update-keysyms: fix path to the include files after de1b6943d 2021-05-14 08:45:03 +10:00
src Do not clear sibling entries when override. 2022-05-15 10:07:57 +03:00
test Do not clear sibling entries when override. 2022-05-15 10:07:57 +03:00
tools tools/list: print an empty string for null vendor strings 2021-11-11 08:26:36 +10:00
.editorconfig Add an editorconfig file 2020-06-02 06:46:21 +10:00
.uncrustify.cfg Run source tree through uncrustify 2012-07-17 10:20:15 +01:00
LICENSE test: Add interactive-wayland 2016-04-12 12:15:04 +01:00
NEWS Bump version to 1.4.0 2022-02-04 12:41:50 +02:00
PACKAGING PACKAGING: mention xkbcli 2020-08-30 21:59:30 +03:00
README.md Update README.md 2022-01-11 16:49:22 +02:00
meson.build Bump version to 1.4.0 2022-02-04 12:41:50 +02:00
meson_options.txt build: add enable-tools option 2021-12-05 12:55:51 +02:00
xkbcommon-x11.map Change initial symbol file versions to V_0.5.0 2014-10-18 16:40:59 +03:00
xkbcommon.map Bump version to 1.0.0 2020-09-06 00:00:14 +03:00
xkbregistry.map Bump version to 1.0.0 2020-09-06 00:00:14 +03:00

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

Quick Guide

See Quick Guide.

Building

libxkbcommon is built with Meson:

meson setup build
ninja -C build
ninja -C build test  # 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
ninja -C build

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.

Dataset

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.

Development

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

Credits

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