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