StreetLight
/
libxkbcommon
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2,085 Commits
1 Branch
0 Tags
7.2 MiB
C 87.9%
Zig 5%
Python 3.2%
Meson 1.5%
Yacc 1.4%
Other 1%
 
 
 
 
 
 
Go to file
M Hickford 9bbe629aad Update README.md 
Co-authored-by: Ran Benita <ran@unusedvar.com>
 		2022-01-11 16:49:22 +02:00
.github/workflows ci: possible fix for release workflow 2021-09-17 00:00:11 +03: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 xkbcommon: deprecate XK_approxeq and XK_notapproxeq 2021-05-22 19:36:22 +03:00
scripts scripts/update-keysyms: fix path to the include files after de1b6943d 2021-05-14 08:45:03 +10:00
src x11: try to fix crash in xkb_x11_keymap_new_from_device error handling 2021-09-09 16:52:47 +03:00
test test/tool-option-parsing: don't depend on build prefix 2021-05-22 20:11:10 +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.3.1 2021-09-10 22:51:34 +03: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 build: add enable-tools option 2021-12-05 12:55:51 +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.