From ecd5d5bf5c687efedf86f66c0d40d9534275dd0a Mon Sep 17 00:00:00 2001 From: Juan Cruz Viotti Date: Thu, 4 Aug 2016 14:03:36 -0400 Subject: [PATCH] docs(GUI): running Etcher on Wayland (#624) This entry roughly documents how to get Etcher running on Wayland by using the XWayland Server. Fixes: https://github.com/resin-io/etcher/issues/509 Signed-off-by: Juan Cruz Viotti --- docs/USER-DOCUMENTATION.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/USER-DOCUMENTATION.md b/docs/USER-DOCUMENTATION.md index 03223d34..2e9baaee 100644 --- a/docs/USER-DOCUMENTATION.md +++ b/docs/USER-DOCUMENTATION.md @@ -47,4 +47,22 @@ Refer to [the following message from Ubuntu's mailing list](https://lists.ubuntu.com/archives/ubuntu-devel/2011-June/033495.html) if you want to learn more. +Running on Wayland +------------------ + +Electron is based on Gtk2, which can't run natively on Wayland. Fortunately, +the [XWayland Server][xwayland] provides backwards compatibility to run *any* X +client on Wayland, including Etcher. + +This usually works out of the box on mainstream GNU/Linux distributions that +properly support Wayland. If it doesn't, make sure the `xwayland.so` module is +being loaded by declaring it in your [weston.ini]: + +``` +[core] +modules=xwayland.so +``` + [appimage]: http://appimage.org +[xwayland]: https://wayland.freedesktop.org/xserver.html +[weston.ini]: http://manpages.ubuntu.com/manpages/wily/man5/weston.ini.5.html