---
name: "cage"
section: "1"
platform: "linux"
package: "cage"
version: "0.3.1-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/cage"
---

# cage(1)

a Wayland kiosk compositor

## NAME

cage - a Wayland kiosk compositor

## SYNOPSIS

**cage** \[options...\] \[--\] \[*application*...\]

## DESCRIPTION

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)](/xkeyboard-config/7.md).

## SEE ALSO

**[xkeyboard-config(7)](/xkeyboard-config/7.md)**

## BUGS

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

## AUTHORS

Jente Hidskes \<dev@hjdskes.nl\>
