XKBCLI-INTERACTIVE-EVDEV(1)

💖 xkbcli-interactive-evdev 💖

okay bestie, welcome to the General Commands Manual section, because this little cutie is a general command and we're gonna treat her like the icon she is 💅

---

✨ NAME ✨

xkbcli-interactive-evdev — interactive debugger for X Keyboard keymaps 🎹🦋

---

🌸 SYNOPSIS 🌸

xkbcli-interactive-evdev [options] [KEYMAP_PATH]

---

🫶 DESCRIPTION 🫶

so like, xkbcli-interactive-evdev is a commandline tool that lets you interactively debug XKB keymaps, and the way it does that is by listening to /dev/input/eventX evdev devices 👀 literally just vibing on your input devices and telling you what's up.

heads up though: xkbcli-interactive-evdev requires permission to open the evdev device nodes. that usually means you gotta be the “root” user, or be a member of the “input” group. no permission, no party 😭

when you're done, press the ⟨Escape⟩ key to exit. that's the whole escape plan, bestie 🏃♀️

⚠️ real talk: this is a debugging tool, and its behavior or output is not guaranteed to be stable. do not build your whole personality around it. it's giving "works on my machine" energy and that's on purpose.

---

👑 OPTIONS 👑

• KEYMAP_PATH — path to a keymap file, or “-” to read from standard input 🍓
• --help — prints help and dips out. slay.
• --verbose — turns on verbose debugging output. more words, more drama, more info 🔥
• --include PATH — adds the given path to the include path list. this option is order-dependent, so include paths given first are searched first — first come, first served, periodt. 💅 if an include path is given, the default include path list is not used. so if you want those defaults back, hit up --include-defaults.
• --include-defaults — adds the default set of include directories. also order-dependent: include paths given first are searched first. 🧚
• --format keymap_format — specifies the keymap format (numeric or label, e.g. “v1”) 📝
• --rules rules — the XKB ruleset
• --model model — the XKB model
• --layout layout — the XKB layout
• --variant variant — the XKB layout variant
• --option options — the XKB options
• --enable-environment-names — allows you to set the default RMLVO values via these environment variables, bestie:
  • XKB_DEFAULT_RULES
  • XKB_DEFAULT_MODEL
  • XKB_DEFAULT_LAYOUT
  • XKB_DEFAULT_VARIANT
  • XKB_DEFAULT_OPTIONS

note: this option may affect the default values of the previous options. yes, the previous ones. they're all connected, iykyk 🌈

• --keymap file — specifies a keymap path. this option is mutually exclusive with the RMLVO options. pick a lane, choose your fighter 🥊
• --enable-compose — enables Compose functionality ✨
• --consumed-mode {xkb|gtk} — sets the consumed modifiers mode (default: xkb) 💜
• --without-x11-offset — doesn't add an offset of 8 when converting an evdev keycode to an XKB keycode. and like… you probably don't want this option. genuinely. 🙈
• --report-state-changes — reports changes to the keyboard state 📢
• -1, --uniline — enables uniline event output. one line, one vibe.
• --multiline — enables multiline event output. many lines, still one vibe.
• --short — prints shorter event output. minimalism era 🎀

---

🔍 SEE ALSO 🔍

• xkbcli(1)
• xkbcli-interactive-wayland(1)
• xkbcli-interactive-x11(1)
• The libxkbcommon online documentation: https://xkbcommon.org

---

and that's the whole page, bestie!! this one came from Debian, dated June 4, 2024, and it's page XKBCLI-INTERACTIVE-EVDEV(1) of the manual. go forth and debug your keymaps, main character 🦋💖 periodt.