source: x/lib/webkitgtk.xml@ 0940157

10.0 10.1 11.0 11.1 11.2 9.1 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 0940157 was 0940157, checked in by Xi Ruoyao <xry111@…>, 3 years ago

webkitgtk: optional dep on bubblewrap

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@22655 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 11.0 KB
Line 
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 webkitgtk-download-http "https://webkitgtk.org/releases/webkitgtk-&webkitgtk-version;.tar.xz">
8 <!ENTITY webkitgtk-download-ftp " ">
9 <!ENTITY webkitgtk-md5sum "4c27d59a032710dae3cffa5990bb6aea">
10 <!ENTITY webkitgtk-size "18 MB">
11 <!ENTITY webkitgtk-buildsize "617 MB (107 MB installed)">
12 <!ENTITY webkitgtk-time "22 SBU (using parallelism=4, estimated 75 SBUs using one core)">
13]>
14
15<sect1 id="webkitgtk" xreflabel="WebKitGTK+-&webkitgtk-version;">
16 <?dbhtml filename="webkitgtk.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>WebKitGTK+-&webkitgtk-version;</title>
24
25 <indexterm zone="webkitgtk">
26 <primary sortas="a-WebKitGTK+">WebKitGTK+</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to WebKitGTK+</title>
31
32 <para>
33 The <application>WebKitGTK+</application> package is a port of the
34 portable web rendering engine <application>WebKit</application> to the
35 <application>GTK+ 3</application> and <application>GTK+ 2</application>
36 platforms.
37 </para>
38
39 &lfs90_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&webkitgtk-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&webkitgtk-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &webkitgtk-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &webkitgtk-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &webkitgtk-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &webkitgtk-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">WebKitGTK+ Dependencies</bridgehead>
76
77 <bridgehead renderas="sect4">Required</bridgehead>
78 <para role="required">
79 <xref linkend="cairo"/>,
80 <xref linkend="cmake"/>,
81 <xref linkend="gst10-plugins-base"/>,
82 <xref linkend="gst10-plugins-bad"/>,
83 <xref linkend="gtk3"/>,
84 <xref linkend="icu"/>,
85 <xref linkend="libgudev"/>,
86 <xref linkend="libsecret"/>,
87 <xref linkend="libsoup"/>,
88 <xref linkend="libwebp"/>,
89 <xref linkend="mesa"/>,
90 <xref linkend="openjpeg2"/>,
91 <xref linkend="ruby"/>,
92 <xref linkend="sqlite"/>, and
93 <xref linkend="which"/>
94 </para>
95
96 <bridgehead renderas="sect4">Recommended</bridgehead>
97 <para role="recommended">
98 <xref linkend="enchant"/>,
99 <xref linkend="geoclue2"/>,
100 <xref linkend="gobject-introspection"/>,
101 <xref linkend="hicolor-icon-theme"/>, and
102 <xref linkend="libnotify"/>
103 </para>
104
105 <bridgehead renderas="sect4">Optional</bridgehead>
106 <para role="optional">
107 <xref linkend="bubblewrap"/>,
108 <xref linkend="gtk-doc"/>,
109 <xref linkend="harfbuzz"/>,
110 <xref linkend="wayland"/>,
111 <xref linkend="woff2"/>,
112 <ulink url="http://sourceforge.net/projects/hunspell/files/Hyphen/">Hyphen</ulink>,
113 <ulink url="http://xsltml.sourceforge.net/">MathML</ulink>,
114 <ulink url="https://github.com/WebPlatformForEmbedded/libwpe">libwpe</ulink>,
115 <ulink url="https://github.com/Igalia/WPEBackend-fdo">WPEBackend-fdo</ulink>, and
116 <ulink url="https://github.com/flatpak/xdg-dbus-proxy">xdg-dbus-proxy</ulink>
117 </para>
118
119 <para condition="html" role="usernotes">
120 User Notes: <ulink url="&blfs-wiki;/webkitgtk"/>
121 </para>
122 </sect2>
123
124 <sect2 role="installation">
125 <title>Installation of WebKitGTK+</title>
126
127 <bridgehead renderas="sect3">Installation of
128 <application>WebKitGTK+</application></bridgehead>
129
130 <para>
131 Install <application>WebKitGTK+</application> by running the
132 following commands:
133 </para>
134
135<screen><userinput>mkdir -vp build &amp;&amp;
136cd build &amp;&amp;
137
138cmake -DCMAKE_BUILD_TYPE=Release \
139 -DCMAKE_INSTALL_PREFIX=/usr \
140 -DCMAKE_SKIP_RPATH=ON \
141 -DPORT=GTK \
142 -DLIB_INSTALL_DIR=/usr/lib \
143 -DUSE_LIBHYPHEN=OFF \
144 -DENABLE_MINIBROWSER=ON \
145 -DUSE_WOFF2=OFF \
146 -DUSE_WPE_RENDERER=OFF \
147 -DENABLE_BUBBLEWRAP_SANDBOX=OFF \
148 -Wno-dev -G Ninja .. &amp;&amp;
149ninja</userinput></screen>
150
151 <para>
152 This package does not have a working testsuite. However, there is a
153 usable basic graphical web browser in the build directory,
154 <application>build/bin/MiniBrowser</application>. If launching it fails,
155 there is a problem with the build.
156 </para>
157
158 <note><para>
159 When installing, the Makefile does some additional compiling and linking.
160 If you do not have Xorg in /usr, the LIBRARY_PATH and PKG_CONFIG_PATH
161 variables need to be defined for the root user. If using sudo to assume
162 root, use the -E option to pass your current environment variables for the
163 install process.
164 </para></note>
165
166 <para>
167 Now, as the <systemitem class="username">root</systemitem> user:
168 </para>
169
170<screen role="root"><userinput>ninja install &amp;&amp;
171
172install -vdm755 /usr/share/gtk-doc/html/webkit{2,dom}gtk-4.0 &amp;&amp;
173install -vm644 ../Documentation/webkit2gtk-4.0/html/* \
174 /usr/share/gtk-doc/html/webkit2gtk-4.0 &amp;&amp;
175install -vm644 ../Documentation/webkitdomgtk-4.0/html/* \
176 /usr/share/gtk-doc/html/webkitdomgtk-4.0</userinput></screen>
177
178 </sect2>
179
180 <sect2 role="commands">
181 <title>Command Explanations</title>
182
183<!-- <para>
184 <command>sed ... TextCheckerEnchant.cpp</command>: This command
185 is needed to allow the build to complete with enchant-2.x.
186 </para> -->
187
188 <para>
189 <parameter>-DUSE_LIBHYPHEN=OFF</parameter>: This switch disables
190 default automatic hyphenation implementation. You need to install
191 <ulink
192 url="http://sourceforge.net/projects/hunspell/files/Hyphen/">Hyphen</ulink>,
193 if you wish to enable it (replacing OFF with ON or just removing
194 the switch).
195 </para>
196
197 <para>
198 <parameter>-DENABLE_MINIBROWSER=ON</parameter>: This switch enables the
199 <application>Mini Browser</application> compilation and install.
200 </para>
201
202 <para>
203 <parameter>-DUSE_WPE_RENDERER=OFF</parameter>: Remove this switch if the optional
204 packages <ulink url="https://github.com/WebPlatformForEmbedded/libwpe">libwpe</ulink> and
205 <ulink url="https://github.com/Igalia/WPEBackend-fdo">WPEBackend-fdo</ulink> are installed.
206 </para>
207
208 <para>
209 <parameter>-DENABLE_BUBBLEWRAP_SANDBOX=OFF</parameter>: Remove this switch if the optional
210 packages <xref linkend="bubblewrap"/> and
211 <ulink url="https://github.com/flatpak/xdg-dbus-proxy">xdg-dbus-proxy</ulink>
212 are installed.
213 </para>
214
215 <para>
216 <option>-DUSE_LIBNOTIFY=OFF</option>: Use this switch if you do not
217 have <application>libnotify</application> installed.
218 </para>
219
220 <para>
221 <option>-DUSE_SYSTEM_MALLOC=ON</option>: This switch enables building
222 against the system installed <application>malloc</application>.
223 </para>
224
225 <para>
226 <option>-DENABLE_GEOLOCATION=OFF</option>: Use this switch if you don't
227 want to install <xref linkend="geoclue2"/>.
228 </para>
229
230 <para>
231 <option>-DENABLE_GTKDOC=ON</option>: Use this switch if <xref
232 linkend="gtk-doc"/> is installed and you wish to rebuild and install the
233 API documentation.
234 </para>
235
236 <para>
237 <option>-DUSE_WOFF2=ON</option>: Use this switch if the optional
238 package <xref linkend="woff2"/> is installed.
239 </para>
240
241 </sect2>
242
243 <sect2 role="content">
244 <title>Contents</title>
245
246 <segmentedlist>
247 <segtitle>Installed Program</segtitle>
248 <segtitle>Installed Libraries</segtitle>
249 <segtitle>Installed Directories</segtitle>
250
251 <seglistitem>
252 <seg>
253 jsc,
254 MiniBrowser, and
255 WebKitWebDriver
256 </seg>
257 <seg>
258 libjavascriptcoregtk-4.0.so and
259 libwebkit2gtk-4.0.so
260 </seg>
261 <seg>
262 /usr/include/webkitgtk-4.0,
263 /usr/lib{,exec}/webkit2gtk-4.0, and
264 /usr/share/gtk-doc/html/webkit{2,dom}gtk-4.0
265 </seg>
266 </seglistitem>
267 </segmentedlist>
268
269 <variablelist>
270 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
271 <?dbfo list-presentation="list"?>
272 <?dbhtml list-presentation="table"?>
273
274 <varlistentry id="jsc">
275 <term><command>jsc</command></term>
276 <listitem>
277 <para>
278 is a command-line utility that allows you to run JavaScript programs
279 outside of the context of a web browser.
280 </para>
281 <indexterm zone="webkitgtk jsc">
282 <primary sortas="b-jsc">jsc</primary>
283 </indexterm>
284 </listitem>
285 </varlistentry>
286
287 <varlistentry id="MiniBrowser">
288 <term><command>MiniBrowser</command></term>
289 <listitem>
290 <para>
291 is a very simple graphical browser.
292 </para>
293 <indexterm zone="webkitgtk MiniBrowser">
294 <primary sortas="b-MiniBrowser">MiniBrowser</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry id="WebKitWebDriver">
300 <term><command>WebKitWebDriver</command></term>
301 <listitem>
302 <para>
303 allows debugging and automation of web pages and browsers.
304 </para>
305 <indexterm zone="webkitgtk WebKitWebDriver">
306 <primary sortas="b-WebKitWebDriver">WebKitWebDriver</primary>
307 </indexterm>
308 </listitem>
309 </varlistentry>
310
311 <varlistentry id="libjavascriptcoregtk-4.0">
312 <term><filename
313 class="libraryfile">libjavascriptcoregtk-4.0.so</filename></term>
314 <listitem>
315 <para>
316 contains core JavaScript API functions used by
317 <command>jsc</command> and <filename
318 class="libraryfile">libwebkit2gtk-4.0</filename>.
319 </para>
320 <indexterm zone="webkitgtk libjavascriptcoregtk-4.0">
321 <primary sortas="c-libjavascriptcoregtk-4.0">libjavascriptcoregtk-4.0.0.so</primary>
322 </indexterm>
323 </listitem>
324 </varlistentry>
325
326 <varlistentry id="libwebkit2gtk-4">
327 <term><filename class="libraryfile">libwebkit2gtk-4.0.so</filename></term>
328 <listitem>
329 <para>
330 contains the <application>WebKit2</application> API functions.
331 </para>
332 <indexterm zone="webkitgtk libwebkit2gtk-4">
333 <primary sortas="c-libwebkit2gtk-4">libwebkit2gtk-4.0.so</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338 </variablelist>
339
340 </sect2>
341
342</sect1>
Note: See TracBrowser for help on using the repository browser.