Go to file
Daniel Stone bea54b1f7d Add LICENSE to distributed files
Signed-off-by: Daniel Stone <daniels@collabora.com>
2016-03-31 16:43:58 +01:00
bench test: assert/ignore some warn_unused_result's 2016-03-15 20:45:05 +02:00
doc doc: Fix Doxygen include for srcdir != builddir 2016-03-15 11:21:29 +00:00
m4 Remove m4/.gitkeep 2014-02-08 22:44:59 +02:00
src src/utils: check if fileno() failed in map_file 2016-03-13 20:24:44 +02:00
test test: assert/ignore some warn_unused_result's 2016-03-15 20:45:05 +02:00
xkbcommon doc: update reference to compat symbol to its new name 2016-03-26 01:56:03 +03:00
.autom4te.cfg build: use build-aux as autom4te cache directory 2013-08-15 09:58:50 +03:00
.gitignore build: use build-aux as autom4te cache directory 2013-08-15 09:58:50 +03:00
.travis.yml travis: remove --disable-x11 2016-03-15 20:16:29 +02:00
.uncrustify.cfg Run source tree through uncrustify 2012-07-17 10:20:15 +01:00
Android.mk Android.mk: Remove unnecessary for loop 2012-09-11 15:11:35 +01:00
LICENSE rename to LICENSE 2015-03-10 12:20:01 +00:00
Makefile.am Add LICENSE to distributed files 2016-03-31 16:43:58 +01:00
NEWS Bump version to 0.6.0 2016-03-16 10:20:49 +02:00
PACKAGING PACKAGING: fix confusing typo 2014-10-24 23:06:07 +03:00
README.md README: we also accepts patches through github 2014-10-18 15:06:16 +03:00
autogen.sh autogen: use --force instead of --symlink 2012-10-24 00:59:37 +11:00
configure.ac Bump version to 0.6.0 2016-03-16 10:20:49 +02:00
makekeys.py makekeys: mark keysym_names as static 2014-01-11 00:26:58 +02:00
xkbcommon-uninstalled.pc.in build: drop the include/ directory 2012-07-23 00:45:34 +03:00
xkbcommon-x11-uninstalled.pc.in x11: add XKB protocol keymap and state creation support 2014-02-02 11:16:40 +02: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 Add symbol versions forgotten in 0ce17ef3ea 2016-03-13 23:17:21 +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.

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: http://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 http://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.

Bugs are also welcome, and may be reported 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.