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