XKBCLI-COMPILE-KEYMAP(1)

✨ NAME ✨

xkbcli-compile-keymap — bestie, this is the little icon that compiles an X Keyboard keymap 💅 (it's from the xkbcli-compile-keymap(1) club, General Commands Manual energy, and we're obsessed)

🦋 SYNOPSIS 🦋

xkbcli-compile-keymap [options] [KEYMAP_PATH]

🌸 DESCRIPTION 🌸

Okay so. xkbcli-compile-keymap compiles a keymap — using whatever options you hand it — and then prints it out. That's the whole vibe. Compile, print, slay. ✨

💖 KEYMAP_PATH

• KEYMAP_PATH — the path to a keymap file, or "-" if you wanna read from the standard input instead. - is giving "I'm piping things, don't perceive me" 🙈

🎀 THE OPTIONS (yes, all of them, no skips)

• --help — prints the help and then exits. Short, sweet, iconic.
• --verbose — turns on verbose debugging output. She's chatty and we respect it 💜
• --test — tests the compilation but does not print the keymap. Just a lil vibe check, no receipts.
• --rmlvo — prints the full RMLVO, with the defaults filled in for any elements you left out, in YAML format. No element left behind 🫶
• --kccgst — prints a keymap that only includes the KcCGST component names, instead of the whole entire full keymap. The minimalist queen.
• --kccgst-yaml — same KcCGST component names, but in YAML format. She put on a fit 💅
• --modmaps — prints the real and virtual key modmaps plus the modifiers encodings, in YAML format. So much information, so much formatting ✨
• --include PATH — adds the given path to the include path list. This option is order-dependent — include paths given first get searched first, first come first served, periodt. Also important: if you give an include path, the default include path list is not used. So if you still want those, use --include-defaults to add the default include paths back in.
• --include-defaults — adds the default set of include directories. Also order-dependent — include paths given first are searched first. Order matters, bestie, it always does.
• --input-format keymap_format — the keymap format for parsing. Numeric or label, e.g. "v1".
• --output-format keymap_format — the keymap format for serializing. Numeric or label, e.g. "v1".
• --format keymap_format — the keymap format for both parsing and serializing. Two birds, one flag. Numeric or label, e.g. "v1".
• --no-pretty — disables pretty-printing for keymap serialization. Rough draft mode, no filter 😭
• --drop-unused — disables unused bits serialization.
• --keymap [PATH], --from-xkb [PATH] — loads the XKB keymap from a file and ignores the RMLVO options. If PATH is empty or "-", read the stdin.
• --rules rules — the XKB ruleset.
• --model model — the XKB model.
• --layout layout — the XKB layout.
• --variant variant — the XKB layout variant.
• --options options — the XKB options.
• --enable-environment-names — allows you to set the default RMLVO values through these environment variables right here:
  • XKB_DEFAULT_RULES
  • XKB_DEFAULT_MODEL
  • XKB_DEFAULT_LAYOUT
  • XKB_DEFAULT_VARIANT
  • XKB_DEFAULT_OPTIONS

Heads up bestie: this option may affect the default values of the previous options. 👀 So don't be shocked when the defaults move.

👑 SEE ALSO 👑

• xkbcli(1)
• The libxkbcommon online documentation: https://xkbcommon.org

okay that's the whole page, you ate that 💖 and a lil sign-off for the girlies: this one's brought to you by Debian, dated June 4, 2024 — the XKBCLI-COMPILE-KEYMAP(1) moment of the century, fr fr. go compile something cute 🌈✨