Install xkbcomp with Homebrew, apk, dnf, MacPorts, Nix, zypper

Project links

• Homepage
• Repository
• Upstream docs
• Package manager page

Commands and aliases

• xkbcomp

Project history

The manual page identifies xkbcomp as a compiler for XKB keyboard descriptions and carries 1994 copyright lines for Silicon Graphics Computer Systems and the X Consortium, with Erik Fortune of Silicon Graphics listed as author. That places the tool in the original XKB work that extended X11 keyboard handling beyond the older core protocol.

As X11 moved through XFree86 and X.Org, xkbcomp remained the low-level compiler behind keyboard layout composition. The X.Org XKB page now points users toward xkeyboard-config for the maintained data files, while the xkbcomp source is maintained as an X.Org application project on freedesktop.org.

Adoption history

xkbcomp was adopted because XKB itself became the standard keyboard model for X11 systems. Desktop environments and users usually interact with higher-level tools such as setxkbmap or desktop settings, but xkbcomp sits underneath them as the program that verifies, resolves, compiles, dumps, or uploads the actual keymap.

The tool also became a favorite diagnostic and customization utility for keyboard-layout specialists. Documentation and community examples commonly use `xkbcomp :0 -` to inspect the active keymap or `xkbcomp file.xkb $DISPLAY` to load a custom map into a running X server.

How it is used

Common package usage is compiling `.xkb` source into `.xkm` files, generating resolved XKB source from a display or compiled map, updating the keymap for a running X display, and producing C headers for servers or utilities that need built-in default keymaps.

For layout authors, xkbcomp is the last mile after editing keycodes, types, compat, symbols, and geometry files. It checks that those pieces merge into a complete keymap and reports warnings at selectable verbosity levels.

Why package nerds care

xkbcomp is classic Unix desktop substrate: rarely glamorous, but essential when packaging X servers, keyboard data, desktop sessions, remote desktops, or custom layouts. It is also a good example of a compiler whose input language is configuration rather than application code.

For package maintainers, its significance comes from being split from the keyboard-layout data it consumes. xkeyboard-config supplies the evolving layout corpus; xkbcomp supplies the compiler that XKB-capable systems rely on to consume that corpus.

Timeline

• 1994: The xkbcomp manual page records Silicon Graphics/X Consortium copyright and Erik Fortune as author.
• 1996: The original XKB protocol and library specifications were published for X11R6-era XKB.
• 2002: XKB enhancement documentation described xkbcomp as the ordinary compiler used to prepare compiled keyboard configuration for the X server.
• 2004: XFree86 4.3 and X11R6.7-era documentation described multi-layout XKB configuration handled through the same compiled keymap model.
• 2010s-2020s: X.Org keeps xkbcomp as a separate application while XKB data files are maintained by xkeyboard-config.

Related projects

• xkeyboard-config supplies the keyboard models, layouts, variants, and options that xkbcomp compiles. setxkbmap selects XKB layouts at a higher level. libxkbcommon reuses XKB concepts outside the X server world, especially for Wayland compositors.

Sources

• https://cgit.freedesktop.org/xorg/app/xkbcomp/tree/README.enhancing?id=8eb2e1fcd08a05f296a31dbadde1ec3cc84d8e28
• https://www.x.org/XKB/
• https://xkbcommon.org/doc/current/introduction-to-xkb.html
• https://xkbcommon.org/doc/current/user-configuration.html
• https://xorg.freedesktop.org/archive/X11R7.5/doc/man/man1/xkbcomp.1.html