kc3-lang/libxkbcommon/README.md

Branch : - branch - android master - tag -

• Show log

  Commit

• Author : Pierre Le Marre
  Date : 2025-02-05 11:47:56
  Hash : b5cde5c1
  Message : doc: Improve README

• 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 *registry* 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/):
  
  ```bash
  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:
  
  ```bash
  meson setup build \
      -Denable-x11=false \
      -Dxkb-config-root=/usr/share/X11/xkb \
      -Dx-locale-root=/usr/share/X11/locale
  meson compile -C build
  ```
  
  <details>
  <summary>Complete list of user options</summary>
  @include meson_options.txt
  </details>
  
  ## 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 keyboard layout 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.  Further information
  on xkeyboard-config is available at its [homepage][xkeyboard-config-home] and at
  its [repository][xkeyboard-config-repo].
  
  The dataset for *Compose* is distributed in [libX11], as part of the X locale
  data.
  
  [xkeyboard-config-home]: https://www.freedesktop.org/wiki/Software/XKeyboardConfig
  [xkeyboard-config-repo]: https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config
  [libX11]: https://gitlab.freedesktop.org/xorg/lib/libx11
  
  ## 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
  <xorg-devel@lists.x.org> or <wayland-devel@lists.freedesktop.org>
  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](mailto:daniel@fooishbar.org)
  - [Ran Benita](mailto:ran@unusedvar.com)
  - [Pierre Le Marre](mailto:dev@wismill.eu)
  
  ## Credits
  
  Many thanks are due to Dan Nicholson for his heroic work in getting xkbcommon
  off the ground initially.