.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "cage" "1" "2024-10-26"
.PP
.SH NAME
.PP
cage - a Wayland kiosk compositor
.PP
.SH SYNOPSIS
.PP
\fBcage\fR [-dhmrsv] [--] \fIapplication\fR [application argument .\&.\&.\&]
.PP
.SH DESCRIPTION
.PP
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.\&
.PP
.SH OPTIONS
.PP
\fB-d\fR
.RS 4
Don'\&t draw client side decorations when possible.\&
.PP
.RE
\fB-h\fR
.RS 4
Show the help message.\&
.PP
.RE
\fB-m\fR <mode>
.RS 4
Set the multi-monitor behavior.\& Supported modes are:
\fBlast\fR Cage uses only the last connected monitor.\&
\fBextend\fR Cage extends the display across all connected monitors.\&
.PP
.RE
\fB-s\fR
.RS 4
Allow VT switching
.PP
.RE
\fB-v\fR
.RS 4
Show the version number and exit.\&
.PP
.RE
.SH ENVIRONMENT
.PP
\fIDISPLAY\fR
.RS 4
If compiled with Xwayland support, this will be set to the name of the
X display used for Xwayland.\& Otherwise, probe the X11 backend.\&
.PP
.RE
\fIWAYLAND_DISPLAY\fR
.RS 4
Specifies the name of the Wayland display that Cage is running on.\&
.PP
.RE
\fIXCURSOR_PATH\fR
.RS 4
Directory where cursors are located.\&
.PP
.RE
\fIXCURSOR_SIZE\fR
.RS 4
Specifies the configured cursor size.\&
.PP
.RE
\fIXCURSOR_THEME\fR
.RS 4
Specifies the configured cursor theme.\&
.PP
.RE
\fIXKB_DEFAULT_RULES\fR, \fIXKB_DEFAULT_MODEL\fR, \fIXKB_DEFAULT_LAYOUT\fR,
\fIXKB_DEFAULT_VARIANT\fR, \fIXKB_DEFAULT_OPTIONS\fR
.RS 4
Configures the xkb keyboard settings.\& See \fBxkeyboard-config\fR(7).\&
.PP
.RE
.SH SEE ALSO
.PP
\fBxkeyboard-config(7)\fR
.PP
.SH BUGS
.PP
Report bugs at https://github.\&com/cage-kiosk/cage
.PP
.SH AUTHORS
.PP
Jente Hidskes <dev@hjdskes.\&nl>