libxkbcommon
1.10.0
LibraryimplementingtheXKBspecificationforparsingkeyboarddescriptionsandhandlingkeyboardstate
|
{html:2}
See: ./introduction-to-xkb.md "Introduction to XKB".
See: terminology.
The xkbcommon project does not provide keyboard layouts. See the xkeyboard-config project for further information.
See this issue.
There could be many reasons!
libxkbcommon may not be able to load your configuration due to an issue (file not found, syntax error, unsupported keysym, etc.). Please use our ./debugging.md "debugging tools" to get further information.
Note that the xkbcommon project does not provide keyboard layouts. See the xkeyboard-config project for further information.
This is most probably an issue with your Compose configuration. If you customized it, do not forget to restart your session before trying it.
Please use our ./debugging.md "debugging tools" with the option --enable-compose
to get further information.
This project does not provide any keyboard layout database:
See also the ./keymap-format-text-v1.md "keymap text format" documentation for the syntax.
Use our ./debugging.md "debugging tools".
🚧 TODO
xmodmap -pm
There is no strict equivalent. Since 1.10 xkbcli compile-keymap
has the option --modmaps
to print the modifiers maps from a keymap, but it does not print keysyms. In order to get the output for the current keymap, use it with xkbcli dump-keymap-*
:
xmodmap -e "…"
xmodmap /path/to/file
xkbcli
does not modify the display server keymap. setxkbmap -print -layout …
Since 1.9 one can use the --kccgst
option:
setxkbmap -query
No equivalent: xkbcli
only query raw keymaps and has no access to the original RMLVO settings.
setxkbmap -layout …
No equivalent: xkbcli
does not modify the display server keymap. One must use the tools specific to each display server in order order to achieve it.
If you use a custom layout, please have a look at User-configuration, which enables making custom layouts discoverable by keyboard configuration GUI.
xkbcomp -xkb /path/to/keymap/file -
xkbcomp -xkb $DISPLAY -
xkbcomp - $DISPLAY
xkbcomp /path/to/keymap/file $DISPLAY
No equivalent: xkbcli
does not modify the display server keymap. One must use the tools specific to each display server in order order to achieve it. Please have a look at User-configuration, which enables making custom layouts discoverable by keyboard configuration GUI.
The virtual modifiers mappings to real modifiers is an implementation detail. However, some applications may require it in order to interface with legacy code.
Use the dedicated function xkb_keymap::xkb_keymap_mod_get_mask()
.
Use the following snippet:
``c // Find the real modifier mapping of the virtual modifier
LevelThree` #include <xkbcommon/xkbcommon-names.h> const xkb_mod_index_t levelThree_idx = xkb_keymap_mod_get_index(keymap, XKB_VMOD_NAME_LEVEL3); const xkb_mod_mask_t levelThree = UINT32_C(1) << levelThree_idx; struct xkb_state* state = xkb_state_new(keymap); assert(state); // Please handle error properly xkb_state_update_mask(state, levelThree, 0, 0, 0, 0, 0); const xkb_mod_mask_t levelThree_mapping = xkb_state_serialize_mods(state, XKB_STATE_MODS_EFFECTIVE); xkb_state_unref(state); ```