cage/cage.1.scd
Patrick Steinhardt b904d15290 cage: optionally return exitcode of primary client
Some applications indicate different shutdown conditions by returning
specific exit codes. One of these is e.g. Kodi, which returns 64 in case
the user chose "Power off" and 66 in case the user chose "Reboot".
In order to act on these exit codes, it thus makes sense in some
situations to pass them on from the primary client to the caller of
Cage.

Add a new flag "-e". If it's set and Cage shutso down because of an
orderly exit of its primary client, then it causes Cage to return the
primary client's exit code instead of its own one.
2020-10-01 17:40:53 +02:00

76 lines
1.7 KiB
Markdown

cage(1)
# NAME
cage - a Wayland kiosk compositor
# SYNOPSIS
*cage* [-dehmrsv] [--] _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.
*-e*
Return the primary client's exit code if Cage shuts down because of the
client exiting.
*-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.
*-r*
Rotate the output 90 degrees clockwise. This can be specified up to three
times, each resulting in an additional 90 degrees clockwise rotation.
*-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).
# SEE ALSO
*xkeyboard-config(7)*
# BUGS
Report bugs at https://github.com/Hjdskes/cage
# AUTHORS
Jente Hidskes <dev@hjdskes.nl>