source: x/lib/webkitgtk.xml@ 2ad1b08

11.3 12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 2ad1b08 was 74b918b, checked in by Douglas R. Reno <renodr@…>, 16 months ago

Update to WebKitGTK+-2.38.5 (Security Update) and tag Epiphany+Deps

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