StreetLight
/
libxkbcommon
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2,128 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
Pierre Le Marre 536cf42704 .editorconfig: add .md config 
Signed-off-by: Ran Benita <ran@unusedvar.com>
 		2023-05-04 11:58:48 +03:00
.github/workflows ci: don't run linux on push to non-master branches 2022-12-16 21:36:13 +02:00
bench Possible fix for non-MSVC windows compilers 2023-04-11 23:29:25 +03:00
doc Use consistent indentation for map and CSS files 2023-05-04 11:58:48 +03:00
fuzz ignore: remove no longer relevant gitignore files 2021-05-22 19:51:02 +03:00
include/xkbcommon Improve the doc of the XKB keymap text format, V1 (#321) 2023-04-30 22:30:36 +03:00
scripts Improve the doc of the XKB keymap text format, V1 (#321) 2023-04-30 22:30:36 +03:00
src registry: remove a few asprintf/free() calls with snprintf 2023-05-04 18:46:16 +10:00
test Add support for modmap None (#291) 2023-05-01 23:30:41 +03:00
tools Possible fix for non-MSVC windows compilers 2023-04-11 23:29:25 +03:00
.editorconfig .editorconfig: add .md config 2023-05-04 11:58:48 +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 NEWS: add "New API" section for last release 2023-01-02 21:36:03 +02:00
PACKAGING PACKAGING: mention xkbcli 2020-08-30 21:59:30 +03:00
README.md Update README.md 2022-01-11 16:49:22 +02:00
meson.build meson.build: register libxkbcommon.dylib link 2023-05-04 10:17:22 +10:00
meson_options.txt build: add enable-tools option 2021-12-05 12:55:51 +02:00
xkbcommon-x11.map Use consistent indentation for map and CSS files 2023-05-04 11:58:48 +03:00
xkbcommon.map Use consistent indentation for map and CSS files 2023-05-04 11:58:48 +03:00
xkbregistry.map Use consistent indentation for map and CSS files 2023-05-04 11:58:48 +03: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 and a separate library for listing available keyboard layouts.

Quick Guide

See Quick Guide.

Building

libxkbcommon is built with Meson:

meson setup build
ninja -C build
ninja -C build test  # Run the tests.

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.