source: x/lib/webkitgtk.xml@ 45ab6c7

11.0 ken/refactor-virt lazarus qt5new trunk
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 6 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

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