https://github.com/xkbcommon/libxkbcommon

keymap handling library for toolkits and window systems
https://github.com/xkbcommon/libxkbcommon

Last synced: 18 days ago
JSON representation

keymap handling library for toolkits and window systems

• Host: GitHub
• URL: https://github.com/xkbcommon/libxkbcommon
• Owner: xkbcommon
• License: other
• Created: 2013-04-01T17:31:10.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-09-16T14:31:38.000Z (about 2 months ago)
• Last Synced: 2024-09-16T17:12:46.478Z (about 2 months ago)
• Language: C
• Homepage: https://xkbcommon.org
• Size: 6.43 MB
• Stars: 278
• Watchers: 17
• Forks: 123
• Open Issues: 48
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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.

[XKB]: doc/introduction-to-xkb.md

## Quick Guide

- [Introduction to XKB][XKB]: to learn the essentials of XKB.

- [User-configuration](doc/user-configuration.md): instructions to add

  a *custom layout* or option.

- [Quick Guide](doc/quick-guide.md): introduction on how to use this library.

## Building

libxkbcommon is built with [Meson](http://mesonbuild.com/):

    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](https://xkbcommon.org/doc/current/modules.html).

## 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](doc/compatibility.md) 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

     or 

or in a [GitHub](https://github.com/xkbcommon/libxkbcommon) pull request.

Bug reports (and usage questions) are also welcome, and may be filed at

[GitHub](https://github.com/xkbcommon/libxkbcommon/issues).

The maintainers are

- Daniel Stone 

- Ran Benita 

## Credits

Many thanks are due to Dan Nicholson for his heroic work in getting xkbcommon

off the ground initially.