From 1c0f55d172aa2e5928a627d86106dc6153e7ceb0 Mon Sep 17 00:00:00 2001 From: Jente Hidskes Date: Sun, 26 Jan 2020 16:03:05 +0100 Subject: [PATCH] Move docs to the wiki --- README.md | 8 ++++---- docs/env_vars.md | 35 ----------------------------------- 2 files changed, 4 insertions(+), 39 deletions(-) delete mode 100644 docs/env_vars.md diff --git a/README.md b/README.md index 787226d..8c702ec 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/env_vars.md b/docs/env_vars.md deleted file mode 100644 index c24a14f..0000000 --- a/docs/env_vars.md +++ /dev/null @@ -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.