XKBCLI(1)

✨ NAME ✨

okay so bestie, meet xkbcli 💖 — the tool to interact with X Keyboard keymaps. that's the whole job description, and she eats every time. (also hi, yes, you're in the General Commands Manual, section 1, the xkbcli page — welcome, get comfy 🦋)

---

🌸 SYNOPSIS 🌸

xkbcli command [arguments]
xkbcli [--help | --version]

---

🎀 DESCRIPTION 🎀

xkbcli is a commandline tool to query, compile and test XKB keymaps, layouts and other elements. she does it all, no cap ✨ and she's lowkey the main character of your keyboard config journey.

• --help — print the help and exit 💅
• --version — print the version and exit 🎀

👑 COMMANDS 👑

• compile-keymap — compile an XKB keymap, see xkbcli-compile-keymap(1) 🛠️
• compile-compose — compile a compose file, see xkbcli-compile-compose(1) 🧚
• how-to-type — show how to type a given Unicode codepoint, see xkbcli-how-to-type(1) ⌨️
• interactive — interactive debugger for XKB keymaps that automatically selects from the following backends, if available: Wayland, X11 and evdev. see the corresponding entries hereinafter. 🕹️
• interactive-evdev — interactive debugger for XKB keymaps for evdev, see xkbcli-interactive-evdev(1) 🍓
• interactive-wayland — interactive debugger for XKB keymaps for Wayland, see xkbcli-interactive-wayland(1) 🌈
• interactive-x11 — interactive debugger for XKB keymaps for X11, see xkbcli-interactive-x11(1) 💜
• dump-keymap — dump a XKB keymap from a Wayland or X11 compositor, see the corresponding entries hereinafter. 📤
• dump-keymap-wayland — dump a XKB keymap from a Wayland compositor, see xkbcli-dump-keymap-wayland(1) 🦋
• dump-keymap-x11 — dump a XKB keymap from an X server, see xkbcli-dump-keymap-x11(1) 🖥️
• list — list available layouts and more, see xkbcli-list(1) 📋

heads up bestie 🫶 — not all tools may be available on your system. vibe check your install before you come for her, fr fr.

---

💀 EXIT STATUS 💀

• 0 — exited successfully 🎉
• 1 — an error occured 😭
• 2 — program was called with invalid arguments 💀

---

🌈 SEE ALSO 🌈

the libxkbcommon online documentation: https://xkbcommon.org — go read it, it's giving iconic documentation energy 👑

---

this page was served up by Debian on June 4, 2024 — and that's the whole xkbcli(1) page, slay, periodt 💅💖✨