README.md

   1 # libxkbcommon
   2
   3 libxkbcommon is a keyboard keymap compiler and support library which
   4 processes a reduced subset of keymaps as defined by the XKB (X Keyboard
   5 Extension) specification.  It also contains a module for handling Compose
   6 and dead keys and a separate library for listing available keyboard layouts.
   7
   8 ## Quick Guide
   9
  10 See [Quick Guide](doc/quick-guide.md).
  11
  12 ## Building
  13
  14 libxkbcommon is built with [Meson](http://mesonbuild.com/):
  15
  16     meson setup build
  17     ninja -C build
  18     ninja -C build test  # Run the tests.
  19
  20 To build for use with Wayland, you can disable X11 support while still
  21 using the X11 keyboard configuration resource files thusly:
  22
  23     meson setup build \
  24         -Denable-x11=false \
  25         -Dxkb-config-root=/usr/share/X11/xkb \
  26         -Dx-locale-root=/usr/share/X11/locale
  27     ninja -C build
  28
  29 ## API
  30
  31 While libxkbcommon's API is somewhat derived from the classic XKB API as found
  32 in X11/extensions/XKB.h and friends, it has been substantially reworked to
  33 expose fewer internal details to clients.
  34
  35 See the [API Documentation](https://xkbcommon.org/doc/current/modules.html).
  36
  37 ## Dataset
  38
  39 libxkbcommon does not distribute a keymap dataset itself, other than for
  40 testing purposes.  The most common dataset is xkeyboard-config, which is used
  41 by all current distributions for their X11 XKB data.  More information on
  42 xkeyboard-config is available here:
  43     https://www.freedesktop.org/wiki/Software/XKeyboardConfig
  44
  45 The dataset for Compose is distributed in libX11, as part of the X locale
  46 data.
  47
  48 ## Relation to X11
  49
  50 See [Compatibility](doc/compat.md) notes.
  51
  52 ## Development
  53
  54 An extremely rudimentary homepage can be found at
  55     https://xkbcommon.org
  56
  57 xkbcommon is maintained in git at
  58     https://github.com/xkbcommon/libxkbcommon
  59
  60 Patches are always welcome, and may be sent to either
  61     <xorg-devel@lists.x.org> or <wayland-devel@lists.freedesktop.org>
  62 or in a [GitHub](https://github.com/xkbcommon/libxkbcommon) pull request.
  63
  64 Bug reports (and usage questions) are also welcome, and may be filed at
  65 [GitHub](https://github.com/xkbcommon/libxkbcommon/issues).
  66
  67 The maintainers are
  68 - Daniel Stone <daniel@fooishbar.org>
  69 - Ran Benita <ran@unusedvar.com>
  70
  71 ## Credits
  72
  73 Many thanks are due to Dan Nicholson for his heroic work in getting xkbcommon
  74 off the ground initially.