mirrors/cage
1
0
Fork 0
mirror of https://github.com/cage-kiosk/cage.git synced 2026-03-18 05:34:42 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document environment variables

Browse source 
Fixes #93.
This commit is contained in:
Jente Hidskes 2019-12-20 16:37:07 +01:00
parent dd87c1fab5
commit 90e70c6882
1 changed files with 35 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

35
docs/env_vars.md Normal file
View file

@ -0,0 +1,35 @@
# Environment variables
Cage sets the following environment variables:
* `DISPLAY`: if compiled with Xwayland support, this will be set to the name of
the X display used for Xwayland.
* `WAYLAND_DISPLAY`: specifies the name of the Wayland display that Cage is
running on.
The following environment variables can be used to configure behavior of
libraries that Cage uses. Effectively, these environment variables configure
the Cage session.
## XKB environment variables
```
XKB_DEFAULT_RULES
XKB_DEFAULT_MODEL
XKB_DEFAULT_LAYOUT
XKB_DEFAULT_VARIANT
XKB_DEFAULT_OPTIONS
```
These environment variables configure the XKB keyboard settings. See
xkeyboard-config(7).
## Wlroots environment variables
* `DISPLAY`: if set probe X11 backend.
* `WAYLAND_DISPLAY`, `_WAYLAND_DISPLAY`, `WAYLAND_SOCKET`: if set probe Wayland
backend.
* `XCURSOR_PATH`: directory where xcursors are located.
For a complete list of wlroots environment variables, see
https://github.com/swaywm/wlroots/blob/master/docs/env_vars.md.