README.wayland

   1 *Wayland support in Enlightenment*
   2
   3 Running Enlightenment as a Wayland compositor is not considered "safe"
   4 for everyday desktop use, though it is functional enough to test or
   5 use in specialized environments.
   6 A list of known issues can be found at the bottom of this file.
   7
   8
   9 Requirements:
  10 -------------
  11
  12 Aside from the normal requirements that Enlightenment needs, there are
  13 a few things to note in order to get Enlightenment to build with
  14 Wayland support.
  15
  16 Firstly, you MUST have EFL built with the following options:
  17
  18   --enable-drm
  19   --enable-wayland
  20   --enable-systemd
  21
  22 Note that the drm engine will not be functional unless the target system
  23 has libsystemd-login installed.
  24
  25 This Readme does not address the dependencies needed to enable Wayland
  26 in EFL. If you require any information for that, please see:
  27
  28   https://phab.enlightenment.org/w/wayland/
  29
  30 If you would like support for EGL in Wayland, then also build EFL with:
  31
  32   --enable-egl
  33   --with-opengl=es
  34
  35 The above options can be enabled for EFL without any adverse effects to
  36 existing applications.
  37
  38
  39 Compiling:
  40 -------------
  41
  42 Next, you will need to adjust the options that you pass to
  43 Enlightenment during the compile phase.
  44
  45 In order for Enlightenment to be compiled as Wayland compositor you will need to
  46 pass an option to the configure stage of Enlightenment:
  47
  48   --enable-wayland
  49
  50 If you also want support for running X applications under Wayland you might want
  51 to try out XWayland support:
  52
  53   --enable-xwayland
  54
  55 NOTE: DO NOT DISABLE THE MIXER MODULE BUILD IF YOU ARE USING XWAYLAND.
  56 You have been warned.
  57
  58 At this stage, you should have EFL properly built, and Enlightenment
  59 properly built. Let's move on to running it...
  60
  61
  62 Usage:
  63 -------------
  64
  65 Hopefully at this stage you have successfully built EFL and
  66 Enlightenment in preparation for a Wayland-supported setup. Congratulations!!
  67 Now, let's get it running...
  68
  69 Enlightenment, when compiled with Wayland support and started from a tty,
  70 will automatically attempt to load the wl_drm output module and start
  71 a Wayland session. Simply start as usual:
  72
  73   ./enlightenment_start
  74
  75 If you have a separate configuration profile that you would like to use,
  76 you can tell Enlightenment to use that when you start it:
  77
  78   ./enlightenment_start -profile <my_profile>
  79
  80 To run a wayland session inside x11, export E_WL_FORCE=x11 before starting
  81 enlightenment.
  82
  83 Known Issues
  84 -------------
  85 * Internal window (eg. filemanager), DnD is not currently functional
  86  - Requires new EFL release
  87 * Nested compositors (wl_wl output) cannot create internal windows
  88  - Requires new EFL release
  89 * Window close animations will not play for most Wayland clients
  90  - Requires upstream Wayland protocol additions
  91 * Restarting Enlightenment kills all open applications
  92  - Requires upstream *-shell protocol additions, XWayland improvements
  93 * XWayland clients do not smoothly resize
  94  - Requires upstream XWayland improvements
  95 * The first-launched X11 client will sometimes fail to show
  96  - Requires upstream XWayland improvements
  97 * Keyboard layout switching is not available
  98  - Requires various improvements