Go to file
Ran Benita 25cd67daf7 build: remove autotools build
We introduced meson 2 years ago, hopefully that's was enough time for
everyone to convert.

Signed-off-by: Ran Benita <ran@unusedvar.com>
2019-08-10 20:20:36 +03:00
.azure-pipelines/steps build: remove autotools build 2019-08-10 20:20:36 +03:00
bench bench: simplify the bench helpers 2018-07-05 18:29:39 +03:00
doc build: make doxygen run from the source tree 2017-08-01 23:32:15 +03:00
fuzz Add fuzzing infrastructure 2018-07-30 10:35:10 +03:00
scripts CI: Publish test results from Meson 2019-08-09 23:01:27 +03:00
src Use bitwise test instead of popcount to check if one bit is set 2019-06-10 11:15:55 -07:00
test travis: improve configuration and add macOS 2019-07-25 14:34:17 +03:00
xkbcommon Fix some doc typos 2019-06-04 23:44:42 +02:00
.autom4te.cfg build: use build-aux as autom4te cache directory 2013-08-15 09:58:50 +03:00
.gitignore build: add meson build system 2017-07-31 20:53:39 +03: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 Update NEWS 2019-02-22 22:26:11 +02:00
PACKAGING README,PACKAGING: use the new meson unified command format 2017-12-15 16:18:14 +02:00
README.md README: usage questions are alright 2019-02-26 18:32:32 +02:00
azure-pipelines.yml build: remove autotools build 2019-08-10 20:20:36 +03:00
meson.build test/symbols-leak-test: make it work with macOS diff 2019-07-25 13:24:00 +03:00
meson_options.txt build: add meson build system 2017-07-31 20:53:39 +03:00
xkbcommon-x11.map Change initial symbol file versions to V_0.5.0 2014-10-18 16:40:59 +03:00
xkbcommon-x11.pc.in x11: add XKB protocol keymap and state creation support 2014-02-02 11:16:40 +02:00
xkbcommon.map keysym: add xkb_keysym_to_{lower,upper} to public API 2017-12-11 23:01:18 +02:00
xkbcommon.pc.in Remove xproto and kbproto from pkg-config file 2012-04-09 14:04:25 +01: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.

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.