cage(1)

📦
version 0.3.1 · 14 versions
, in arch rolling

💅 cage — a Wayland kiosk compositor ✨

okay so bestie, this is cage(1), from the General Commands Manual section — and honestly? she's giving minimal but mighty. let's get into it 🫶

✨ NAME ✨

cage — a Wayland kiosk compositor 🎀

🌸 SYNOPSIS 🌸

cage [options...] [--] [application...]

💖 DESCRIPTION 💖

okay so here's the whole vibe: Cage runs a single, maximized application. that's her thing. that's her whole personality. 👑

now, technically Cage can run multiple applications — like, she's capable — but only a single one is visible at any point in time. so don't get any ideas about split screens, bestie, because that's not happening. 🙈

and the way she locks it down? user interaction and activities outside the scope of the running application are prevented. literally nothing else gets to steal the spotlight. main character energy only. periodt. 💅

🦋 OPTIONS 🦋

  • -d — Don't draw client side decorations when possible. like, no window trim, no extra garnish, nothing. just vibes. ✨
  • -D — Enable debug logging. for when you need to know exactly what's going on in there. 🔍
  • -h — Show the help message. the classic cry for help, but make it documentation. 😭
  • -m <mode> — Set the multi-monitor behavior. the supported modes are:
    • last — Cage uses only the last connected monitor. one monitor, one queen. 👑
    • extend — Cage extends the display across all connected monitors. the whole squad gets a spot. 🔥
  • -s — Allow VT switching. so you can hop between virtual terminals instead of being trapped forever. 💀
  • -v — Show the version number and exit. quick little flex, then she's out. 🌈

🌼 ENVIRONMENT 🌼

  • DISPLAY — If compiled with Xwayland support, this will be set to the name of the X display used for Xwayland. Otherwise, probe the X11 backend. (yes, this is a whole conditional situation, keep up bestie 💜)
  • WAYLAND_DISPLAY — Specifies the name of the Wayland display that Cage is running on. 🖥️
  • XCURSOR_PATH — Directory where cursors are located. where all the little arrows live. 🏠
  • XCURSOR_SIZE — Specifies the configured cursor size. big cursor, small cursor, your call. 🎀
  • XCURSOR_THEME — Specifies the configured cursor theme. the aforementioned cursor's whole aesthetic. 💅
  • XKB_DEFAULT_RULES, XKB_DEFAULT_MODEL, XKB_DEFAULT_LAYOUT, XKB_DEFAULT_VARIANT, XKB_DEFAULT_OPTIONS — Configures the xkb keyboard settings. See xkeyboard-config(7). ⌨️✨

⭐ SEE ALSO ⭐

💀 BUGS 💀

found something cursed? report bugs at https://github.com/cage-kiosk/cage — the devs will thank you, no cap. 🫶

👑 AUTHORS 👑

Jente Hidskes <dev@hjdskes.nl> — the icon behind the kiosk. 🌟

ngl if you got all the way down here you're officially a Cage expert. tell nobody. or tell everyone. iykyk. 🦋

okay so that's the whole page bestie — it's cage(1) from the General Commands Manual, dated 2026-07-05, and that's a wrap! 🌸💖🎀

📦 where this page comes from