summaryrefslogtreecommitdiff
path: root/README.wayland
diff options
context:
space:
mode:
authorChris Michael <cp.michael@samsung.com>2014-03-18 09:11:28 +0000
committerChris Michael <cp.michael@samsung.com>2014-03-18 09:11:28 +0000
commit5515f1971cbebb920bd3a9d6b5917e58daf45b05 (patch)
treedc65304a650398836f5a06de378c7dcbe1d51a64 /README.wayland
parent5c322c40c40d2188c484e75362fa40f4de058a57 (diff)
Add a README for Wayland-only support
Signed-off-by: Chris Michael <cp.michael@samsung.com>
Diffstat (limited to 'README.wayland')
-rw-r--r--README.wayland133
1 files changed, 133 insertions, 0 deletions
diff --git a/README.wayland b/README.wayland
new file mode 100644
index 000000000..e383f2733
--- /dev/null
+++ b/README.wayland
@@ -0,0 +1,133 @@
1Wayland support in Enlightenment 0.19.0
2
3Caution: Support for running Enlightenment in a Wayland-Only
4configuration is considered Highly Experimental !! Use at your own
5risk !! We are not responsible if it nukes your files, burns up your cpu,
6kills your cat, sells your house, divorces you, or otherwise messes
7Anything up !
8
9Use at your own risk !! You have been warned !!
10
11
12Requirements:
13-------------
14
15Aside from the normal requirements that Enlightenment needs, there are
16a few things to note in order to get Enlightenment to build without
17X11 support.
18
19Firstly, you MUST have EFL built with the following options:
20
21 --enable-drm
22 --enable-wayland
23
24This Readme does not address the dependencies needed to enable Wayland
25in EFL. If you require any information for that, please see:
26
27 https://phab.enlightenment.org/w/wayland/
28
29If you would like support for EGL in Wayland, then also build EFL with:
30
31 --enable-egl
32 --with-opengl=es
33
34The above options can be enabled for EFL without any adverse effects to
35existing applications.
36
37
38Next, you will need to adjust the options that you pass to
39Enlightenment during the compile phase.
40
41Please note, we recommend installing This version of Enlightenment into it's
42own separate prefix so that you can still safely fallback to the X11 version.
43
44This can be done by passing:
45
46 --prefix=<some_other_install_location>
47
48Now, on to the magic bits ;)
49
50In order for Enlightenment to be compiled without X11, using Wayland
51only, you will need to pass a few more options to the configure stage
52of Enlightenment:
53
54 --enable-wayland-only
55 --enable-wayland-clients
56 --enable-wl-drm
57
58Since this is all still a work-in-progress, there are a few
59Enlightenment modules that have not been "fixed" to work without X11
60yet. Those will need to be disabled:
61
62 --disable-shot
63 --disable-xkbswitch
64 --disable-conf-randr
65 --disable-everything (don't worry, this is just the everything module)
66
67
68At this stage, you should have EFL properly built, and Enlightenment
69properly built. Let's move on to running it...
70
71
72Usage:
73-------------
74
75Hopefully at this stage you have successfully built EFL and
76Enlightenment in preparation for a Wayland-only setup. Congratulations
77!! Now, let's get it running...
78
79The following steps assume you are currently at a Virtual Terminal
80without anything else running (ie: no other window managers, X11, etc).
81
82In order for Enlightenment to function without X11, we need to setup
83the environment. In your current tty, do:
84
85 export E_WL_FORCE=drm
86 export ELM_ENGINE=wayland_shm (or wayland_egl)
87
88This will make sure that Enlightenment renders using DRM, and any
89Elementary applications use a Wayland engine.
90
91At this point, you should just be able 'cd' to the Enlightenment
92prefix where you installed, and issue:
93
94 ./enlightenment_start
95
96Please Note: It is suggested that you create a separate configuration
97profile with only a Minimum of modules loaded. Due to the experimental
98(and ongoing) status of Wayland-Only support in Enlightenment, Many
99modules May Not Work. Very few have actually been tested yet !!
100
101If you have a separate configuration profile (as suggested) that you
102would like to use, you can tell Enlightenment to use that when you
103start it:
104
105 ./enlightenment_start -profile <my_profile>
106
107
108Notes:
109-------------
110
111Please Note: There is currently NO support for running X11
112applications with this !! So basically, your web browsers won't work,
113don't expect to be able to run Firefox, Thunderbird, or practically
114Any Other X11 application yet. About the only things "known" to work
115so far are EFL/Elementary applications.
116
117
118Bugs:
119-------------
120
121Yes, there are Lots of them !!
122Yes, I am already aware of 99.9% of them.
123No, you do not need to start reporting them yet !!
124
125When we feel that the work is reaching a "finalizing" stage, we will
126put out a request for actual testers and bug reports !
127
128You are here because you want to play...because you want to
129experiment...because you want to be "cool" ;) You are not hear to nag
130me with complaints & reports about things I am already well aware of
131;) Save yourself some time, and me some stress !! ;)
132
133