ed57fb8b86
This is the base tool, no subtools are currently connected so you only get help and version for now. The goal here is to have a git-like infrastructure where /usr/bin/xkbcli is the main tool, anything else will hide in libexec. The infrastructure for this is copied from libinput. Tools themselves will will be installed in $prefix/libexec/xkbcommon and the xkbcli tool forks off whatever argv[1] is after modifying the PATH to include the libexec dir. libinput has additional code for checking whether we're running this from the builddir but it's a bit iffy and it's usefulness is limited - if you're in the builddir anyway you can just run ./builddir/xkbcli-<toolname> directly. So for this code here, running ./builddir/xkbcli <toolname> will execute the one in the prefix/libexecdir. Since we want that tool available everywhere even where some of the subtools aren't present, we need to ifdef the getopt handling. man page generation is handled via ronn which is a ruby program but allows markdown for the sources. It's hidden behind a meson option to disable where downloading ronn isn't an option. The setup is generic enough that we can add other man-pages by just appending to the array. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> |
||
|---|---|---|
| .github/workflows | ||
| bench | ||
| doc | ||
| fuzz | ||
| scripts | ||
| src | ||
| test | ||
| tools | ||
| xkbcommon | ||
| .editorconfig | ||
| .uncrustify.cfg | ||
| LICENSE | ||
| NEWS | ||
| PACKAGING | ||
| README.md | ||
| meson.build | ||
| meson_options.txt | ||
| xkbcommon-x11.map | ||
| xkbcommon-x11.pc.in | ||
| xkbcommon.map | ||
| xkbcommon.pc.in | ||
| xkbregistry.map | ||
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
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
- Daniel Stone daniel@fooishbar.org
- Ran Benita ran@unusedvar.com
Credits
Many thanks are due to Dan Nicholson for his heroic work in getting xkbcommon off the ground initially.