summaryrefslogtreecommitdiff
path: root/README.wayland
diff options
context:
space:
mode:
authorMike Blumenkrantz <zmike@osg.samsung.com>2015-08-19 13:33:43 -0400
committerMike Blumenkrantz <zmike@osg.samsung.com>2015-08-19 13:33:57 -0400
commitb36f79aa55e84970c3faec60c71b5e314782c736 (patch)
treec7c84cbbb31fa4e86213eb6a0fe4b80906955fdc /README.wayland
parentf53fd254aa0603555a1b3fcfaf7f6b73728765e3 (diff)
update wayland readme with current information
Diffstat (limited to 'README.wayland')
-rw-r--r--README.wayland113
1 files changed, 36 insertions, 77 deletions
diff --git a/README.wayland b/README.wayland
index 8a9ea13e1..e91fe0927 100644
--- a/README.wayland
+++ b/README.wayland
@@ -1,20 +1,17 @@
1Wayland support in Enlightenment 1*Wayland support in Enlightenment*
2 2
3Caution: Support for running Enlightenment in a Wayland-Only 3Running Enlightenment as a Wayland compositor is not considered "safe"
4configuration is considered Highly Experimental !! Use at your own 4for everyday desktop use, though it is functional enough to test or
5risk !! We are not responsible if it nukes your files, burns up your cpu, 5use in specialized environments.
6kills your cat, sells your house, divorces you, or otherwise messes 6A list of known issues can be found at the bottom of this file.
7Anything up !
8
9Use at your own risk !! You have been warned !!
10 7
11 8
12Requirements: 9Requirements:
13------------- 10-------------
14 11
15Aside from the normal requirements that Enlightenment needs, there are 12Aside from the normal requirements that Enlightenment needs, there are
16a few things to note in order to get Enlightenment to build without 13a few things to note in order to get Enlightenment to build with
17X11 support. 14Wayland support.
18 15
19Firstly, you MUST have EFL built with the following options: 16Firstly, you MUST have EFL built with the following options:
20 17
@@ -38,12 +35,6 @@ If you would like support for EGL in Wayland, then also build EFL with:
38The above options can be enabled for EFL without any adverse effects to 35The above options can be enabled for EFL without any adverse effects to
39existing applications. 36existing applications.
40 37
41Wayland-Only:
42-------------
43
44If you wish to test out the Highly Experimental standalone
45Wayland-Only (no X11) compositor, then read below about how to compile
46support for a wayland-only Enlightenment.
47 38
48Compiling: 39Compiling:
49------------- 40-------------
@@ -51,27 +42,11 @@ Compiling:
51Next, you will need to adjust the options that you pass to 42Next, you will need to adjust the options that you pass to
52Enlightenment during the compile phase. 43Enlightenment during the compile phase.
53 44
54Please note, we recommend installing This version of Enlightenment into it's
55own separate prefix so that you can still safely fallback to the X11 version.
56
57This can be done by passing:
58
59 --prefix=<some_other_install_location>
60 --with-systemdunitdir=<some_other_install_location>/some/path
61
62Now, on to the magic bits ;)
63
64In order for Enlightenment to be compiled as Wayland compositor you will need to 45In order for Enlightenment to be compiled as Wayland compositor you will need to
65pass a few more options to the configure stage of Enlightenment: 46pass an option to the configure stage of Enlightenment:
66 47
67 --enable-wayland 48 --enable-wayland
68 49
69Since this is all still a work-in-progress, there are a few Enlightenment
70modules that have not been "fixed" to work without X11 yet.
71Those will need to be disabled if you enabled the wayland-only option:
72
73 --disable-xkbswitch
74
75If you also want support for running X applications under Wayland you might want 50If you also want support for running X applications under Wayland you might want
76to try out XWayland support: 51to try out XWayland support:
77 52
@@ -85,57 +60,41 @@ Usage:
85------------- 60-------------
86 61
87Hopefully at this stage you have successfully built EFL and 62Hopefully at this stage you have successfully built EFL and
88Enlightenment in preparation for a Wayland-only setup. Congratulations 63Enlightenment in preparation for a Wayland-supported setup. Congratulations!!
89!! Now, let's get it running... 64Now, let's get it running...
90
91The following steps assume you are currently at a Virtual Terminal
92without anything else running (ie: no other window managers, X11, etc).
93 65
94In order for Enlightenment to function without X11, we need to setup 66Enlightenment, when compiled with Wayland support and started from a tty,
95the environment. In your current tty, do: 67will automatically attempt to load the wl_drm output module and start
96 68a Wayland session. Simply start as usual:
97 export E_WL_FORCE=drm
98 export ELM_DISPLAY=wl
99 export ELM_ACCEL=opengl (or 'none' for SHM engine)
100
101This will make sure that Enlightenment renders using DRM, and any
102Elementary applications use a Wayland engine.
103
104At this point, you should just be able 'cd' to the Enlightenment
105prefix where you installed, and issue:
106 69
107 ./enlightenment_start 70 ./enlightenment_start
108 71
109Please Note: It is suggested that you create a separate configuration 72If you have a separate configuration profile that you would like to use,
110profile with only a Minimum of modules loaded. Due to the experimental 73you can tell Enlightenment to use that when you start it:
111(and ongoing) status of Wayland-Only support in Enlightenment, Many
112modules May Not Work. Very few have actually been tested yet !!
113
114If you have a separate configuration profile (as suggested) that you
115would like to use, you can tell Enlightenment to use that when you
116start it:
117 74
118 ./enlightenment_start -profile <my_profile> 75 ./enlightenment_start -profile <my_profile>
119 76
120 77
121Notes:
122-------------
123 78
124Please Note: There is currently NO support for running X11 79Known Issues
125applications with this !! So basically, your web browsers won't work,
126don't expect to be able to run Firefox, Thunderbird, or practically
127Any Other X11 application yet. About the only things "known" to work
128so far are EFL/Elementary applications.
129
130
131Bugs:
132------------- 80-------------
133 81* Internal window (eg. filemanager), DnD is not currently functional
134Yes, there are Lots of them !! 82 - Requires EFL 1.16 release
135Yes, I am already aware of 99.9% of them. 83* Nested compositors (wl_wl output) cannot create internal windows
136Yes, you can start reporting them ... if you do create tickets for 84 - Requires EFL 1.16 release
137any bugs, please note in your ticket that you are using the e_comp_wl 85* DRM output lacks hardware acceleration
138branch. 86 - Requires EFL 1.16 release
139 87* Window close animations will not play for most Wayland clients
140When we feel that the work is reaching a "finalizing" stage, we will 88 - Requires upstream Wayland protocol additions
141put out a request for actual testers and bug reports ! 89* Window closing occasionally leads to crash
90 - Requires upstream Wayland protocol additions
91* Restarting Enlightenment kills all open applications
92 - Requires upstream *-shell protocol additions, XWayland improvements
93* Window placement/resistance/resizing is not accurate
94 - Requires upstream *-shell protocol additions related to CSD
95* XWayland clients do not smoothly resize
96 - Requires upstream XWayland improvements
97* The first-launched X11 client will sometimes fail to show
98 - Requires upstream XWayland improvements
99* Keyboard layout switching is not available
100 - Requires various improvements