kc3-lang/libxkbcommon/README.md
-
Show log
Commit
-
Hash : 494a8fbf
Author :
Date : 2014-10-18T13:50:54
README: move compatibility notes to their own page Signed-off-by: Ran Benita <ran234@gmail.com>
libxkbcommon
xkbcommon is a keymap compiler and support library which processes a reduced subset of keymaps as defined by the XKB specification. Primarily, a keymap is created from a set of Rules/Model/Layout/Variant/Options names, processed through an XKB ruleset, and compiled into a struct xkb_keymap, which is the base type for all xkbcommon operations.
From an xkb_keymap, an xkb_state object is created which holds the current state of all modifiers, groups, LEDs, etc, relating to that keymap. All key events must be fed into the xkb_state object using xkb_state_update_key(). Once this is done, the xkb_state object will be properly updated, and the keysyms to use can be obtained with xkb_state_key_get_syms().
Quick Guide
See Quick Guide.
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.
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:
http://www.freedesktop.org/wiki/Software/XKeyboardConfigRelation to X11
See Compatibility notes.
Development
An extremely rudimentary homepage can be found at
http://xkbcommon.orgxkbcommon is maintained in git at
https://github.com/xkbcommon/libxkbcommonPatches are always welcome, and may be sent to either
<xorg-devel@lists.x.org> or <wayland-devel@lists.freedesktop.org>Bugs are also welcome, and may be reported either at
Bugzilla https://bugs.freedesktop.org/describecomponents.cgi?product=libxkbcommonor
Github https://github.com/xkbcommon/libxkbcommon/issuesThe maintainers are
- Daniel Stone daniel@fooishbar.org
- Ran Benita ran234@gmail.com
Credits
Many thanks are due to Dan Nicholson for his heroic work in getting xkbcommon off the ground initially.
Source
-
README.md
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
# libxkbcommon xkbcommon is a keymap compiler and support library which processes a reduced subset of keymaps as defined by the XKB specification. Primarily, a keymap is created from a set of Rules/Model/Layout/Variant/Options names, processed through an XKB ruleset, and compiled into a struct xkb_keymap, which is the base type for all xkbcommon operations. From an xkb_keymap, an xkb_state object is created which holds the current state of all modifiers, groups, LEDs, etc, relating to that keymap. All key events must be fed into the xkb_state object using xkb_state_update_key(). Once this is done, the xkb_state object will be properly updated, and the keysyms to use can be obtained with xkb_state_key_get_syms(). ## Quick Guide See [Quick Guide](doc/quick-guide.md). ## 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](http://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: http://www.freedesktop.org/wiki/Software/XKeyboardConfig ## Relation to X11 See [Compatibility](doc/compat.md) notes. ## Development An extremely rudimentary homepage can be found at http://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> Bugs are also welcome, and may be reported either at Bugzilla https://bugs.freedesktop.org/describecomponents.cgi?product=libxkbcommon or Github https://github.com/xkbcommon/libxkbcommon/issues The maintainers are - Daniel Stone <daniel@fooishbar.org> - Ran Benita <ran234@gmail.com> ## Credits Many thanks are due to Dan Nicholson for his heroic work in getting xkbcommon off the ground initially.