From fd0d7d0907fcb8783c4bd2fbbd8c8812f3ba1494 Mon Sep 17 00:00:00 2001
From: Drew DeVault <sir@cmpwn.com>
Date: Fri, 22 Feb 2019 13:58:52 -0500
Subject: Add FreeRDP backend for remote desktop support

---
 docs/env_vars.md | 51 +++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 41 insertions(+), 10 deletions(-)

(limited to 'docs')

diff --git a/docs/env_vars.md b/docs/env_vars.md
index 04c5aa85..81f69b90 100644
--- a/docs/env_vars.md
+++ b/docs/env_vars.md
@@ -1,7 +1,7 @@
 wlroots reads these environment variables
 
-wlroots specific
-----------------
+# wlroots specific
+
 * *WLR_DRM_DEVICES*: specifies the DRM devices (as a colon separated list)
   instead of auto probing them. The first existing device in this list is
   considered the primary DRM device.
@@ -12,23 +12,54 @@ wlroots specific
 * *WLR_LIBINPUT_NO_DEVICES*: set to 1 to not fail without any input devices
 * *WLR_BACKENDS*: comma-separated list of backends to use (available backends:
   wayland, x11, headless, noop)
-* *WLR_WL_OUTPUTS*: when using the wayland backend specifies the number of outputs
-* *WLR_X11_OUTPUTS*: when using the X11 backend specifies the number of outputs
-* *WLR_HEADLESS_OUTPUTS*: when using the headless backend specifies the number
-  of outputs
 * *WLR_NO_HARDWARE_CURSORS*: set to 1 to use software cursors instead of
   hardware cursors
 * *WLR_SESSION*: specifies the wlr\_session to be used (available sessions:
   logind/systemd, direct)
 * *WLR_DIRECT_TTY*: specifies the tty to be used (instead of using /dev/tty)
 
-rootston specific
-------------------
+# Headless backend
+
+* *WLR_HEADLESS_OUTPUTS*: when using the headless backend specifies the number
+  of outputs
+
+# RDP backend
+
+* *WLR_RDP_TLS_CERT_PATH*: required when using `wlr_backend_autocreate`,
+  specifies the path to the TLS certificate to use for encrypting connections
+* *WLR_RDP_TLS_KEY_PATH*: required when using `wlr_backend_autocreate`,
+  specifies the path to the TLS private key to use for encrypting connections
+* *WLR_RDP_ADDRESS*: the IP address to bind to, defaults to `127.0.0.1`
+* *WLR_RDP_PORT*: the port to bind to, defaults to 3389.
+
+Note: a TLS certificate and key can be generated like so:
+
+```
+$ openssl genrsa -out tls.key 2048
+$ openssl req -new -key tls.key -out tls.csr
+$ openssl x509 -req -days 365 -signkey tls.key -in tls.csr -out tls.crt
+```
+
+`tls.csr` can be discarded. Connecting to the RDP backend with xfreedrp can be
+done like so:
+
+	xfreerdp -v localhost --bpp 32 --size 1920x1080 --rfx
+
+# Wayland backend
+
+* *WLR_WL_OUTPUTS*: when using the wayland backend specifies the number of outputs
+
+# X11 backend
+
+* *WLR_X11_OUTPUTS*: when using the X11 backend specifies the number of outputs
+
+# Rootston specific
+
 * *XKB_DEFAULT_RULES*, *XKB_DEFAULT_MODEL*, *XKB_DEFAULT_LAYOUT*,
   *XKB_DEFAULT_VARIANT*, *XKB_DEFAULT_OPTIONS*: xkb setup
 
-generic
--------
+# Generic
+
 * *DISPLAY*: if set probe X11 backend in *wlr_backend_autocreate*
 * *WAYLAND_DISPLAY*, *_WAYLAND_DISPLAY*, *WAYLAND_SOCKET*: if set probe Wayland
   backend in *wlr_backend_autocreate*
-- 
cgit v1.2.3