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