libxkbcommon 1.13.2 Library implementing the XKB specification for parsing keyboard descriptions and handling keyboard state

Loading...
Searching...
No Matches
Release notes

# libxkbcommon 1.13.2 – 2026-05-30

# API

## New

- Updated keysyms from latest xorgproto (commit: fcb7e9a1a0b593a44740d83b0babddd331fea830):
  - Added:
    - XKB_KEY_dead_apostrophe (xorgproto-110)
    - XKB_KEY_SSHARP (xorgproto-110)
    - XKB_KEY_leftsingleanglequotemark (xorgproto-110)
    - XKB_KEY_rightsingleanglequotemark (xorgproto-110)
    - XKB_KEY_XF86ElectronicPrivacyScreenOn (xorgproto-109)
    - XKB_KEY_XF86ElectronicPrivacyScreenOff (xorgproto-109)
    - XKB_KEY_XF86ActionOnSelection (xorgproto-112)
    - XKB_KEY_XF86ContextualInsert (xorgproto-112)
    - XKB_KEY_XF86ContextualQuery (xorgproto-112)
  - Changed:
    - ISO_Group_Shift is now the canonical name of the corresponding keysym. Previously it was Mode_switch, which refers to a core X group mechanism obsoleted by XKB.
- Added keysyms UTF translations for numeric phone keys XF86Numeric[0-9].

## Fixes

- Fixed include statement of default section, possibly broken in some custom configurations.

# Tools

## New

- Added new tool xkbcli info to print information about libxkbcommon configuration, for debugging purposes.

# Build system

## Breaking changes

- Raised minimal meson version requirement to 1.4.0. (#954)

# libxkbcommon 1.13.1 – 2025-12-03

## API

### Fixes

- Fixed segfault triggering in unlikely setups. (#934)

# libxkbcommon 1.13.0 – 2025-11-05

The highlight of this release is the introduction of the XKB extensions directories, a new mechanism to facilitate keyboard layout packaging and distribution. See Packaging keyboard layouts for further details.

## API

### Breaking changes

- context: The default include paths initialization is delayed until required.

  This is more efficient for clients that only get the keymap from the server and thus do not need to look up any XKB files.

  It also fixes the issue of containerized apps that lack access to XKB directories.

  This is marked as a breaking change, because changing environment variables relevant to include paths between the call to xkb_context_new() and any function requiring the default path initialization — e.g. xkb_keymap_new_from_names() — will have a different behavior than previous xkbcommon versions. However this situation is deemed unlikely.

### New

- Added keysyms from latest xorgproto (commit: f973f7db89571f61e96cb0a55f416d3e67a75663, xorproto-102):
  - XKB_KEY_XF86MediaPlayPause
  - XKB_KEY_XF86Exit
  - XKB_KEY_XF86AudioBassBoost

- Added the XKB extensions directories, a new mechanism to facilitate keyboard layout packaging and distribution.

  See Packaging keyboard layouts for further details.

- rules: Added lightweight composition of rules files: for a given ruleset <ruleset>, the optional files <ruleset>.pre and <ruleset>.post of each include path are respectively prepended and appended to the main rules file.

  The resulting rule set is equivalent to:

  ! include <include path 1>/rules/<ruleset>.pre // only if defined
  …
  ! include <include path n>/rules/<ruleset>.pre // only if defined
  ! include <ruleset> // main rules file
  ! include <include path 1>/rules/<ruleset>.post // only if defined
  …
  ! include <include path n>/rules/<ruleset>.post // only if defined

  See RMLVO resolution process for further details.

## Tools

### Fixes

- xkbcli how-to-type: Fixed Compose lookup when the entry keysym is not canonical. (#904)

## Build system

### New

- Added the following meson options:

  - xkb-config-unversioned-extensions-path
  - xkb-config-versioned-extensions-path

  See Packaging keyboard layouts for further details.

- Added the following variables to the pkg-config file, in order to expose the default XKB system directories:

  - xkb_root
  - xkb_unversioned_extensions_path
  - xkb_versioned_extensions_path
  - xkb_extra_path

  See Packaging keyboard layouts for further details.

# libxkbcommon 1.12.4 – 2025-12-03

## API

### Fixes

- Fixed segfault triggering in unlikely setups. (#934)

# libxkbcommon 1.12.3 – 2025-10-29

## API

### Fixes

- X11: Hardened against some malformed XKB responses with erroneous modifiers or LEDs counts.

## Tools

### Fixes

- Fixed support for Windows compilers other than MSVC (#897, #898, #899).

  Contributed by Rosen Penev

- Fixed errors in Wayland tools (#900).

  Contributed by Ronan Pigott

## Build system

### Fixes

- Fixed build setup failing in cross-compiling setups where the build machine cannot run the host binaries (#885).

# libxkbcommon 1.12.2 – 2025-10-20

## API

### Fixes

- Context: Added fallback to the legacy X11 path for misconfigured setups where the canonical XKB root is not available.

  Some setups use the assumption that the canonical XKB root is always the legacy X11 one, but this is no longer true since xkeyboard-config 2.45, where the X11 path is now a mere symlink to a dedicated xkeyboard-config data directory (usually /usr/share/xkeyboard-config-2).

- Compose: Fixed some C standard libraries such as musl not detecting missing locales. (#879)

# libxkbcommon 1.12.1 – 2025-10-17

## API

### Fixes

- X11: Added a fix to circumvent libX11 and xserver improperly handling missing XKB canonical key types. The fix prevents triggering an error when retrieving such keymap using libxkbcommon-x11.

## Tools

### Fixes

- xkbcli interactive-wayland: memory error triggering in some setups.

  Contributed by Jan Alexander Steffens

# libxkbcommon 1.12.0 – 2025-10-10

The highlight of this release is the performance improvements for keymap handling:

- about 1.6× speedup at serializing with default options;
- about 1.7× speedup at parsing keymaps serialized by libxkbcommon, otherwise at least 1.1×.

## API

### Breaking changes

- xkb_keymap::xkb_keymap_get_as_string() does not pretty-print the keymap anymore. Use xkb_keymap::xkb_keymap_get_as_string2() with XKB_KEYMAP_SERIALIZE_PRETTY to get the previous behavior. (#640)
- xkb_keymap::xkb_keymap_get_as_string() does not serialize unused types and compatibility entries anymore. Use xkb_keymap::xkb_keymap_get_as_string2() with XKB_KEYMAP_SERIALIZE_KEEP_UNUSED to get the previous behavior. (#769)
- Updated keysyms case mappings to cover full Unicode 17.0.

### Deprecated

- Deprecated keysyms from latest xorgproto (commit: 81931cc0fd4761b42603f7da7d4f50fc282cecc6, xorproto-103):
  - XKB_KEY_XF86BrightnessAuto (use XKB_KEY_XF86MonBrightnessAuto instead)

### New

- Added xkb_keymap::xkb_keymap_get_as_string2(), which enables to configure the serialization.
- Added keysyms from latest xorgproto (commit: 81931cc0fd4761b42603f7da7d4f50fc282cecc6, xorproto-103):
  - XKB_KEY_XF86Sport
  - XKB_KEY_XF86MonBrightnessAuto (alias for XKB_KEY_XF86BrightnessAuto)
  - XKB_KEY_XF86LinkPhone
  - XKB_KEY_XF86Fn_F1
  - XKB_KEY_XF86Fn_F2
  - XKB_KEY_XF86Fn_F3
  - XKB_KEY_XF86Fn_F4
  - XKB_KEY_XF86Fn_F5
  - XKB_KEY_XF86Fn_F6
  - XKB_KEY_XF86Fn_F7
  - XKB_KEY_XF86Fn_F8
  - XKB_KEY_XF86Fn_F9
  - XKB_KEY_XF86Fn_F10
  - XKB_KEY_XF86Fn_F11
  - XKB_KEY_XF86Fn_F12
  - XKB_KEY_XF86Fn_1
  - XKB_KEY_XF86Fn_2
  - XKB_KEY_XF86Fn_D
  - XKB_KEY_XF86Fn_E
  - XKB_KEY_XF86Fn_F
  - XKB_KEY_XF86Fn_S
  - XKB_KEY_XF86Fn_B
  - XKB_KEY_XF86PerformanceMode
- Enable to parse the full range of keycodes 0 .. 0xfffffffe, which was previously limited to 0 .. 0xfff. (#849)
- Compose: Custom locales now fallback to en_US.UTF-8. Custom locales requiring a dedicated Compose file are not yet supported. The workaround is to use the various ways to specify a user Compose file.

## Tools

### New

- xkbcli {compile-keymap,dump-keymap*}: Added --no-pretty to disable pretty-printing in keymap serialization. (#640)
- xkbcli {compile-keymap,dump-keymap*}: Added --keep-unused to not discard unused bit for keymap serialization. (#769)
- xkbcli-compile-keymap: Added --kccgst-yaml to output KcCGST components in YAML format.

## Build system

### Breaking changes

- The default XKB root directory is now set from the most recent xkeyboard-config installed package, in case multiple versions are installed in parallel. If no such package is found, it fallbacks to the historical X11 directory, as previously.

# libxkbcommon 1.11.0 – 2025-08-08

The highlight of this release is the introduction of a new keymap text format, XKB_KEYMAP_FORMAT_TEXT_V2, in order to fix decade-old issues inherited from the X11 ecosystem. See the API section for documentation of its use.

## Keymap text format

### New

A new keymap text format v2 has been introduced as a superset of the legacy v1 format. The format is not yet frozen and considered a living standard, although future iterations should be backward-compatible. See the compatibility page for detailed information of the features of each format.

- Added the new parameter lockOnRelease for the key action LockGroup() (#420).

  It enables to use e.g. the combination Alt + Shift alone to switch layouts, while keeping the use of Alt + Shift + other key (typically for keyboard shortcuts).

  It enables to fix a 20-year old issue inherited from the X11 ecosystem, by extending the XKB protocol key actions.

  As it is incompatible with X11, this feature is available only using XKB_KEYMAP_FORMAT_TEXT_V2.

- Added the new parameter unlockOnPress for the key modifier action SetMods(), LatchMods() and LockMods() (#372 and #780).

  It enables e.g. to deactivate CapsLock on press rather than on release, as in other platforms such as Windows.

  It enables to fix the following two issues inherited from the X11 ecosystem, by extending the XKB protocol key actions:

  - a 18-year old issue;
  - a 12-year old issue.

  As it is incompatible with X11, this feature is available only using XKB_KEYMAP_FORMAT_TEXT_V2.

- Added the new parameter latchOnPress for the key action LatchMods().

  Some keyboard layouts use ISO_Level3_Latch or ISO_Level5_Latch to define “built-in” dead keys. latchOnPress enables to behave as usual dead keys, i.e. to latch on press and to deactivate as soon as another (non-modifier) key is pressed.

  As it is incompatible with X11, this feature is available only using XKB_KEYMAP_FORMAT_TEXT_V2.

- Raised the layout count limit from 4 to 32. Requires using XKB_KEYMAP_FORMAT_TEXT_V2. (#37)

  It enables to fix a 16-year old issue inherited from the X11 ecosystem.

- Virtual modifiers are now mapped to their canonical encoding if they are not mapped explicitly (virtual_modifiers M = …) nor implicitly (using modifier_map/virtualModifier).

  This feature is enabled only when using XKB_KEYMAP_FORMAT_TEXT_V2, as it may result in encodings not compatible with X11.

- Added support for the constants Level<INDEX> for any valid level index, instead of the previous limited range Level1..Level8.
- Enable to use absolute paths and %-expansion variables for including keymap components, in the same fashion than the rules files.

## Rules text format

### New

- Added support for layout-specific options. It enables specifying a layout index for each option by appending ! + 1-indexed layout, so that it applies only if the layout matches. (#500)

## API

### Breaking changes

- xkb_keymap_new_from_names() now uses the new keymap format XKB_KEYMAP_FORMAT_TEXT_V2.
- When using XKB_KEYMAP_FORMAT_TEXT_V1, multiple actions per level are now serialized using VoidAction(), in order to maintain compatibility with X11. (#793)

### Deprecated

- xkb_keymap_new_from_names() is now deprecated; please use xkb_keymap_new_from_names2() instead with an explicit keymap format.

### New

- Added the new keymap format XKB_KEYMAP_FORMAT_TEXT_V2, which enables libxkbcommon’s extensions incompatible with X11.

  Note that fallback mechanisms ensure that it is possible to parse using one format and serialize using another.

  Wayland compositors may use the new format to parse keymaps, but they must use the previous format XKB_KEYMAP_FORMAT_TEXT_V1 whenever serializing for interchange. Since almost features available only in the v2 format deal with state handling which is managed in the server, clients should not be affected by a v2-to-v1 conversion.

  Client applications should use the previous XKB_KEYMAP_FORMAT_TEXT_V1 to parse keymaps, at least for now. They may use XKB_KEYMAP_FORMAT_TEXT_V2 only if used with a Wayland compositor using the same version of libxkbcommon and serializing to the new format. This precaution will be necessary until the new format is stabilized.

- Added xkb_keymap_new_from_names2() as an alternative to xkb_keymap_new_from_names(), which is deprecated.
- Added xkb_keymap_new_from_rmlvo() to compile a keymap using the new RMLVO builder API.
- Added a API to safely build a RMLVO configuration:
  - xkb_rmlvo_builder_new()
  - xkb_rmlvo_builder_append_layout()
  - xkb_rmlvo_builder_append_option()
  - xkb_rmlvo_builder_ref()
  - xkb_rmlvo_builder_unref()
- Added xkb_keymap_mod_get_mask2() to query the mapping of a modifier by its index rather than it name.

- Update keysyms using latest xorgproto (commit: ce7786ebb90f70897f8038d02ae187ab22766ab2).

  Additions (xorgproto-93):

  - XKB_KEY_XF86MediaSelectCD (alias for XKB_KEY_XF86CD)
  - XKB_KEY_XF86OK
  - XKB_KEY_XF86GoTo
  - XKB_KEY_XF86VendorLogo
  - XKB_KEY_XF86MediaSelectProgramGuide
  - XKB_KEY_XF86MediaSelectHome
  - XKB_KEY_XF86MediaLanguageMenu
  - XKB_KEY_XF86MediaTitleMenu
  - XKB_KEY_XF86AudioChannelMode
  - XKB_KEY_XF86MediaSelectPC
  - XKB_KEY_XF86MediaSelectTV
  - XKB_KEY_XF86MediaSelectCable
  - XKB_KEY_XF86MediaSelectVCR
  - XKB_KEY_XF86MediaSelectVCRPlus
  - XKB_KEY_XF86MediaSelectSatellite
  - XKB_KEY_XF86MediaSelectTape
  - XKB_KEY_XF86MediaSelectRadio
  - XKB_KEY_XF86MediaSelectTuner
  - XKB_KEY_XF86MediaPlayer
  - XKB_KEY_XF86MediaSelectTeletext
  - XKB_KEY_XF86MediaSelectDVD (alias for XKB_KEY_XF86DVD)
  - XKB_KEY_XF86MediaSelectAuxiliary
  - XKB_KEY_XF86MediaPlaySlow
  - XKB_KEY_XF86NumberEntryMode
- Registry: added rxkb_option_is_layout_specific() to query if an option accepts layout index specifiers to restrict its application to the corresponding layouts. (#500)

### Fixes

- Fixed incorrect implementation of latchToLock for LatchMods(), which could result in unintended CapsLock unlock. (#808)
- Fixed xkb_utf32_to_keysym() returning deprecated keysyms for some Unicode code points.
- Fixed breaking a latch not honoring clearLocks=no.

## Tools

### Breaking changes

- The tools now use:

  - XKB_KEYMAP_FORMAT_TEXT_V2 as a default input format.
  - XKB_KEYMAP_USE_ORIGINAL_FORMAT as a default output format. So if the input format is not specified, it will resolve to XKB_KEYMAP_FORMAT_TEXT_V2.

  The formats can be explicitly specified using the new --*format options.

### New

- Added --*format options to various tools for specifying and explicit keymap format for parsing and serializing.
- Added commands that automatically select the appropriate backend:
  - xkbcli interactive: try Wayland, X11 then fallback to the evdev backend.
  - xkbcli dump-keymap: try Wayland then fallback to the X11 backend.
- Improved xkbcli interactive-*:
  - Print key release events.
  - Print detailed state change events.
  - Added --uniline to enable uniline event output (default).
  - Added --multiline to enable multiline event output, which provides more details than the uniline mode.
  - Wayland and X11: Added --local-state to enable handling the keyboard state with a local state machine instead of the display server. (#832)
  - Wayland and X11: Added --Keymap Creation to enable to use a custom keymap instead of the keymap from the display server. Implies --local-state. (#833)
- xkbcli how-to-type: Added --Keymap Creation to enable loading the keymap from a file or stdin instead of resolving RMLVO names.
- xkbcli how-to-type: Added Compose support, enabled by default and disabled using --disable-compose. (#361)
- xkbcli-list: Added layout-specific field for options. (#500)
- Added --verbose to various tools, so that all tools have the option. (#833)

# libxkbcommon 1.10.0 – 2025-05-21

## API

### Breaking changes

- Modifiers masks handling has been refactored to properly handle virtual modifiers. Modifier masks are now always considered as an opaque encoding of the modifiers state:
  - Modifiers masks should not be interpreted by other means than the provided API. In particular, one should not assume that modifiers masks always denote the modifiers indices of the keymap.
  - It enables using virtual modifiers with arbitrary mappings. E.g. one can now reliably create virtual modifiers without relying on the legacy X11 mechanism, that requires a careful use of keys’ real and virtual modmaps.
  - It enables interoperability with further implementations of XKB.

- Changed Compose behavior so that sequences defined later always override ones defined earlier, even if the new sequence is shorter.

  Contributed by Jules Bertholet

### Deprecated

- Server applications using xkb_state_update_mask() should migrate to using xkb_state_update_latched_locked() instead, for proper handling of the keyboard state. (#310)

- The following modifiers names in xkbcommon/xkbcommon-names.h are now deprecated and will be removed in a future version:

  - XKB_MOD_NAME_ALT: use XKB_VMOD_NAME_ALT instead.
  - XKB_MOD_NAME_LOGO: use XKB_VMOD_NAME_SUPER instead.
  - XKB_MOD_NAME_NUM: use XKB_VMOD_NAME_NUM instead.

  (#538)

### New

- Added xkb_state_update_latched_locked() to update the keyboard state to change the latched and locked state of the modifiers and layout.

  This entry point is intended for server applications and should not be used by client applications. This can be use for e.g. a GUI layout switcher. (#310)

- Added xkb_keymap_mod_get_mask() to query the mapping of a modifier.

- Added VoidAction() action to match the keysym pair NoSymbol/VoidSymbol. It enables erasing a previous action and breaks latches.

  This is a libxkbcommon extension. When serializing it will be converted to LockControls(controls=none,affect=neither) for backward compatibility. (#622)

- Improved syntax errors in XKB files to include the expected/got tokens. (#644)

### Fixes

- Compose: fixed sequence not fully overriden if the new sequence has no keysym or string.

## Tools

### New

- xkbcli-compile-keymap: Added option --modmaps that prints modifiers mappings. This is similar to the legacy xmodmap -pm.

## Build system

### Breaking changes

- Removed support for byacc – use bison instead. (#644)
- Required bison ≥ 3.6.

# libxkbcommon 1.9.2 – 2025-05-07

## API

### Fixes

- Fixed empty compatibility interpretation statement not parsable by X11’s xkbcomp. This particularly affects Japanese layout jp when used with Xwayland. (#750)
- Fixed empty compatibility interpretations map not parsable by X11’s xkbcomp.
- Fixed key type map entries with a mix of bound and unbound modifiers not being ignored. (#758)

# libxkbcommon 1.9.1 – 2025-05-02

## API

### Fixes

- X11: Fixed capitalization transformation not set properly, resulting in some keys (e.g. arrows, Home, etc.) not working when Caps Lock is on. (#740)

# libxkbcommon 1.9.0 – 2025-04-26

## API

### Breaking changes

- Merge modes and include mechanism were completely refactored to fix inconsistencies. Included files are now always processed in isolation and do not propagate the local merge modes. This makes the reasoning about included files much easier and consistent.

- Trailing NoSymbol and NoAction() are now dropped. This may affect keys that rely on an implicit key type.

  Example:

  - Input:
    key <> { [a, A, NoSymbol] };
  - Compilation with libxkbcommon < 1.9.0:
    key <> {
    type= "FOUR_LEVEL_SEMIALPHABETIC",
    [a, A, NoSymbol, NoSymbol]
    };
  - Compilation with libxkbcommon ≥ 1.9.0: c key <> { type= "ALPHABETIC", [a, A] };

### New

- Added function xkb_components_names_from_rules() to compute KcCGST keymap components from RMLVO names resolution.

  This mainly for debugging purposes and to enable the --kccgst option in the tools. (#669)

- Added the following wild cards to the rules file syntax, in addition to the current * legacy wild card:
  - <none>: Match empty value.
  - <some>: Match non-empty value.
  - <any>: Match any (optionally empty) value. Its behavior does not depend on the context, contrary to the legacy wild card *.
- All keymap components are now optional, e.g. a keymap without a xkb_types section is now legal. The missing components will still be serialized explicitly in order to maintain backward compatibility.

- Added support for further empty compound statements:

  - xkb_types: type "xxx" {};
  - xkb_compat: interpret x {}; and indicator "xxx" {};.

  Such statements are initialized using the current defaults, i.e. the factory implicit defaults or some explicit custom defaults (e.g. indicator.modifiers = Shift).

- Added support for actions and keysyms level list of length 0 and 1: respectively {} and {a}. Example: key <A> { [{}, {a}, {a, A}] };.
- Enable using the merge mode replace in include statements using the prefix ^, such as: include "a^b". The main motivation is to enable this new syntax in rules, which previously could not handle this merge mode.
- Added support for sequences of actions in interpret statements of the xkb_compat component, mirroring the syntax used in xkb_symbols. (#695)
- Added support for keysym Capitalization transformation to xkb_state_key_get_syms(). (#552)
- xkb_utf32_to_keysym: Allow Unicode noncharacters. (#715)

- xkb_keysym_from_name():

  - Unicode format UNNNN: allow control characters C0 and C1 and use xkb_utf32_to_keysym() for the conversion when NNNN < 0x100, for backward compatibility.
  - Numeric hexadecimal format 0xNNNN: unchanged. Contrary to the Unicode format, it does not normalize any keysym values in order to enable roundtrip with xkb_keysym_get_name().

  (#715)

- Added Unicode code point escape sequences \u{NNNN}. They are replaced with the UTF-8 encoding of their corresponding code point U+NNNN, if legal. Supported Unicode code points are in the range 1‥0x10ffff. This is intended mainly for writing keysyms as UTF-8 encoded strings.
- Enable to write keysyms as UTF-8-encoded strings:
  - Single Unicode code point U+1F3BA (TRUMPET) "🎺" is converted into a single keysym: U1F3BA.
  - Multiple Unicode code points are converted to a keysym list where it is allowed (i.e. in key symbols). E.g. "J́" is converted to U+004A LATIN CAPITAL LETTER J plus U+0301 COMBINING ACUTE ACCENT: {J, U0301}.
  - An empty string "" denotes the keysym NoSymbol.
- Enable displaying bidirectional text in XKB files using the following Unicode code points, wherever a white space can be used:
  - U+200E LEFT-TO-RIGHT MARK
  - U+200F RIGHT-TO-LEFT MARK

### Fixes

- Added support for libxml2-2.14+, which now disallows parsing trailing NULL bytes. (#692)

- Fixed included default section not resolving to an exact match in some cases. It may occur if one creates a file name in a user XKB directory that also exists in the XKB system directory.

  Example: if one creates a custom variant my_variant in the file $XDG_CONFIG_HOME/xkb/symbols/us, then before libxkbcommon 1.9.0 every statement loading the default map of the us file, include "us", would wrongly resolve including us(my_variant) from the user configuration directory instead of us(basic) from the XKB system directory. Starting from libxkbcommon 1.9.0, include "us" would correctly resolve to the system file, unless $XDG_CONFIG_HOME/xkb/symbols/us contains an explicit default section. (#726)

- Fixed floating-point number parsing failling on locales that use a decimal separator different than the period ..

  Note that the issue is unlikely to happen even with such locales, unless parsing a keymap with a geometry component which contains floating-point numbers.

  Affected API:

  - xkb_keymap_new_from_file(),
  - xkb_keymap_new_from_buffer(),
  - xkb_keymap_new_from_string().

  Unaffected API:

  - xkb_keymap_new_from_names(): none of the components loaded use floating-point number. libxkbcommon does not load geometry files.
  - libxkbcommon-x11: no such parsing is involved.

- Fixed the handling of empty keys. Previously keys with no symbols nor actions would simply be skipped entirely. E.g. in the following:

  key <A> { vmods = M };
  modifier_map Shift { <A> };

  the key <A> would be skipped and the virtual modifier M would not be mapped to Shift. This is now handled properly.

- Fixed characters not escaped properly in the keymap serialization, resulting in a keymap string with erroneous string literals and possible syntax errors.
- Fixed octal escape sequences valid in Xorg’s xkbcomp but not in xkbcommon. Now up to 4 digits are parsed, compared to 3 previously.
- Fixed the serialization of the whichGroupState indicator field.

## Tools

### New

- xkbcli compile-keymap: Added --kccgst option to display the result of RMLVO names resolution to KcCGST components.

  This option has the same function than setxkbmap -print. This is particularly useful for debugging issues with the rules. (#669)

- Honor user locale in all tools.

# libxkbcommon 1.8.1 – 2025-03-12

## API

### Fixes

- Fixed segfault due to invalid arithmetic to bring negative layout indices into range. It triggers with the following settings:

  - layouts count (per key or total) N: N > 0, and
  - layout index n: n = - k * N (k > 0)

  Note that these settings are unlikely in usual use cases.

## Tools

### Breaking changes

- The tools do not load the default RMLVO (rules, model, layout, variant, options) values from the environment anymore. The previous behavior may be restored by using the new --enable-environment-names option.

## Build system

### New

- Source files are now annotated with SPDX short license identifiers. The LICENSE file was updated to accommodate this. (#628)

# libxkbcommon 1.8.0 – 2025-02-04

## API

### Breaking changes

- NoSymbol is now systematically dropped in multi-keysyms levels:

  // Before normalization
  key <> { [{NoSymbol}, {a, NoSymbol}, {NoSymbol,b}, {a, NoSymbol, b}] };
  // After normalization
  key <> { [NoSymbol, a, b, {a, b}] };
- Added the upper case mapping ß → ẞ (ssharp → U1E9E). This enable to type ẞ using CapsLock thanks to the internal capitalization rules.

- Updated keysyms case mappings to cover full [Unicode 16.0]. This change provides a consistent behavior with respect to case mappings, and affects the following:

  - xkb_keysym_to_lower() and xkb_keysym_to_upper() give different output for keysyms not covered previously and handle title-cased keysyms.

    Example of title-cased keysym: U01F2 “ǲ”:

    - xkb_keysym_to_lower(U01F2) == U01F3 “ǲ” → “ǳ”
    - xkb_keysym_to_upper(U01F2) == U01F1 “ǲ” → “Ǳ”
  - Implicit alphabetic key types are better detected, because they use the latest Unicode case mappings and now handle the title-cased keysyms the same way as upper-case ones.

  Note: There is a single exception that do not follow the Unicode mappings:

  - xkb_keysym_to_upper(ssharp) == U1E9E “ß” → “ẞ”

  Note: As before, only simple case mappings (i.e. one-to-one) are supported. For example, the full upper case of U+01F0 “ǰ” is “J̌” (2 characters: U+004A and U+030C), which would require 2 keysyms, which is not supported by the current API.

### New

- Implemented the GroupLatch action, usually activated with the keysym ISO_Group_Latch. (#455)

- Symbols: Added support for multiple actions per levels:

  - When no action is specified, interpret statements are used to find an action corresponding to each keysym, as expected.
  - When both keysyms and actions are specified, they may have a different count for each level.

  - For now, at most one action of each of the following categories is allowed per level:

    - modifier actions: SetMods, LatchMods, LockMods;
    - group actions: SetGroup, LatchGroup, LockGroup.

    Some examples:

    - SetMods + SetGroup: ok
    - SetMods + SetMods: error
    - SetMods + LockMods: error
    - SetMods + LockGroup: ok

  (#486)

- Updated keysyms using latest xorgproto (commit: d7ea44d5f04cc476dee83ef439a847172f7a6bd1):

  Additions:

  - XKB_KEY_XF86RefreshRateToggle
  - XKB_KEY_XF86Accessibility
  - XKB_KEY_XF86DoNotDisturb

  Relevant upstream merge request: xorgproto-91.

- Added deprecated keysym warnings:

  - name deprecation (typo, historical alias), reporting the reference name;
  - keysym deprecation (ambiguous meaning, all names deprecated).

  These warnings are activated by setting the log verbosity to at least 2.

  It is advised to fix these warnings, as the deprecated items may be removed in a future release.

- xkbcommon-names.h: Added the following modifiers names definitions:
  - XKB_MOD_NAME_MOD1
  - XKB_MOD_NAME_MOD2
  - XKB_MOD_NAME_MOD3
  - XKB_MOD_NAME_MOD4
  - XKB_MOD_NAME_MOD5
  - XKB_VMOD_NAME_ALT
  - XKB_VMOD_NAME_META
  - XKB_VMOD_NAME_NUM
  - XKB_VMOD_NAME_SUPER
  - XKB_VMOD_NAME_HYPER
  - XKB_VMOD_NAME_LEVEL3
  - XKB_VMOD_NAME_LEVEL5
  - XKB_VMOD_NAME_SCROLL

- xkbcommon-names.h: Added XKB_LED_NAME_COMPOSE and XKB_LED_NAME_KANA definitions to cover all LEDs defined in USB HID.

  Contributed by Martin Rys

- Rules: Use XKB paths to resolve relative paths in include statements. (#501)

- Rules: Added support for special layouts indices:

  - single: matches a single layout; layout[single] is the same as without explicit index: layout.
  - first: matches the first layout/variant, no matter how many layouts are in the RMLVO configuration. Acts as both layout and layout[1].
  - later: matches all but the first layout. This is an index range. Acts as layout[2] .. layout[MAX_LAYOUT], where MAX_LAYOUT is currently 4.
  - any: matches layout at any position. This is an index range.

  Also added:

  - the special index i which correspond to the index of the matched layout.
  - the :all qualifier: it applies the qualified item to all layouts.

  See the documentation for further information.

### Fixes

- Previously, setting explicit actions for a group in symbols files made the parser skip compatibility interpretations for all groups in the corresponding key, resulting in possibly broken groups with no explicit actions or missing key fields.

  Fixed by skipping interpretations only for groups with explicit actions when parsing a keymap and setting relevant fields explicitly when serializing a keymap to a string. (#511)

- xkb_keymap_new_from_names(): Allow only one group per key in symbols sections. While the original issue was fixed in xkeyboard-config project, the previous handling in libxkbcommon of extra key groups was deemed unintuitive.

  Note: rules resolution may still produce more groups than the input layouts. This is currently true for some legacy rules in xkeyboard-config.

  (#262)

- Fixed xkb_keymap_get_as_string truncating the 4 longest keysyms names, such as Greek_upsilonaccentdieresis.
- xkb_keysym_to_utf8: Require only 5 bytes for the buffer, as UTF-8 encodes code points on up to 4 bytes + 1 byte for the NULL-terminating byte. Previous standard RFC 2279 (1998) required up to 6 bytes per code point, but has been superseded by RFC 3629 (2003). (#418)

- Registry: Fixed libxml2 global error handler not reset after parsing, which could trigger a crash if the corresponding rxkb_context has been freed.

  Contributed by Sebastian Keller. (#529)

- Rules: Fix handling of wild card * to match the behavior of libxkbfile. Previously * would match any value, even empty one. Now:

  - For model and options: always match.
  - For layout and variant: match any non-empty value.

  (#497)

- Fixed LatchGroup action with the latchToLock option disabled not applying its latch effect multiple times. (#577)
- Fixed incorrect handling of group indicators when whichGroupState is set with Base or Latched. (#579)
- Fixed missing explicit virtual modifier mappings when export the keymap as a string.
- Fixed the lower case mapping ẞ → ß (U1E9E → ssharp). This re-enable the detection of alphabetic key types for the pair (ß, ẞ).
- Fixed modifiers not properly unset when multiple latches are used simultaneously. (#583)

- The following functions now allow to query also virtual modifiers, so they work with any modifiers (real and virtual):

  - xkb_state_mod_index_is_active()
  - xkb_state_mod_indices_are_active()
  - xkb_state_mod_name_is_active()
  - xkb_state_mod_names_are_active()
  - xkb_state_mod_index_is_consumed()
  - xkb_state_mod_index_is_consumed2()
  - xkb_state_mod_mask_remove_consumed()

  Warning: they may overmatch in case there are overlappings virtual-to-real modifiers mappings.

- X11: Do not drop a level when the keysym is undefined but not the action.

## Tools

### New

- Added xkbcli dump-keymap-wayland and xkbcli dump-keymap-x11 debugging tools to dump a keymap from a Wayland compositor or an X server, similar to what xkbcomp -xkb $DISPLAY - does for X servers.
- xkbcli compile-compose: the Compose file may be passed as a positional argument and --file is now deprecated. The file can also be piped to the standard input by setting the path to -.
- xkbcli compile-keymap: Added --Keymap Creation as a more intuitive alias for --from-xkb. Both now accept an optional keymap file argument. These flags may be omitted; in this case the keymap file may be passed as a positional argument.
- Added --test option to compile-keymap and compile-compose, to enable testing compilation without printing the resulting file.

- xkbcli how-to-type: added new input formats and their corresponding documentation.

  Unicode code points can be passed in the following formats:

  - Literal character (requires UTF-8 character encoding of the terminal);
  - Decimal number;
  - Hexadecimal number: either 0xNNNN or U+NNNN.

  Keysyms can to be passed in the following formats:

  - Decimal number;
  - Hexadecimal number: 0xNNNN;
  - Name.

### Fixes

- Fixed various tools truncating the 4 longest keysyms names, such as Greek_upsilonaccentdieresis.
- xkbcli list: Fix duplicate variants. (#587)

## Build system

### Breaking changes

- Raised minimal meson version requirement to 0.58.

### Fixes

- Make the test of -Wl,--version-script more robust. (#481)

# libxkbcommon 1.7.0 – 2024-03-24

## API

### New

- Added early detection of invalid encodings and BOM for keymaps, rules & Compose. Also added a hint that the expected encoding must be UTF-8 compatible.

### Fixes

- Updated keysyms using latest xorgproto (commit: cd33097fc779f280925c6d6bbfbd5150f93ca5bc):

  For the sake of compatibility, this reintroduces some deleted keysyms and postpones the effective deprecation of others, that landed in xkbcommon 1.6.0.

  - Additions (reverted removal):
    - XKB_KEY_dead_lowline
    - XKB_KEY_dead_aboveverticalline
    - XKB_KEY_dead_belowverticalline
    - XKB_KEY_dead_longsolidusoverlay
  - The following keysyms names remain deprecated, but are set again (i.e. as before xkbcommon 1.6.0) as the reference names for their respective keysyms, in order to ensure the transition to the newer names that replace them. This affects functions such as xkb_keymap_key_get_name and xkb_keymap_get_as_string.
    - XKB_KEY_masculine: is deprecated in favor of XKB_KEY_ordmasculine
    - XKB_KEY_guillemotleft: is deprecated in favor of XKB_KEY_guillemetleft
    - XKB_KEY_guillemotright: is deprecated in favor of XKB_KEY_guillemetright
    - XKB_KEY_dead_small_schwa: is deprecated in favor of XKB_KEY_dead_schwa
    - XKB_KEY_dead_capital_schwa: is deprecated in favor of XKB_KEY_dead_SCHWA

  Relevant upstream merge requests: xorgproto-83, xorgproto-84.

- Keysyms: Fixed inconsistent results in xkb_keysym_from_name when used with the flag XKB_KEYSYM_CASE_INSENSITIVE. In some rare cases it would return a keysym with an upper-case name instead of the expected lower-case (e.g. XKB_KEY_dead_A instead of XKB_KEY_dead_a).
- Keysyms: Fixed case mapping for 3 Latin 1 keysyms:
  - XKB_KEY_ydiaeresis
  - XKB_KEY_mu
  - XKB_KEY_ssharp
- Keysyms: Fixed xkb_keysym_is_modifier to detect also the following keysyms:
  - XKB_KEY_ISO_Level5_Shift
  - XKB_KEY_ISO_Level5_Latch
  - XKB_KEY_ISO_Level5_Lock
- Prevent recursive includes of keymap components.

- Fixed global default statements x.y = z; in wrong scope not raising an error.

  Contributed by Mikhail Gusarov

- Keymap: Fixed empty symbols declaration.

  Contributed by Yuichiro Hanada.

- Rules: Made newline required after !include line.

  Contributed by Mikhail Gusarov.

- Rules: Fixed a bug where variant indices were ignored with the layout index used instead. They are practically always the same, but don’t have to be.

  Contributed by @wysiwys.

- Compose: Fixed a segfault with xkb_compose_table_iterator_next when used on an empty table.
- Compose: Added check to ensure to open only regular files, not e.g. directories.
- Registry: Updated the DTD and always parse the “popularity” attribute.
- Fixed a few memory leaks and keymap symbols parsing.

## Tools

### New

- xkbcli compile-compose: added new CLI utility to test Compose files.
- xkbcli interactive-evdev: added --verbose option.
- xkbcli interactive-x11: added support for Compose.
- xkbcli interactive-wayland: added support for Compose.

### Fixes

- Bash completion: Fixed completion in some corner cases.

## Build system

- Fix building with clang when using -Wl,--gc-sections.

  Contributed by ppw0.

- Fixed linking using lld 1.17.

  Contributed by Baptiste Daroussin.

- Fix building X11 tests on macOS.
- Documentation is no longer built by default; it requires -Denable-docs=true.

# libxkbcommon 1.6.0 – 2023-10-08

## API

### Breaking changes

- Remove keysyms that were intended for German T3 layout but are unused:

  - XKB_KEY_dead_lowline
  - XKB_KEY_dead_aboveverticalline
  - XKB_KEY_dead_belowverticalline
  - XKB_KEY_dead_longsolidusoverlay

  See the upstream xorgproto MR. See hereinafter for further changes related to keysyms.

### New

- Add Compose iterator API to iterate the entries in a compose table:
  - xkb_compose_table_entry_sequence()
  - xkb_compose_table_entry_keysym()
  - xkb_compose_table_entry_utf8()
  - xkb_compose_table_iterator_new()
  - xkb_compose_table_iterator_free()
  - xkb_compose_table_iterator_next()
- Structured log messages with a message registry. There is an ongoing work to assign unique identifiers to log messages and add a corresponding error index documentation page:
  - The log entries are preceded with an identifier in the form XKB-NNN, where NNN is a decimal number.
  - The log entries can then be parsed with third-party tools, to check for specific identifiers.
  - The new documentation page “**Error index**” lists all the kind of error messages with their identifiers. The aim is that each entry could present detailed information on the error and how to fix it.
- Add a new warning for numeric keysyms references in XKB files: the preferred keysym reference form is its name or its Unicode value, if relevant.
- Add the upper bound XKB_KEYSYM_MAX to check valid keysyms.
- Add a warning when loading a keymap using RMLVO with no layout but with the variant set. The variant is actually discarded and both layout and variant are set to default values, but this was done previously with no warning, confusing end users.
- Add support for modifier_map None { … }. This feature is missing compared to the X11 implementation. It allows to reset the modifier map of a key.
- Update keysyms using latest xorgproto (commit: 1c8128d72df22843a2022576850bc5ab5e3a46ea):
  - Additions:
    - XKB_KEY_ordmasculine (xorgproto-68)
    - XKB_KEY_guillemetleft (xorgproto-68)
    - XKB_KEY_guillemetright (xorgproto-68)
    - XKB_KEY_dead_schwa (xorgproto-78)
    - XKB_KEY_dead_SCHWA (xorgproto-78)
    - XKB_KEY_dead_hamza (xorgproto-71)
    - XKB_KEY_XF86EmojiPicker (xorgproto-44)
    - XKB_KEY_XF86Dictate (xorgproto-49)
    - XKB_KEY_XF86CameraAccessEnable (xorgproto-82)
    - XKB_KEY_XF86CameraAccessDisable (xorgproto-82)
    - XKB_KEY_XF86CameraAccessToggle (xorgproto-82)
    - XKB_KEY_XF86NextElement (xorgproto-82)
    - XKB_KEY_XF86PreviousElement (xorgproto-82)
    - XKB_KEY_XF86AutopilotEngageToggle (xorgproto-82)
    - XKB_KEY_XF86MarkWaypoint (xorgproto-82)
    - XKB_KEY_XF86Sos (xorgproto-82)
    - XKB_KEY_XF86NavChart (xorgproto-82)
    - XKB_KEY_XF86FishingChart (xorgproto-82)
    - XKB_KEY_XF86SingleRangeRadar (xorgproto-82)
    - XKB_KEY_XF86DualRangeRadar (xorgproto-82)
    - XKB_KEY_XF86RadarOverlay (xorgproto-82)
    - XKB_KEY_XF86TraditionalSonar (xorgproto-82)
    - XKB_KEY_XF86ClearvuSonar (xorgproto-82)
    - XKB_KEY_XF86SidevuSonar (xorgproto-82)
    - XKB_KEY_XF86NavInfo (xorgproto-82)
  - Deprecations:
    - XKB_KEY_masculine: use XKB_KEY_ordmasculine instead (xorgproto-68)
    - XKB_KEY_guillemotleft: use XKB_KEY_guillemetleft instead (xorgproto-68)
    - XKB_KEY_guillemotright: use XKB_KEY_guillemetright instead (xorgproto-68)
    - XKB_KEY_dead_small_schwa: use XKB_KEY_dead_schwa instead (xorgproto-78)
    - XKB_KEY_dead_capital_schwa: use XKB_KEY_dead_SCHWA instead (xorgproto-78)
- Ongoing work to improve the documentation about XKB and its V1 format.

### Fixes

- Prevent xkb_keysym_from_name to parse out-of-range hexadecimal keysyms.
- Disallow producing NULL character with escape sequences \0 and \x0.
- Prevent overflow of octal escape sequences by making \400..\777 invalid.
- Prevent interpreting and emitting invalid Unicode encoding forms: surrogates are invalid in both UTF-32 and UTF-8.
- xkb_keymap_new_from_buffer: Allow for a NULL-terminated keymap string.

- Compose: Increase the limit of possible entries to handle huge Compose files.

  Contributed by alois31.

## Tools

### New

- Add bash completions for xkbcli and its subcommands.
- xkbcli interactive-*: Add options --short to hide some fields.
- xkbcli interactive-evdev: Add --includes and --include-defaults options.
- Add xkb-check-messages experimental tool (not installed). It checks whether given log messages identifiers are supported.

### Fixes

- xkbcli compile-keymap: Allow to use without arguments.
- xkbcli interactive-*: Always print keycode.
- xkbcli interactive-*: Escape control characters for Unicode output, instead of printing them as-is, messing the output.

## Build system

- Bump required meson to 0.52.0.

- Allow xkbcommon to be used as a subproject.

  Contributed by Simon Ser.

- Improve Windows compilation.

# libxkbcommon 1.5.0 – 2023-01-02

- Add xkb_context flag XKB_CONTEXT_NO_SECURE_GETENV and rxkb_context flag RXKB_CONTEXT_NO_SECURE_GETENV.

  xkbcommon uses getenv_secure() to obtain environment variables. This flag makes xkbcommon use getenv() instead.

  This is useful for some clients that have relatively benign capabilities set, like CAP_SYS_NICE, that also want to use e.g. the XKB configuration from the environment and user configs in $XDG_CONFIG_HOME.

  Contributed by Ronan Pigott.

- Fix crash in xkbcli interactive-wayland under a compositor which supports new versions of the xdg-shell protocol.

  Contributed by Jan Alexander Steffens (heftig).

- Fix some MSVC build issues.
- Fix some issues when including xkbcommon as a meson subproject.
- meson>=0.51 is now required.
- New API: XKB_CONTEXT_NO_SECURE_GETENV RXKB_CONTEXT_NO_SECURE_GETENV

# libxkbcommon 1.4.1 – 2022-05-21

- Fix compose sequence overriding (common prefix) not working correctly. Regressed in 1.2.0.

  Contributed by Weng Xuetian.

- Remove various bogus currency sign (particulary Euro and Korean Won) entries from the keysym ↔ Unicode mappings. They prevented the real keysyms/codepoints for these from mapping correctly.

  Contributed by Sam Lantinga and Simon Ser.

# libxkbcommon 1.4.0 – 2022-02-04

- Add enable-tools option to Meson build (on by default) to allow disabling the xkbcli tools.

  Contributed by Alex Xu (Hello71).

- In xkbcli list, fix “YAML Norway problem” in output.

  Contributed by Peter Hutterer.

- In libxkbregistry, variants now inherit iso639, iso3166 and brief from parent layout if omitted.

  Contributed by M Hickford.

- In libxkbregistry, don’t call xmlCleanupParser() - it’s not supposed to be called by libraries.

  Contributed by Peter Hutterer.

- In libxkbregistry, skip over invalid ISO-639 or ISO-3166 entries.

  Contributed by Peter Hutterer.

# libxkbcommon 1.3.1 – 2021-09-10

- In xkbcli interactive-x11, use the Esc keysym instead of the Esc keycode for quitting.

  Contributed by Simon Ser.

- In xkbcli how-to-type, add --keysym argugment for how to type a keysym instead of a Unicode codepoint.

- Fix a crash in xkb_x11_keymap_new_from_device() error handling given some invalid keymaps. Regressed in 1.2.0.

  Reported by Zack Weinberg. Tested by Uli Schlachter.

# libxkbcommon 1.3.0 – 2021-05-01

- Change xkbcli list to output YAML, instead of the previous ad-hoc format.

  This allows to more easily process the information in a programmetic way, for example

      xkbcli list | yq -r ".layouts[].layout"

  Contributed by Peter Hutterer.

- Optimize a certain part of keymap compilation (atom interning).

- Fix segmentation fault in case-insensitive xkb_keysym_from_name() for certain values like the empty string.

  Contributed by Isaac Freund.

- Support building libxkbcommon as a meson subproject.

  Contributed by Adrian Perez de Castro.

- Add ftruncate fallback for posix_fallocate in xkbcli interactive-wayland for FreeBSD.

  Contributed by Evgeniy Khramtsov.

- Properly export library symbols in MSVC.

  Contributed by Adrian Perez de Castro.

# libxkbcommon 1.2.1 – 2021-04-07

- Fix xkb_x11_keymap_new_from_device() failing when the keymap contains key types with missing level names, like the one used by the numpad:mac option in xkeyboard-config. Regressed in 1.2.0.

# libxkbcommon 1.2.0 – 2021-04-03

- xkb_x11_keymap_new_from_device() is much faster. It now performs only 2 roundtrips to the X server, instead of dozens (in first-time calls).

  Contributed by Uli Schlachter.

- Case-sensitive xkb_keysym_from_name() is much faster.
- Keysym names of the form 0x12AB and U12AB are parsed more strictly. Previously the hexadecimal part was parsed with strtoul(), now only up to 8 hexadecimal digits (0-9A-Fa-f) are allowed.
- Compose files now have a size limit (65535 internal nodes). Further sequences are discared and a warning is issued.
- Compose table loading (xkb_compose_table_new_from_locale() and similar) is much faster.
- Use poll() instead of epoll() for xlbcli interactive-evdev, making it portable to FreeBSD which provides evdev but not epoll. On FreeBSD, remember to install the evdev-proto package to get the evdev headers.
- The build now requires a C11 compiler (uses anonymous structs/unions).

# libxkbcommon 1.1.0 – 2021-02-27

- Publish the xkb-format-text-v1.md file in the HTML documentation. This file existed for a long time but only in the Git repository. Link: https://xkbcommon.org/doc/current/md_doc_keymap_format_text_v1.html

- Add partial documentation for xkb_symbols to xkb-format-text-v1.md.

  Contributed by Simon Zeni.

- Update keysym definitions to latest xorgproto. In particular, this adds many special keysyms corresponding to Linux evdev keycodes.

  Contributed by Peter Hutterer <@who-t.net>.

- New API: Too many XKB_KEY_* definitions to list here.

# libxkbcommon 1.0.3 – 2020-11-23

- Fix (hopefully) a segfault in xkb_x11_keymap_new_from_device() in some unclear situation (bug introduced in 1.0.2).
- Fix keymaps created with xkb_x11_keymap_new_from_device() don’t have level names (bug introduced in 0.8.0).

# libxkbcommon 1.0.2 – 2020-11-20

- Fix a bug where a keysym that cannot be resolved in a keymap gets compiled to a garbage keysym. Now it is set to XKB_KEY_NoSymbol instead.
- Improve the speed of xkb_x11_keymap_new_from_device() on repeated calls in the same xkb_context().

# libxkbcommon 1.0.1 – 2020-09-11

- Fix the tool-option-parsing test failing.
- Remove requirement for pytest in the tool-option-parsing test.
- Make the table output of xkbcli how-to-type aligned.
- Some portability and test isolation fixes.

# libxkbcommon 1.0.0 – 2020-09-05

Note: this release is API and ABI compatible with previous releases –the major version bump is only an indication of stability.

- Add libxkbregistry as configure-time optional library. libxkbregistry is a C library that lists available XKB models, layouts and variants for a given ruleset. This is a separate library (libxkbregistry.so, pkgconfig file xkbregistry.pc) and aimed at tools that provide a listing of available keyboard layouts to the user. See the Documentation for details on the API.

  Contributed by Peter Hutterer <@who-t.net>.

- Better support custom user configuration:

  - Allow including XKB files from other paths.

    Previously, a symbols/us file in path A would shadow the same file in path B. This is suboptimal, we rarely need to hide the system files - we care mostly about extending them. By continuing to check other lookup paths, we make it possible for a $XDG_CONFIG_HOME/xkb/symbols/us file to have sections including those from /usr/share/X11/xkb/symbols/us.

    Note that this is not possible for rules files, which need to be manually controlled to get the right bits resolved.

  - Add /etc/xkb as extra lookup path for system data files.

    This completes the usual triplet of configuration locations available for most processes:

    - vendor-provided data files in /usr/share/X11/xkb
    - system-specific data files in /etc/xkb
    - user-specific data files in $XDG_CONFIG_HOME/xkb

    The default lookup order user, system, vendor, just like everything else that uses these conventions.

    For include directives in rules files, the E resolves to that path.

  - Add a new section to the documentation for custom user configuration.

  Contributed by Peter Hutterer <@who-t.net>.

- Add an xkbcli command-line utility.

  This tool offers various subcommands for introspection and debugging. Currently the available subcommands are:

  list
    List available rules, models, layouts, variants and options
  interactive-wayland
    Interactive debugger for XKB keymaps for Wayland
  interactive-x11
    Interactive debugger for XKB keymaps for X11
  interactive-evdev
    Interactive debugger for XKB keymaps for evdev (Linux)
  compile-keymap
    Compile an XKB keymap
  how-to-type
    See separate entry below.

  See the manpages for usage information.

  Contributed by Peter Hutterer <@who-t.net>.

- Add xkb_utf32_to_keysym() to translate a Unicode codepoint to a keysym. When a special keysym (XKB_KEY_ constant) for the codepoint exists, it is returned, otherwise the direct encoding is used, if permissible.

  Contributed by Jaroslaw Kubik <@froglogic.com>.

- Add xkb_keymap_key_get_mods_for_level() which retrieves sets of modifiers which produce a given shift level in a given key+layout.

  Contributed by Jaroslaw Kubik <@froglogic.com>.

- Add xkbcli how-to-type command, which, using xkb_utf32_to_keysym() and xkb_keymap_key_get_mods_for_level() and other APIs, prints out all the ways to produce a given keysym.

  For example, how to type ? (codepoint 63) in a us,de keymap?

      $ xkbcli how-to-type --layout us,de 63 | column -ts $'\t'
      keysym: question (0x3f)
      KEYCODE  KEY NAME  LAYOUT#  LAYOUT NAME   LEVEL#  MODIFIERS
      20       AE11      2        German        2       [ Shift ]
      20       AE11      2        German        2       [ Shift Lock ]
      61       AB10      1        English (US)  2       [ Shift ]

- Add a new section to the documentation describing the format of the XKB rules file.

- Search for Compose in $XDG_CONFIG_HOME/XCompose (fallback to ~/.config/XCompose) before trying $HOME/.XCompose.

  Note that libX11 still only searches in $HOME/.XCompose.

  Contributed by Emmanuel Gil Peyrot <@linkmauve.fr>.

- Bump meson requirement to >= 0.49.0.
- Fix build with byacc.

- Fix building X11 tests on PE targets.

  Contributed by Jon Turney <@dronecode.org.uk>

- The tests no longer rely on bash, only Python (which is already used by meson).
- New API: xkb_utf32_to_keysym xkb_keymap_key_get_mods_for_level XKB_KEY_XF86FullScreen

# libxkbcommon 0.10.0 – 2020-01-18

- (security) Fix quadratic complexity in the XKB file parser. See commit message 7c42945e04a2107827a057245298dedc0475cc88 for details.

- Add $XDG_CONFIG_HOME/xkb to the default search path. If $XDG_CONFIG_HOME is not set, $HOME/.config/xkb is used. If $HOME is not set, the path is not added.

  The XDG path is looked up before the existing default search path $HOME/.xkb.

  Contributed by Peter Hutterer <@who-t.net>.

- Add support for include statements in XKB rules files.

  This is a step towards making local XKB customizations more tenable and convenient, without modifying system files.

  You can now include other rules files like this:

      ! include %S/evdev

  Two directives are supported, H to $HOME and S for the system-installed rules directory (usually /usr/share/X11/xkb/rules).

  See commit message ca033a29d2ca910fd17b1ae287cb420205bdddc8 and doc/rules-format.txt in the xkbcommon source code for more information.

  Contributed by Peter Hutterer <@who-t.net>.

- Downgrade “Symbol added to modifier map for multiple modifiers” log to a warning.

  This error message was too annoying to be shown by default. When working on keymaps, set XKB_LOG_LEVEL=debug XKB_LOG_VERBOSITY=10 to see all possible messages.

- Support building on Windows using the meson MSVC backend.

  Contributed by Adrian Perez de Castro <@igalia.com>.

- Fix bug where the merge mode only applied to the first vmod in a virtual_modifiers statement. Given

      augment virtual_modifiers NumLock,Alt,LevelThree

  Previously it was incorrectly treated as

      augment virtual_modifiers NumLock;
      virtual_modifiers Alt;
      virtual_modifiers LevelThree;

  Now it is treated as

      augment virtual_modifiers NumLock;
      augment virtual_modifiers Alt;
      augment virtual_modifiers LevelThree;

- Reject interpret modifier predicate with more than one value. Given

      interpret ISO_Level3_Shift+AnyOf(all,extraneous) { ... };

  Previously, extraneous (and further) was ignored. Now it’s rejected.

- Correctly handle capitalization of the ssharp keysym.

- Speed up and improve the internal xkeyboard-config tool. This tool compiles all layout/variant combinations in the xkeyboard-config dataset and reports any issues it finds.

  Contributed by Peter Hutterer <@who-t.net>.

- Speed up “atoms” (string interning). This code goes back at least to X11R1 (released 1987).

# libxkbcommon 0.9.1 – 2019-10-19

- Fix context creation failing when run in privileged processes as defined by secure_getenv(3), e.g. GDM.

# libxkbcommon 0.9.0 – 2019-10-19

- Move ~/.xkb to before XKB_CONFIG_ROOT (the system XKB path, usually /usr/share/X11/xkb) in the default include path. This enables the user to have full control of the keymap definitions, instead of only augmenting them.
- Remove the Autotools build system. Use the meson build system instead.
- Fix invalid names used for levels above 8 when dumping keymaps. Previously, e.g. Level20 was dumped, but only up to Level8 is accepted by the parser. Now 20 is dumped.

- Change level references to always be dumped as e.g. 5 instead of Level5.

  Change group references to always be dumped capitalized e.g. Group3 instead of group3. Previously it was inconsistent.

  These changes affect the output of xkb_keymap_get_as_string().

- Fix several build issues on macOS/Darwin, Solaris, NetBSD, cross compilation.
- Port the interactive-wayland test program to the stable version of xdg-shell.

# libxkbcommon 0.8.4 – 2019-02-22

- Fix build of xkbcommon-x11 static library with meson.
- Fix building using meson from the tarball generated by autotools.

# libxkbcommon 0.8.3 – 2019-02-08

- Fix build of static libraries with meson. (Future note: xkbcommon-x11 was not fixed in this release.)
- New API: XKB_KEY_XF86MonBrightnessCycle XKB_KEY_XF86RotationLockToggle

# libxkbcommon 0.8.2 – 2018-08-05

- Fix various problems found with fuzzing (see commit messages for more details):
  - Fix a few NULL-dereferences, out-of-bounds access and undefined behavior in the XKB text format parser.

# libxkbcommon 0.8.1 – 2018-08-03

- Fix various problems found in the meson build (see commit messages for more details):
  - Fix compilation on Darwin.
  - Fix compilation of the x11 tests and demos when XCB is installed in a non-standard location.
  - Fix xkbcommon-x11.pc missing the Requires specification.
- Fix various problems found with fuzzing and Coverity (see commit messages for more details):
  - Fix stack overflow in the XKB text format parser when evaluating boolean negation.
  - Fix NULL-dereferences in the XKB text format parser when some unsupported tokens appear (the tokens are still parsed for backward compatibility).
  - Fix NULL-dereference in the XKB text format parser when parsing an xkb_geometry section.
  - Fix an infinite loop in the Compose text format parser on some inputs.
  - Fix an invalid free() when using multiple keysyms.
- Replace the Unicode characters for the leftanglebracket and rightanglebracket keysyms from the deprecated LEFT/RIGHT-POINTING ANGLE BRACKET to MATHEMATICAL LEFT/RIGHT ANGLE BRACKET.
- Reject out-of-range Unicode codepoints in xkb_keysym_to_utf8() and xkb_keysym_to_utf32().

# libxkbcommon 0.8.0 – 2017-12-15

- Added xkb_keysym_to_{upper,lower} to perform case-conversion directly on keysyms. This is useful in some odd cases, but working with the Unicode representations should be preferred when possible.
- Added Unicode conversion rules for the signifblank and permille keysyms.

- Fixed a bug in the parsing of XKB key type definitions where the number of levels were determined by the number of level names. Keymaps which omit level names were hence miscompiled.

  This regressed in version 0.4.3. Keymaps from xkeyboard-config were not affected since they don’t omit level names.

- New API: xkb_keysym_to_upper() xkb_keysym_to_lower()

# libxkbcommon 0.7.2 – 2017-08-04

- Added a Meson build system as an alternative to existing autotools build system.

  The intent is to remove the autotools build in one of the next releases. Please try to convert to it and report any problems.

  See http://mesonbuild.com/Quick-guide.html for basic usage, the meson_options.txt for the project-specific configuration options, and the PACKAGING file for more details.

  There are some noteworthy differences compared to the autotools build:

  - Feature auto-detection is not performed. By default, all features are enabled (currently: docs, X11 support, wayland). The build fails if any of the required dependencies are not available. To disable a feature, pass -Denable-<feature>=false to meson.
  - The libraries are either installed as shared or static, as specified by the -Ddefault_library=shared/static option. With autotools, both versions are installed by default.
  - xorg-util-macros is not used.
  - A parser generator (bison/byacc) is always required - there is no fallback to pre-generated output bundled in the tarball, as there is in autotools.
- Removed Android.mk support.
- Removed the *-uninstalled.pc pkgconfig files.
- Ported the interactive-wayland demo program to v6 of the xdg-shell protocol.
- Added new keysym definitions from xproto.
- New API: XKB_KEY_XF86Keyboard XKB_KEY_XF86WWAN XKB_KEY_XF86RFKill XKB_KEY_XF86AudioPreset

# libxkbcommon 0.7.1 – 2017-01-18

- Fixed various reported problems when the current locale is tr_TR.UTF-8.

  The function xkb_keysym_from_name() used to perform case-insensitive string comparisons in a locale-dependent way, but required it to to work as in the C/ASCII locale (the so called “Turkish i problem”).

  The function is now no longer affected by the current locale.

- Fixed compilation in NetBSD.

# libxkbcommon 0.7.0 – 2016-11-11

- Added support for different “modes” of calculating consumed modifiers. The existing mode, based on the XKB standard, has proven to be unintuitive in various shortcut implementations.

  A new mode, based on the calculation used by the GTK toolkit, is added. This mode is less eager to declare a modifier as consumed.

- Added a new interactive demo program using the Wayland protocol. See the PACKAGING file for the new (optional) test dependencies.
- Fixed a compilation error on GNU Hurd.
- New API: enum xkb_consumed_mode XKB_CONSUMED_MODE_XKB XKB_CONSUMED_MODE_GTK xkb_state_key_get_consumed_mods2() xkb_state_mod_index_is_consumed2()

# libxkbcommon 0.6.1 – 2016-04-08

- Added LICENSE to distributed files in tarball releases.
- Minor typo fix in xkb_keymap_get_as_string() documentation.

# libxkbcommon 0.6.0 – 2016-03-16

- If the XKB_CONFIG_ROOT environment variable is set, it is used as the XKB configuration root instead of the path determined at build time.
- Tests and benchmarks now build correctly on OSX.

- An XKB keymap provides a name for each key it defines. Traditionally, these names are limited to at most 4 characters, and are thus somewhat obscure, but might still be useful (xkbcommon lifts the 4 character limit).

  The new functions xkb_keymap_key_get_name() and xkb_keymap_key_by_name() can be used to get the name of a key or find a key by name. Note that a key may have aliases.

- Documentation improvements.
- New API: xkb_keymap_key_by_name() xkb_keymap_key_get_name()

# libxkbcommon 0.5.0 – 2014-10-18

- Added support for Compose/dead keys in a new module (included in libxkbcommon). See the documentation or the xkbcommon/xkbcommon-compose.h header file for more details.
- Improved and reordered some sections of the documentation.
- The doxygen HTML pages were made nicer to read.
- Most tests now run also on non-linux platforms.
- A warning is emitted by default about RMLVO values which are not used during keymap compilation, which are most often a user misconfiguration. For example, terminate:ctrl_alt_backspace instead of terminate:ctrl_alt_bksp.
- Added symbol versioning for libxkbcommon and libxkbcommon-x11. Note: binaries compiled against this and future versions will not be able to link against the previous versions of the library.

- Removed several compatablity symbols from the binary (the API isn’t affected). This affects binaries which

  1. Were compiled against a pre-stable (<0.2.0) version of libxkbcommon, and
  2. Are linked against the this or later version of libxkbcommon.

  Such a scenario is likely to fail already.

- If Xvfb is not available, the x11comp test is now correctly skipped instead of hanging.
- Benchmarks were moved to a separate bench/ directory.
- Build fixes from OpenBSD.
- Fixed a bug where key type entries such as map[None] = Level2; were ignored.
- New API: XKB_COMPOSE_* xkb_compose_*

# libxkbcommon 0.4.3 – 2014-08-19

- Fixed a bug which caused xkb_x11_keymap_new_from_device() to misrepresent modifiers for some keymaps.

  https://github.com/xkbcommon/libxkbcommon/issues/9

- Fixed a bug which caused xkb_x11_keymap_new_from_device() to ignore XKB PrivateAction’s.
- Modifiers are now always fully resolved after xkb_state_update_mask(). Previously the given state components were used as-is, without considering virtual modifier mappings. Note: this only affects non-standard uses of xkb_state_update_mask().
- Added a test for xkbcommon-x11, x11comp. The test uses the system’s Xvfb server and xkbcomp. If they do not exist or fail, the test is skipped.
- Fixed memory leaks after parse errors in the XKB yacc parser. The fix required changes which are currently incompatible with byacc.

# libxkbcommon 0.4.2 – 2014-05-15

- Fixed a bug where explicitly passing --enable-x11 to ./configure would in fact disable it (regressed in 0.4.1).
- Added @since version annotations to the API documentation for everything introduced after the initial stable release (0.2.0).
- Added a section to the documentation about keysym transformations, and clarified which functions perform a given transformation.
- XKB files which fail to compile during keymap construction can no longer have any effect on the resulting keymap: changes are only applied when the entire compilation succeeds. Note: this was a minor correctness issue inherited from xkbcomp.
- Fix an out-of-bounds array access in src/x11/util.c:adopt_atoms() error-handling code. Note: it seems impossible to trigger in the current code since the input size cannot exceed the required size.

# libxkbcommon 0.4.1 – 2014-03-27

- Converted README to markdown and added a Quick Guide to the documentation, which breezes through the most common parts of xkbcommon.
- Added two new functions, xkb_state_key_get_utf{8,32}(). They combine the operations of xkb_state_key_get_syms() and xkb_keysym_to_utf{8,32}(), and provide a nicer interface for it (especially for multiple-keysyms-per-level).

- The xkb_state_key_get_utf{8,32}() functions now apply Control transformation: when the Control modifier is active, the string is converted to an appropriate control character. This matches the behavior of libX11’s XLookupString(3), and required by the XKB specification: https://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Control_Modifier

  https://bugs.freedesktop.org/show_bug.cgi?id=75892

- The consumed modifiers for a key are now calculated similarly to libX11. The previous behavior caused a bug where Shift would not cancel an active Caps Lock.

- Make xkbcommon-x11 work with the keymap reported by the XQuartz X server.

  https://bugs.freedesktop.org/show_bug.cgi?id=75798

- Reduce memory usage during keymap compilation some more.
- New API: xkb_state_key_get_consumed_mods() xkb_state_key_get_utf8() xkb_state_key_get_utf32()
- Deprecated API: XKB_MAP_COMPILE_PLACEHOLDER, XKB_MAP_NO_FLAGS use XKB_KEYMAP_NO_FLAGS instead.
- Bug fixes.

# libxkbcommon 0.4.0 – 2014-02-02

- Add a new add-on library, xkbcommon-x11, to support creating keymaps with the XKB X11 protocol, by querying the X server directly. See the xkbcommon/xkbcommon-x11.h header file for more details. This library requires libxcb-xkb >= 1.10, and is enabled by default. It can be disabled with the --disable-x11 configure switch. Distributions are encouraged to split the necessary files for this library (libxkbcommon-x11.so, xkbcommon-x11.pc, xkbcommon/xkbcommon-x11.h) to a separate package, such that the main package does not depend on X11 libraries.
- Fix the keysym ↔ name lookup table to not require huge amounts of relocations.
- Fix a bug in the keysym ↔ name lookup, whereby lookup might fail in some rare cases.
- Reduce memory usage during keymap compilation.
- New API: New keysyms from xproto 7.0.25 (German T3 layout keysyms). XKB_MOD_NAME_NUM for the usual NumLock modifier. xkb_x11_* types and functions, XKB_X11_* constants.

# libxkbcommon 0.3.2 – 2013-11-22

- Log messages from the library now look like xkbcommon: ERROR by default, instead of xkbcomp-like Error: .
- Apply capitalization transformation on keysyms in xkb_keysym_get_one_sym(), to match the behavior specified in the XKB specification: https://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Lock_Modifier
- Support byacc for generating the parser, in addition to Bison.
- New API: XKB_KEY_XF86AudioMicMute keysym from xproto 7.0.24. XKB_KEYSYM_NO_FLAGS XKB_CONTEXT_NO_FLAGS XKB_MAP_COMPILE_NO_FLAGS
- Bug fixes.

# libxkbcommon 0.3.1 – 2013-06-03

- Replace the flex scanner with a hand-written one. flex is no longer a build requirement.
- New API: xkb_keymap_min_keycode() xkb_keymap_max_keycode() xkb_keymap_key_for_each()

# libxkbcommon 0.3.0 – 2013-04-01

- Allow passing NULL to *_unref() functions; do nothing instead of crashing.
- The functions xkb_keymap_num_levels_for_key() and xkb_keymap_get_syms_by_level() now allow out-of-range values for the layout parameter. The functions now wrap the value around the number of layouts instead of failing.
- The function xkb_keysym_get_name() now types unicode keysyms in uppercase and 0-padding, to match the format used by XKeysymToString().
- Building Linux-specific tests is no longer attempted on non-Linux environments.
- The function xkb_keymap_new_from_names() now accepts a NULL value for the names parameter, instead of failing. This is equivalent to passing a struct xkb_rule_names with all fields set to NULL.
- New API: xkb_keymap_new_from_buffer()
- Bug fixes.