[7585458] | 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://cgit.freedesktop.org/wayland/weston/snapshot/weston-&weston-version;.tar.gz">
|
---|
| 8 | <!ENTITY weston-download-ftp " ">
|
---|
| 9 | <!ENTITY weston-md5sum "92036a1655f821f2ad5bf661a0c88630">
|
---|
| 10 | <!ENTITY weston-size "640 KB">
|
---|
| 11 | <!ENTITY weston-buildsize "60 MB">
|
---|
| 12 | <!ENTITY weston-time "0.7 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 a Wayland compositor.
|
---|
| 34 | Weston creates its unix socket file (for example, wayland-0) in the directory
|
---|
| 35 | specified by the required environment variable $XDG_RUNTIME_DIR.
|
---|
| 36 | Clients use the same variable to find that socket. This is provided using systemd.
|
---|
| 37 | </para>
|
---|
| 38 |
|
---|
| 39 | &lfs75_checked;
|
---|
| 40 |
|
---|
| 41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 42 | <itemizedlist spacing="compact">
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>
|
---|
| 45 | Download (HTTP): <ulink url="&weston-download-http;"/>
|
---|
| 46 | </para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>
|
---|
| 50 | Download (FTP): <ulink url="&weston-download-ftp;"/>
|
---|
| 51 | </para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>
|
---|
| 55 | Download MD5 sum: &weston-md5sum;
|
---|
| 56 | </para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>
|
---|
| 60 | Download size: &weston-size;
|
---|
| 61 | </para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>
|
---|
| 65 | Estimated disk space required: &weston-buildsize;
|
---|
| 66 | </para>
|
---|
| 67 | </listitem>
|
---|
| 68 | <listitem>
|
---|
| 69 | <para>
|
---|
| 70 | Estimated build time: &weston-time;
|
---|
| 71 | </para>
|
---|
| 72 | </listitem>
|
---|
| 73 | </itemizedlist>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect3">weston Dependencies</bridgehead>
|
---|
| 76 |
|
---|
| 77 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 78 | <para role="required">
|
---|
| 79 | <xref linkend="wayland"/>,
|
---|
| 80 | <xref linkend="cairo"/>, and
|
---|
| 81 | <xref linkend="libxkbcommon"/>
|
---|
| 82 | </para>
|
---|
| 83 |
|
---|
[e1df6e21] | 84 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 85 | <para role="optional">
|
---|
[ab14cf7] | 86 | libunwind
|
---|
[e1df6e21] | 87 | </para>
|
---|
| 88 |
|
---|
[7585458] | 89 | <para condition="html" role="usernotes">User Notes:
|
---|
| 90 | <ulink url="&blfs-wiki;/weston"/>
|
---|
| 91 | </para>
|
---|
| 92 | </sect2>
|
---|
| 93 |
|
---|
| 94 | <sect2 role="installation">
|
---|
| 95 | <title>Installation of weston</title>
|
---|
| 96 |
|
---|
| 97 | <para>
|
---|
| 98 | Install <application>weston</application> by running the following
|
---|
| 99 | commands:
|
---|
| 100 | </para>
|
---|
| 101 |
|
---|
| 102 | <screen><userinput>./configure --prefix=/usr &&
|
---|
| 103 | make</userinput></screen>
|
---|
| 104 |
|
---|
| 105 | <para>
|
---|
| 106 | This package does not come with a test suite.
|
---|
| 107 | </para>
|
---|
| 108 |
|
---|
| 109 | <para>
|
---|
| 110 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 111 | </para>
|
---|
| 112 |
|
---|
| 113 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 114 |
|
---|
| 115 | </sect2>
|
---|
| 116 |
|
---|
| 117 | <sect2 role="commands">
|
---|
| 118 | <title>Command Explanations</title>
|
---|
| 119 |
|
---|
| 120 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 121 | href="../../xincludes/without-scrollkeeper.xml"/>
|
---|
| 122 |
|
---|
| 123 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 124 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
| 125 |
|
---|
| 126 | </sect2>
|
---|
| 127 |
|
---|
| 128 | <sect2 role="content">
|
---|
| 129 | <title>Contents</title>
|
---|
| 130 |
|
---|
| 131 | <segmentedlist>
|
---|
| 132 | <segtitle>Installed Programs</segtitle>
|
---|
| 133 | <segtitle>Installed Library</segtitle>
|
---|
| 134 | <segtitle>Installed Directories</segtitle>
|
---|
| 135 |
|
---|
| 136 | <seglistitem>
|
---|
| 137 | <seg>
|
---|
| 138 | weston and weston-previewer
|
---|
| 139 | </seg>
|
---|
| 140 | <seg>
|
---|
| 141 | libwestonui-2.so
|
---|
| 142 | </seg>
|
---|
| 143 | <seg>
|
---|
| 144 | /usr/include/libwestonui-2.0,
|
---|
| 145 | /usr/lib/weston,
|
---|
| 146 | /usr/share/weston,
|
---|
| 147 | /usr/share/gnome/help/weston,
|
---|
| 148 | /usr/share/gtk-doc/html/westonui-2 and
|
---|
| 149 | /usr/share/omf/weston
|
---|
| 150 | </seg>
|
---|
| 151 | </seglistitem>
|
---|
| 152 | </segmentedlist>
|
---|
| 153 |
|
---|
| 154 | <variablelist>
|
---|
| 155 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 156 | <?dbfo list-presentation="list"?>
|
---|
| 157 | <?dbhtml list-presentation="table"?>
|
---|
| 158 |
|
---|
| 159 | <varlistentry id="weston-prog">
|
---|
| 160 | <term><command>weston</command></term>
|
---|
| 161 | <listitem>
|
---|
| 162 | <para>
|
---|
| 163 | is used to create or edit user interface designs
|
---|
| 164 | for <application>GTK+</application> or
|
---|
| 165 | <application>GNOME</application> applications.
|
---|
| 166 | </para>
|
---|
| 167 | <indexterm zone="weston weston-prog">
|
---|
| 168 | <primary sortas="b-weston">weston</primary>
|
---|
| 169 | </indexterm>
|
---|
| 170 | </listitem>
|
---|
| 171 | </varlistentry>
|
---|
| 172 |
|
---|
| 173 | <varlistentry id="weston-previewer">
|
---|
| 174 | <term><command>weston-previewer</command></term>
|
---|
| 175 | <listitem>
|
---|
| 176 | <para>
|
---|
| 177 | is used to preview a <application>weston</application> UI definition.
|
---|
| 178 | </para>
|
---|
| 179 | <indexterm zone="weston weston-previewer">
|
---|
| 180 | <primary sortas="b-weston-previewer">weston-previewer</primary>
|
---|
| 181 | </indexterm>
|
---|
| 182 | </listitem>
|
---|
| 183 | </varlistentry>
|
---|
| 184 |
|
---|
| 185 | <varlistentry id="libwestonui-2">
|
---|
| 186 | <term><filename class='libraryfile'>libwestonui-2.so</filename></term>
|
---|
| 187 | <listitem>
|
---|
| 188 | <para>
|
---|
| 189 | contains the <application>weston</application> API functions.
|
---|
| 190 | </para>
|
---|
| 191 | <indexterm zone="weston libwestonui-2">
|
---|
| 192 | <primary sortas="c-libwestonui-2">libwestonui-2.so</primary>
|
---|
| 193 | </indexterm>
|
---|
| 194 | </listitem>
|
---|
| 195 | </varlistentry>
|
---|
| 196 |
|
---|
| 197 | </variablelist>
|
---|
| 198 |
|
---|
| 199 | </sect2>
|
---|
| 200 |
|
---|
| 201 | </sect1>
|
---|