cage/cage.1.scd

73 lines
1.6 KiB
Text
Raw Normal View History

cage(1)
# NAME
2020-07-16 15:41:31 +02:00
cage - a Wayland kiosk compositor
# SYNOPSIS
2020-07-16 15:41:31 +02:00
*cage* [-dhmrsv] [--] _application_ [application argument ...]
# 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.
*-h*
Show the help message.
2020-05-31 16:20:59 +02:00
*-m* <mode>
2020-07-16 15:41:31 +02:00
Set the multi-monitor behavior. Supported modes are:
2020-05-31 16:20:59 +02:00
*last* Cage uses only the last connected monitor.
*extend* Cage extends the display across all connected monitors.
*-r*
2020-07-16 15:41:31 +02:00
Rotate the output 90 degrees clockwise. This can be specified up to three
times, each resulting in an additional 90 degrees clockwise rotation.
2020-07-16 15:41:31 +02:00
*-s*
2020-07-16 16:25:19 +02:00
Allow VT switching
2020-07-16 15:41:31 +02:00
*-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).
# SEE ALSO
*xkeyboard-config(7)*
# BUGS
Report bugs at https://github.com/Hjdskes/cage
# AUTHORS
Jente Hidskes <dev@hjdskes.nl>