Go to file
Peter Hutterer 75ce741ab9 meson.build: manually link all sources into the library
This works around meson bug 3937, 'link_whole' arguments don't get added into
the final static library and we end up with a virtually empty 8-byte
libxkbcommon.a file, see https://github.com/mesonbuild/meson/issues/3937

Workaround is simply to add all sources to both libraries we need them in.
This obviously compiles them twice but this year's winter was cold and
bit of extra warmth will be appreciated.

Fixes #84

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2019-02-08 12:21:28 +10: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
m4 Remove m4/.gitkeep 2014-02-08 22:44:59 +02:00
scripts build: make doxygen run from the source tree 2017-08-01 23:32:15 +03:00
src Sync Keysyms with recent xproto additions 2019-01-22 08:31:43 +01:00
test test: allow for absolute paths to be resolved 2018-08-21 11:31:10 +10:00
xkbcommon docs: fix a doxygen reference warning 2019-01-28 16:29:09 +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
.travis.yml travis: pin meson to an older version so it works with Python 3.4 2018-06-23 23:17:07 +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
Makefile.am test: add a tool to test-compile all LVO combinations from xkeyboard-config 2018-08-21 11:30:45 +10:00
NEWS Update NEWS 2018-08-05 08:55:39 +03:00
PACKAGING README,PACKAGING: use the new meson unified command format 2017-12-15 16:18:14 +02:00
README.md Convert http:// -> https:// where possible 2017-12-21 14:18:07 +02:00
autogen.sh autogen: use --force instead of --symlink 2012-10-24 00:59:37 +11:00
configure.ac build: turn off strict aliasing 2018-08-18 15:12:57 +03:00
meson.build meson.build: manually link all sources into the library 2019-02-08 12:21:28 +10: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 through github.

Bug reports are also welcome, and may be filed either at Bugzilla https://bugs.freedesktop.org/describecomponents.cgi?product=libxkbcommon or Github https://github.com/xkbcommon/libxkbcommon/issues

The maintainers are

Credits

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