1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY weston-download-http "http://wayland.freedesktop.org/releases/weston-&weston-version;.tar.xz">
|
---|
8 | <!ENTITY weston-download-ftp " ">
|
---|
9 | <!ENTITY weston-md5sum "310af6d7f8ba03c3418cec8ad72ea748">
|
---|
10 | <!ENTITY weston-size "1.2 MB">
|
---|
11 | <!ENTITY weston-buildsize "57 MB (with tests)">
|
---|
12 | <!ENTITY weston-time "0.5 SBU (with tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="weston" xreflabel="Weston-&weston-version;" revision="systemd">
|
---|
16 | <?dbhtml filename="weston.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <date>$Date$</date>
|
---|
20 | </sect1info>
|
---|
21 |
|
---|
22 | <title>Weston-&weston-version;</title>
|
---|
23 |
|
---|
24 | <indexterm zone="weston">
|
---|
25 | <primary sortas="a-Weston">Weston</primary>
|
---|
26 | </indexterm>
|
---|
27 |
|
---|
28 | <sect2 role="package">
|
---|
29 | <title>Introduction to Weston</title>
|
---|
30 |
|
---|
31 | <para>
|
---|
32 | <application>Weston</application> is the reference implementation of
|
---|
33 | a <application>Wayland</application> compositor, and a useful
|
---|
34 | compositor in its own right. It has various backends that lets it
|
---|
35 | run on Linux kernel modesetting and evdev input as well as under X11.
|
---|
36 | <application>Weston</application> also ships with a few example clients,
|
---|
37 | from simple clients that demonstrate certain aspects of the protocol
|
---|
38 | to more complete clients and a simplistic toolkit.
|
---|
39 | </para>
|
---|
40 |
|
---|
41 | &lfs80_checked;
|
---|
42 |
|
---|
43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
44 | <itemizedlist spacing="compact">
|
---|
45 | <listitem>
|
---|
46 | <para>
|
---|
47 | Download (HTTP): <ulink url="&weston-download-http;"/>
|
---|
48 | </para>
|
---|
49 | </listitem>
|
---|
50 | <listitem>
|
---|
51 | <para>
|
---|
52 | Download (FTP): <ulink url="&weston-download-ftp;"/>
|
---|
53 | </para>
|
---|
54 | </listitem>
|
---|
55 | <listitem>
|
---|
56 | <para>
|
---|
57 | Download MD5 sum: &weston-md5sum;
|
---|
58 | </para>
|
---|
59 | </listitem>
|
---|
60 | <listitem>
|
---|
61 | <para>
|
---|
62 | Download size: &weston-size;
|
---|
63 | </para>
|
---|
64 | </listitem>
|
---|
65 | <listitem>
|
---|
66 | <para>
|
---|
67 | Estimated disk space required: &weston-buildsize;
|
---|
68 | </para>
|
---|
69 | </listitem>
|
---|
70 | <listitem>
|
---|
71 | <para>
|
---|
72 | Estimated build time: &weston-time;
|
---|
73 | </para>
|
---|
74 | </listitem>
|
---|
75 | </itemizedlist>
|
---|
76 |
|
---|
77 | <bridgehead renderas="sect3">Weston Dependencies</bridgehead>
|
---|
78 |
|
---|
79 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
80 | <para role="required">
|
---|
81 | <xref linkend="cairo"/>,
|
---|
82 | <xref linkend="libinput"/>,
|
---|
83 | <xref linkend="libjpeg"/>,
|
---|
84 | <xref linkend="libxkbcommon"/>,
|
---|
85 | <xref linkend="mesa"/> (built with
|
---|
86 | <application>Wayland</application> support),
|
---|
87 | <xref linkend="mtdev"/>,
|
---|
88 | <xref linkend="wayland"/>, and
|
---|
89 | <xref linkend="wayland-protocols"/>
|
---|
90 | </para>
|
---|
91 |
|
---|
92 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
93 | <para role="recommended">
|
---|
94 | <xref linkend="glu"/> (to build the screensaver client),
|
---|
95 | <xref linkend="linux-pam"/> (to build the
|
---|
96 | <command>weston-launch</command> utility),
|
---|
97 | <xref linkend="pango"/> (to build some demo clients),
|
---|
98 | <xref linkend="systemd"/>,
|
---|
99 | <xref linkend="xorg7-lib"/> (to build the X11
|
---|
100 | backend and X11 compatibility layer) and
|
---|
101 | <xref linkend="xorg-server"/> (with Xwayland, runtime
|
---|
102 | - for X11 backwards compatibility)
|
---|
103 | </para>
|
---|
104 |
|
---|
105 | <note>
|
---|
106 | <para>
|
---|
107 | The <command>weston-launch</command> utility is required if
|
---|
108 | you want to run <application>Weston</application> as a
|
---|
109 | non privileged user.
|
---|
110 | </para>
|
---|
111 | </note>
|
---|
112 |
|
---|
113 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
114 | <para role="optional">
|
---|
115 | <xref linkend="colord"/>,
|
---|
116 | <xref linkend="doxygen"/>,
|
---|
117 | <xref linkend="lcms2"/>,
|
---|
118 | <xref linkend="libpng"/>,
|
---|
119 | <xref linkend="libva"/> (for H.264 VAAPI video encoding),
|
---|
120 | <xref linkend="libwebp"/>,
|
---|
121 | <ulink url="http://www.freerdp.com/">FreeRDP</ulink> and
|
---|
122 | <ulink url="http://www.nongnu.org/libunwind/">libunwind</ulink>
|
---|
123 | </para>
|
---|
124 |
|
---|
125 | <para condition="html" role="usernotes">
|
---|
126 | User Notes: <ulink url="&blfs-wiki;/weston"/>
|
---|
127 | </para>
|
---|
128 | </sect2>
|
---|
129 |
|
---|
130 | <sect2 role="installation">
|
---|
131 | <title>Installation of Weston</title>
|
---|
132 |
|
---|
133 | <para>
|
---|
134 | Install <application>Weston</application> by running the following
|
---|
135 | commands:
|
---|
136 | </para>
|
---|
137 |
|
---|
138 | <screen><userinput>./configure --prefix=/usr --enable-demo-clients-install &&
|
---|
139 | make</userinput></screen>
|
---|
140 |
|
---|
141 | <para>
|
---|
142 | To test the results, issue: <command>make check</command>. The tests need
|
---|
143 | to be run from an X Terminal or equivalent.
|
---|
144 | </para>
|
---|
145 |
|
---|
146 | <para>
|
---|
147 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
148 | </para>
|
---|
149 |
|
---|
150 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
151 |
|
---|
152 | </sect2>
|
---|
153 |
|
---|
154 | <sect2 role="commands">
|
---|
155 | <title>Command Explanations</title>
|
---|
156 |
|
---|
157 | <para>
|
---|
158 | <parameter>--enable-demo-clients-install</parameter>: This switch
|
---|
159 | enables the installation of the demo clients shipped with
|
---|
160 | <application>Weston</application>.
|
---|
161 | </para>
|
---|
162 |
|
---|
163 | <note>
|
---|
164 | <para>
|
---|
165 | Consult <command>./configure --help</command> output for switches needed
|
---|
166 | to prevent <command>configure</command> from looking for some of the
|
---|
167 | recommended dependencies.
|
---|
168 | </para>
|
---|
169 | </note>
|
---|
170 |
|
---|
171 | </sect2>
|
---|
172 |
|
---|
173 | <sect2 role="using">
|
---|
174 | <title>Using Weston</title>
|
---|
175 |
|
---|
176 | <para>
|
---|
177 | To start <application>Weston</application> as a X11 client,
|
---|
178 | from an X terminal, run the following command:
|
---|
179 | </para>
|
---|
180 |
|
---|
181 | <screen><userinput>weston</userinput></screen>
|
---|
182 |
|
---|
183 | <para>
|
---|
184 | To run it as a DRM compositor, from a TTY, while logged
|
---|
185 | in as a normal user, run the following command:
|
---|
186 | </para>
|
---|
187 |
|
---|
188 | <screen><userinput>weston-launch</userinput></screen>
|
---|
189 |
|
---|
190 | <para>
|
---|
191 | Note that <command>weston-launch</command> is a wrapper for
|
---|
192 | <command>weston</command>. If you need to pass a parameter
|
---|
193 | to <command>weston</command> while using
|
---|
194 | <command>weston-launch</command>, use the following syntax:
|
---|
195 | </para>
|
---|
196 |
|
---|
197 | <screen><userinput>weston-launch -- --backend=fbdev-backend.so</userinput></screen>
|
---|
198 |
|
---|
199 | <para>
|
---|
200 | Note the -- between the <command>weston-launch</command> and
|
---|
201 | the <command>weston</command> parameter
|
---|
202 | <parameter>--backend=fbdev-backend.so</parameter>. For list
|
---|
203 | of parameters that you can pass to <command>weston</command>,
|
---|
204 | consult the <command>weston(1)</command> manual page.
|
---|
205 | </para>
|
---|
206 |
|
---|
207 | <para>
|
---|
208 | To terminate <application>Weston</application> when running
|
---|
209 | as a DRM compositor, use the CTRL+ALT+Backspace
|
---|
210 | combination on your keyboard.
|
---|
211 | </para>
|
---|
212 |
|
---|
213 | <para>
|
---|
214 | Note that the default backend, DRM, will only run if a
|
---|
215 | KMS driver is present on the system. It will not run in
|
---|
216 | a virtual machine such as VBox or Qemu and on NVidia or
|
---|
217 | AMD hardware with proprietary drivers. On these setups
|
---|
218 | it would be possible to use the FBDEV backend by running
|
---|
219 | the command described above.
|
---|
220 | </para>
|
---|
221 |
|
---|
222 | <para>
|
---|
223 | Also note that the X11 backend requires a working EGL stack.
|
---|
224 | If you are running hardware that has no 3D support or
|
---|
225 | no EGL stack, you can't run accelerated applications
|
---|
226 | inside <application>Weston</application>. The latest
|
---|
227 | proprietary NVidia driver has the necessary EGL
|
---|
228 | stack needed to run <application>Weston</application>
|
---|
229 | as an X11 client, but it is not officially supported.
|
---|
230 | </para>
|
---|
231 |
|
---|
232 | </sect2>
|
---|
233 |
|
---|
234 | <sect2 role="configuration">
|
---|
235 | <title>Configuring Weston</title>
|
---|
236 |
|
---|
237 | <sect3 id="weston-config">
|
---|
238 | <title>Config Files</title>
|
---|
239 | <para>
|
---|
240 | <filename>~/.config/weston.ini</filename>
|
---|
241 | </para>
|
---|
242 |
|
---|
243 | <indexterm zone="weston weston-config">
|
---|
244 | <primary sortas="e-AA.config-weston.ini">~/.config/weston.ini</primary>
|
---|
245 | </indexterm>
|
---|
246 | </sect3>
|
---|
247 |
|
---|
248 | <sect3>
|
---|
249 | <title>Configuration Information</title>
|
---|
250 |
|
---|
251 | <para>
|
---|
252 | The <application>Weston</application> configuration file can be
|
---|
253 | used to configure which modules will be loaded, keyboard
|
---|
254 | layout, display resolution, touchpad behaviour, desktop shell
|
---|
255 | appearance, etc.
|
---|
256 | </para>
|
---|
257 |
|
---|
258 | <para>
|
---|
259 | To change the keyboard layout inside <application>Weston</application>,
|
---|
260 | add the following to your config file:
|
---|
261 | </para>
|
---|
262 |
|
---|
263 | <screen><literal>[keyboard]
|
---|
264 | keymap_model=pc105
|
---|
265 | keymap_layout=de
|
---|
266 | keymap_variant=euro
|
---|
267 | keymap_options=grp:alt_shift_toggle</literal></screen>
|
---|
268 |
|
---|
269 | <para>
|
---|
270 | For an explanation of each of the mentioned options,
|
---|
271 | consult the <command>xkeyboard-config(7)</command>
|
---|
272 | manual page.
|
---|
273 | </para>
|
---|
274 |
|
---|
275 | <para>
|
---|
276 | To change the resolution of the compositor,
|
---|
277 | add the following to your config file:
|
---|
278 | </para>
|
---|
279 |
|
---|
280 | <screen><literal>[output]
|
---|
281 | name=LVDS1
|
---|
282 | mode=1366x768</literal></screen>
|
---|
283 |
|
---|
284 | <para>
|
---|
285 | The name can be one of the following:
|
---|
286 | </para>
|
---|
287 |
|
---|
288 | <itemizedlist spacing="compact">
|
---|
289 | <listitem>
|
---|
290 | <para>
|
---|
291 | DRM backend: LVDS1 (Laptop internal panel no.1)
|
---|
292 | </para>
|
---|
293 | </listitem>
|
---|
294 | <listitem>
|
---|
295 | <para>
|
---|
296 | DRM backend: VGA1 (VGA connector no.1)
|
---|
297 | </para>
|
---|
298 | </listitem>
|
---|
299 | <listitem>
|
---|
300 | <para>
|
---|
301 | X11 backend: X1 (X window no.1)
|
---|
302 | </para>
|
---|
303 | </listitem>
|
---|
304 | <listitem>
|
---|
305 | <para>
|
---|
306 | Wayland backend: WL1 (Wayland window no.1)
|
---|
307 | </para>
|
---|
308 | </listitem>
|
---|
309 | </itemizedlist>
|
---|
310 |
|
---|
311 | <para>
|
---|
312 | For more information consult the
|
---|
313 | <command>weston-drm(7)</command> manual page.
|
---|
314 | </para>
|
---|
315 |
|
---|
316 | <para>
|
---|
317 | To load a <application>Weston</application> module or a shell
|
---|
318 | backend, add the following to your config file:
|
---|
319 | </para>
|
---|
320 |
|
---|
321 | <screen><literal>[core]
|
---|
322 | modules=xwayland.so
|
---|
323 | shell=desktop-shell.so</literal></screen>
|
---|
324 |
|
---|
325 | <para>
|
---|
326 | Note that you need to load the <filename>xwayland.so</filename>
|
---|
327 | module if you want to use X11 clients inside
|
---|
328 | <application>Weston</application>.
|
---|
329 | </para>
|
---|
330 |
|
---|
331 | <para>
|
---|
332 | For a detailed list of configuration directives, consult the
|
---|
333 | <command>weston.ini(5)</command> manual page or examine the
|
---|
334 | <filename>weston.ini</filename> file inside the
|
---|
335 | <application>Weston</application> source directory.
|
---|
336 | </para>
|
---|
337 |
|
---|
338 | </sect3>
|
---|
339 |
|
---|
340 | </sect2>
|
---|
341 |
|
---|
342 | <sect2 role="content">
|
---|
343 | <title>Contents</title>
|
---|
344 |
|
---|
345 | <segmentedlist>
|
---|
346 | <segtitle>Installed Programs</segtitle>
|
---|
347 | <segtitle>Installed Libraries</segtitle>
|
---|
348 | <segtitle>Installed Directories</segtitle>
|
---|
349 |
|
---|
350 | <seglistitem>
|
---|
351 | <seg>
|
---|
352 | wcap-decode, weston, weston-calibrator, weston-clickdot,
|
---|
353 | weston-cliptest, weston-dnd, weston-editor, weston-eventdemo,
|
---|
354 | weston-flower, weston-fullscreen, weston-image,
|
---|
355 | weston-info, weston-launch, weston-multi-resource,
|
---|
356 | weston-presentation-shm, weston-resizor, weston-scaler,
|
---|
357 | weston-simple-damage, weston-simple-dmabuf-intel,
|
---|
358 | weston-simple-dmabuf-v4l, weston-simple-egl, weston-simple-shm,
|
---|
359 | weston-simple-touch, weston-smoke, weston-stacking,
|
---|
360 | weston-subsurfaces, weston-terminal and weston-transformed
|
---|
361 | </seg>
|
---|
362 | <seg>
|
---|
363 | libweston-1.so and libweston-desktop-1.so
|
---|
364 | </seg>
|
---|
365 | <seg>
|
---|
366 | /usr/include/{libweston-1,weston}
|
---|
367 | /usr/lib/{libweston-1,weston},
|
---|
368 | /usr/share/wayland-sessions and
|
---|
369 | /usr/share/weston
|
---|
370 | </seg>
|
---|
371 | </seglistitem>
|
---|
372 | </segmentedlist>
|
---|
373 |
|
---|
374 | <variablelist>
|
---|
375 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
376 | <?dbfo list-presentation="list"?>
|
---|
377 | <?dbhtml list-presentation="table"?>
|
---|
378 |
|
---|
379 | <varlistentry id="weston-prog">
|
---|
380 | <term><command>weston</command></term>
|
---|
381 | <listitem>
|
---|
382 | <para>
|
---|
383 | is the reference implementation of a Wayland server.
|
---|
384 | </para>
|
---|
385 | <indexterm zone="weston weston-prog">
|
---|
386 | <primary sortas="b-weston">weston</primary>
|
---|
387 | </indexterm>
|
---|
388 | </listitem>
|
---|
389 | </varlistentry>
|
---|
390 |
|
---|
391 | </variablelist>
|
---|
392 |
|
---|
393 | </sect2>
|
---|
394 |
|
---|
395 | </sect1>
|
---|