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 |
|
---|
84 | <bridgehead renderas="sect3">weston Dependencies</bridgehead>
|
---|
85 |
|
---|
86 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
87 | <para role="optional">
|
---|
88 | <xref linkend="libunwind"/>
|
---|
89 | </para>
|
---|
90 |
|
---|
91 | <para condition="html" role="usernotes">User Notes:
|
---|
92 | <ulink url="&blfs-wiki;/weston"/>
|
---|
93 | </para>
|
---|
94 | </sect2>
|
---|
95 |
|
---|
96 | <sect2 role="installation">
|
---|
97 | <title>Installation of weston</title>
|
---|
98 |
|
---|
99 | <para>
|
---|
100 | Install <application>weston</application> by running the following
|
---|
101 | commands:
|
---|
102 | </para>
|
---|
103 |
|
---|
104 | <screen><userinput>./configure --prefix=/usr &&
|
---|
105 | make</userinput></screen>
|
---|
106 |
|
---|
107 | <para>
|
---|
108 | This package does not come with a test suite.
|
---|
109 | </para>
|
---|
110 |
|
---|
111 | <para>
|
---|
112 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
113 | </para>
|
---|
114 |
|
---|
115 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
116 |
|
---|
117 | </sect2>
|
---|
118 |
|
---|
119 | <sect2 role="commands">
|
---|
120 | <title>Command Explanations</title>
|
---|
121 |
|
---|
122 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
123 | href="../../xincludes/without-scrollkeeper.xml"/>
|
---|
124 |
|
---|
125 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
126 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
127 |
|
---|
128 | </sect2>
|
---|
129 |
|
---|
130 | <sect2 role="content">
|
---|
131 | <title>Contents</title>
|
---|
132 |
|
---|
133 | <segmentedlist>
|
---|
134 | <segtitle>Installed Programs</segtitle>
|
---|
135 | <segtitle>Installed Library</segtitle>
|
---|
136 | <segtitle>Installed Directories</segtitle>
|
---|
137 |
|
---|
138 | <seglistitem>
|
---|
139 | <seg>
|
---|
140 | weston and weston-previewer
|
---|
141 | </seg>
|
---|
142 | <seg>
|
---|
143 | libwestonui-2.so
|
---|
144 | </seg>
|
---|
145 | <seg>
|
---|
146 | /usr/include/libwestonui-2.0,
|
---|
147 | /usr/lib/weston,
|
---|
148 | /usr/share/weston,
|
---|
149 | /usr/share/gnome/help/weston,
|
---|
150 | /usr/share/gtk-doc/html/westonui-2 and
|
---|
151 | /usr/share/omf/weston
|
---|
152 | </seg>
|
---|
153 | </seglistitem>
|
---|
154 | </segmentedlist>
|
---|
155 |
|
---|
156 | <variablelist>
|
---|
157 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
158 | <?dbfo list-presentation="list"?>
|
---|
159 | <?dbhtml list-presentation="table"?>
|
---|
160 |
|
---|
161 | <varlistentry id="weston-prog">
|
---|
162 | <term><command>weston</command></term>
|
---|
163 | <listitem>
|
---|
164 | <para>
|
---|
165 | is used to create or edit user interface designs
|
---|
166 | for <application>GTK+</application> or
|
---|
167 | <application>GNOME</application> applications.
|
---|
168 | </para>
|
---|
169 | <indexterm zone="weston weston-prog">
|
---|
170 | <primary sortas="b-weston">weston</primary>
|
---|
171 | </indexterm>
|
---|
172 | </listitem>
|
---|
173 | </varlistentry>
|
---|
174 |
|
---|
175 | <varlistentry id="weston-previewer">
|
---|
176 | <term><command>weston-previewer</command></term>
|
---|
177 | <listitem>
|
---|
178 | <para>
|
---|
179 | is used to preview a <application>weston</application> UI definition.
|
---|
180 | </para>
|
---|
181 | <indexterm zone="weston weston-previewer">
|
---|
182 | <primary sortas="b-weston-previewer">weston-previewer</primary>
|
---|
183 | </indexterm>
|
---|
184 | </listitem>
|
---|
185 | </varlistentry>
|
---|
186 |
|
---|
187 | <varlistentry id="libwestonui-2">
|
---|
188 | <term><filename class='libraryfile'>libwestonui-2.so</filename></term>
|
---|
189 | <listitem>
|
---|
190 | <para>
|
---|
191 | contains the <application>weston</application> API functions.
|
---|
192 | </para>
|
---|
193 | <indexterm zone="weston libwestonui-2">
|
---|
194 | <primary sortas="c-libwestonui-2">libwestonui-2.so</primary>
|
---|
195 | </indexterm>
|
---|
196 | </listitem>
|
---|
197 | </varlistentry>
|
---|
198 |
|
---|
199 | </variablelist>
|
---|
200 |
|
---|
201 | </sect2>
|
---|
202 |
|
---|
203 | </sect1>
|
---|