StreetLight
/
libxkbcommon
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1,962 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
Ran Benita 534e54f621 test/data: add rule registry files 
Signed-off-by: Ran Benita <ran@unusedvar.com>
 		2020-09-07 11:47:34 +03:00
.github/workflows ci: fix windows job not finding bison 2020-08-31 15:28:38 +03:00
bench MSVC: Provide an implementation of gettimeofday() 2019-12-28 16:12:15 +02:00
doc doc: add some disclaimer regarding user-specific key types and compat entries 2020-08-30 21:49:41 +03:00
fuzz Open files in binary mode 2019-12-28 13:49:40 +02:00
scripts Only add GCC diagnostic pragmas when compiler is GCC compatible 2019-12-27 15:20:25 +02:00
src Add /etc/xkb as extra lookup path for system data files 2020-08-30 21:49:41 +03:00
test test/data: add rule registry files 2020-09-07 11:47:34 +03:00
tools xkbcli: fix interactive-x11 not showing in help 2020-09-05 23:41:38 +03:00
xkbcommon Bump version to 1.0.0 2020-09-06 00:00:14 +03: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.0.0 2020-09-06 00:00:14 +03:00
PACKAGING PACKAGING: mention xkbcli 2020-08-30 21:59:30 +03:00
README.md Add libxkbregistry to query available RMLVO 2020-07-06 15:15:20 +10:00
meson.build Bump version to 1.0.0 2020-09-06 00:00:14 +03:00
meson_options.txt Add /etc/xkb as extra lookup path for system data files 2020-08-30 21:49:41 +03: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

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.