StreetLight
/
libxkbcommon
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1,835 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 fe417d841e test/common: avoid double // in path 
Signed-off-by: Ran Benita <ran@unusedvar.com>
 		2019-12-28 13:40:38 +02:00
.azure-pipelines/steps build: remove autotools build 2019-08-10 20:20:36 +03:00
bench build: include config.h manually 2019-12-27 13:09:11 +02:00
doc build: make doxygen run from the source tree 2017-08-01 23:32:15 +03:00
fuzz build: include config.h manually 2019-12-27 13:09:11 +02:00
scripts Only add GCC diagnostic pragmas when compiler is GCC compatible 2019-12-27 15:20:25 +02:00
src xkbcomp: remove cast which triggers warning on gcc 2019-12-27 22:09:34 +02:00
test test/common: avoid double // in path 2019-12-28 13:40:38 +02:00
xkbcommon Only add GCC diagnostic pragmas when compiler is GCC compatible 2019-12-27 15:20:25 +02: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 Bump version to 0.9.1 2019-10-20 23:07:52 +03:00
PACKAGING meson.build: Take win_bison as a possible variant for Bison 2019-12-27 13:21:34 +02:00
README.md README: update my email address 2019-10-19 00:55:21 +03:00
azure-pipelines.yml build: remove autotools build 2019-08-10 20:20:36 +03:00
meson.build meson.build: Take win_bison as a possible variant for Bison 2019-12-27 13:21:34 +02: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.