Go to file
Pierre Le Marre cfcc7922c2 xkbcli-compose: Simplify locale options
Current options to set the locale are convoluted:
- An explicit locale *must* be given, while a sane default would be
  to use the user environment.
- Then there are two options that were useful while testing locale
  handling: read environment variables or use `setlocale`. But the
  program has already called:
  ```
  setlocale(LC_ALL, "");
  ```
  so it turns out the two options lead to the same results.

Remove options `--locale-from-env` and `--locale-from-setlocale`
and make the locale default to the user environment.
2023-11-19 09:57:24 +01:00
.github/workflows ci: fix url in github release text 2023-10-08 23:55:38 +03:00
bench Compose: add iterator API 2023-09-26 09:02:45 +02:00
doc Doc: fix malformed links and some typos 2023-11-14 10:33:31 +01:00
fuzz README: use meson compile/test over ninja 2023-05-05 09:44:56 +10:00
include/xkbcommon Keysyms: Fix missing hpYdiaeresis 2023-10-06 09:37:40 +02:00
scripts Keysyms: Fix missing hpYdiaeresis 2023-10-06 09:37:40 +02:00
src xkbcli-compile-compose: Fix string result escaping 2023-11-19 09:57:24 +01:00
test xkbcli-compile-compose: Fix string result escaping 2023-11-19 09:57:24 +01:00
tools xkbcli-compose: Simplify locale options 2023-11-19 09:57:24 +01:00
.editorconfig .editorconfig: add .md config 2023-05-04 11:58:48 +03:00
.pre-commit-config.yaml Add support for pre-commit 2023-09-29 09:42:08 +02: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 Bump version to 1.6.0 2023-10-08 23:46:48 +03:00
PACKAGING PACKAGING: mention xkbcli 2020-08-30 21:59:30 +03:00
README.md Improve documentation 2023-05-13 22:05:23 +03:00
meson.build xkbcli: Promote compose to xkbcli-compile-compose 2023-11-19 09:57:24 +01:00
meson_options.txt Tools: Add bash completions for xkbcli 2023-10-05 06:24:02 +02:00
xkbcommon-x11.map Use consistent indentation for map and CSS files 2023-05-04 11:58:48 +03:00
xkbcommon.map Compose: add iterator API 2023-09-26 09:02:45 +02: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 Introduction to XKB to learn the essentials of XKB.

See Quick Guide for an introduction on how to use this library.

Building

libxkbcommon is built with Meson:

meson setup build
meson compile -C build
meson test -C build # 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
meson compile -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.