Go to file
Ran Benita bac0c323b6 README: remove elaborate details from the intro
Point to the "quick guide" instead.

Signed-off-by: Ran Benita <ran234@gmail.com>
2014-10-18 15:05:30 +03:00
bench bench/compose: add new benchmark 2014-10-05 12:56:46 +03:00
doc doc/compat.md: we don't support more groups or mods yet 2014-10-18 15:05:30 +03:00
m4 Remove m4/.gitkeep 2014-02-08 22:44:59 +02:00
src Replace some strncmp's with memcmp 2014-10-18 13:23:53 +03:00
test test/keyseq: test 'map[None] = Level2;' scenario 2014-10-17 01:19:22 +03:00
xkbcommon compose: add xkbcommon-compose - API 2014-10-03 00:15:39 +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 Add .travis.yml file 2014-04-06 17:20:04 +03: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
COPYING COPYING: add copyright notice from libX11:modules/im/ximcp/imLcPrs.c 2014-10-13 18:54:52 +03:00
Makefile.am README: move compatibility notes to their own page 2014-10-18 15:05:30 +03:00
NEWS Update NEWS 2014-08-19 20:17:16 +03:00
README.md README: remove elaborate details from the intro 2014-10-18 15:05:30 +03:00
autogen.sh autogen: use --force instead of --symlink 2012-10-24 00:59:37 +11:00
configure.ac disable -Wl,--no-undefined on OpenBSD for it doesn't have DT_NEEDED for libc 2014-10-16 11:35:18 +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 build: use symbol versioning 2014-09-10 18:52:13 +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 compose: add xkbcommon-compose - implementation 2014-10-05 12:56:46 +03: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 keymap compiler and support library which processes a reduced subset of keymaps as defined by the XKB specification.

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

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

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.