cage(1)

cage1

A wayland kiosk compositor

Usage

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

Overview

Cage runs a single, maximized application. Cage can run multiple applications, but only a single one is visible at any point in time. User interaction and activities outside the scope of the running application are prevented.

Options

-d

Don't draw client side decorations when possible.

-D

Enable debug logging.

-h

Show the help message.

-m <mode>

Set the multi-monitor behavior. Supported modes are: last Cage uses only the last connected monitor. extend Cage extends the display across all connected monitors.

-s

Allow VT switching

-v

Show the version number and exit.

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.

WAYLAND_DISPLAY

Specifies the name of the Wayland display that Cage is running on.

XCURSOR_PATH

Directory where cursors are located.

XCURSOR_SIZE

Specifies the configured cursor size.

XCURSOR_THEME

Specifies the configured cursor theme.

XKB_DEFAULT_RULES, XKB_DEFAULT_MODEL, XKB_DEFAULT_LAYOUT, XKB_DEFAULT_VARIANT, XKB_DEFAULT_OPTIONS

Configures the xkb keyboard settings. See xkeyboard-config(7).

Releases

3 releases since Debian 12 (Bookworm); the text changed 2 times.

  1. 12
  2. 13
  3. Arch

-D since Arch Linux 2026-11-01.

-r until Debian 12 (Bookworm).

Bugs

Report bugs at https://github.com/cage-kiosk/cage

Authors

Jente Hidskes <[email protected]>

From cage 0.3.1-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.