mirrors/cage
1
0
Fork 0
mirror of https://github.com/cage-kiosk/cage.git synced 2025-10-29 05:40:19 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Move docs to the wiki

Browse source
This commit is contained in:
Jente Hidskes 2020-01-26 16:03:05 +01:00
parent a63c75c849
commit 5e27683961
2 changed files with 4 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -5,9 +5,9 @@
This is Cage, a Wayland kiosk. A kiosk runs a single, maximized
application.
This README is only relevant for development resources and
instructions. For a description of Cage and installation instructions
for end-users, please see [its project
This README is only relevant for development resources and instructions. For a
description of Cage and installation instructions for end-users, please see
[the Wiki](https://github.com/Hjdskes/cage/wiki/) and [its project
page](https://www.hjdskes.nl/projects/cage).
## Release signatures
@ -43,7 +43,7 @@ a TTY, it'll run with the KMS+DRM backend. In debug mode (default
build type with Meson), press Alt+Esc to quit. To build a release
build, use `meson build --buildtype=release`.
For more information, see the `docs/` folder.
For more information, see the [Wiki](https://github.com/Hjdskes/cage/wiki).
Cage is based on the annotated source of tinywl and rootston.

35
docs/env_vars.md
View file

@ -1,35 +0,0 @@
# 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.