source: x/lib/webkitgtk.xml@ ffef0bb

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since ffef0bb was d1d2511, checked in by Bruce Dubbs <bdubbs@…>, 13 months ago

Update to webkitgtk-2.40.2.
  • Property mode set to 100644
File size: 17.2 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 "9fb1e6d919f29662ee3e741421fd0b71">
10 <!ENTITY webkitgtk-size "38 MB">
11 <!ENTITY webkitgtk-buildsize "998 MB (174 MB installed)">
12 <!ENTITY webkitgtk-time "28 SBU (for GTK-3, using parallelism=4, add 29 SBU for GTK-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="gtk4"/>,
93 <xref linkend="icu"/>,
94 <xref linkend="lcms2"/>,
95 <xref linkend="libgudev"/>,
96 <xref linkend="libsecret"/>,
97 <xref linkend="libsoup3"/>,
98 <xref linkend="libtasn1"/>,
99 <xref linkend="libwebp"/>,
100 <xref linkend="mesa"/>,
101 <xref linkend="openjpeg2"/>,
102 <xref linkend="ruby"/>,
103 <xref linkend="sqlite"/>,
104 <xref linkend="unifdef"/>,
105 <xref linkend="which"/>, and
106 <xref linkend="wpebackend-fdo"/>
107 </para>
108
109 <bridgehead renderas="sect4">Recommended</bridgehead>
110 <para role="recommended">
111 <xref linkend="enchant"/>,
112 <xref linkend="geoclue2"/>,
113 <xref linkend="gobject-introspection"/>,
114 <xref linkend="hicolor-icon-theme"/>, and
115 <xref linkend="libavif"/>
116 </para>
117
118 <bridgehead renderas="sect4">Optional</bridgehead>
119 <para role="optional">
120 <xref linkend="bubblewrap"/>,
121 <xref linkend="gi-docgen"/>,
122 <xref linkend="harfbuzz"/>,
123 <xref linkend="wayland"/>,
124 <xref linkend="woff2"/>,
125 <ulink url="https://ccache.dev/">ccache</ulink>,
126 <ulink url="https://sourceforge.net/projects/hunspell/files/Hyphen/">Hyphen</ulink>,
127 <!--<ulink url="https://github.com/AOMediaCodec/libavif">libavif</ulink>,-->
128 <ulink url="https://gnome.pages.gitlab.gnome.org/libmanette/">libmanette</ulink>, and
129 <ulink url="https://github.com/flatpak/xdg-dbus-proxy">xdg-dbus-proxy</ulink>
130 </para>
131
132 <para condition="html" role="usernotes">
133 User Notes: <ulink url="&blfs-wiki;/webkitgtk"/>
134 </para>
135 </sect2>
136
137 <sect2 role="installation">
138 <title>Installation of WebKitGTK</title>
139
140 <bridgehead renderas="sect3">Installation of
141 <application>WebKitGTK</application></bridgehead>
142
143 <para>
144 First, fix a problem when not using BUBBLEWRAP_SANDBOX:
145 </para>
146
147<screen><userinput>sed -i '39,66 s:^://:' Source/WTF/wtf/glib/Sandbox.cpp</userinput></screen>
148
149 <important>
150 <para>
151 This package allows building with either GTK-3 or GTK-4, but not both
152 in the same build. The GTK-4 version is needed for packages such as
153 <xref linkend="epiphany"/>. Other packages, such as
154 <xref linkend="balsa"/> or <xref linkend="evolution"/>, require the
155 GTK-3 version. Both versions can be installed side by side on the
156 same system. We give build instructions for both cases below, but
157 the only difference is the setting of <command>-DUSE_GTK4</command>
158 </para>
159 </important>
160
161 <para>
162 If you want to install the GTK+-3 version of
163 <application>WebKitGTK</application>, run the following commands:
164 </para>
165
166<screen revision="systemd"><userinput>mkdir -vp build &amp;&amp;
167cd build &amp;&amp;
168
169cmake -DCMAKE_BUILD_TYPE=Release \
170 -DCMAKE_INSTALL_PREFIX=/usr \
171 -DCMAKE_SKIP_RPATH=ON \
172 -DPORT=GTK \
173 -DLIB_INSTALL_DIR=/usr/lib \
174 -DUSE_LIBHYPHEN=OFF \
175 -DENABLE_GAMEPAD=OFF \
176 -DENABLE_MINIBROWSER=ON \
177 -DENABLE_DOCUMENTATION=OFF \
178 -DUSE_WOFF2=OFF \
179 -DUSE_GTK4=OFF \
180 -DUSE_WPE_RENDERER=ON \
181 -DENABLE_BUBBLEWRAP_SANDBOX=OFF \
182 -Wno-dev -G Ninja .. &amp;&amp;
183ninja</userinput></screen>
184
185<screen revision="sysv"><userinput>mkdir -vp build &amp;&amp;
186cd build &amp;&amp;
187
188cmake -DCMAKE_BUILD_TYPE=Release \
189 -DCMAKE_INSTALL_PREFIX=/usr \
190 -DCMAKE_SKIP_RPATH=ON \
191 -DPORT=GTK \
192 -DLIB_INSTALL_DIR=/usr/lib \
193 -DUSE_LIBHYPHEN=OFF \
194 -DENABLE_GAMEPAD=OFF \
195 -DENABLE_MINIBROWSER=ON \
196 -DENABLE_DOCUMENTATION=OFF \
197 -DUSE_WOFF2=OFF \
198 -DUSE_GTK4=OFF \
199 -DUSE_WPE_RENDERER=ON \
200 -DENABLE_JOURNALD_LOG=OFF \
201 -DENABLE_BUBBLEWRAP_SANDBOX=OFF \
202 -Wno-dev -G Ninja .. &amp;&amp;
203ninja</userinput></screen>
204
205 <para>
206 This package does not have a working test suite. However, there is a
207 usable basic graphical web browser in the build directory,
208 <application>build/bin/MiniBrowser</application>. If launching it fails,
209 there is a problem with the build.
210 </para>
211
212<!-- Since we're using Ninja now instead of autotools, this isn't valid anymore
213 <note><para>
214 When installing, the Makefile does some additional compiling and linking.
215 If you do not have Xorg in /usr, the LIBRARY_PATH and PKG_CONFIG_PATH
216 variables need to be defined for the root user. If using sudo to assume
217 root, use the -E option to pass your current environment variables for the
218 install process.
219 </para></note>
220-->
221
222 <para>
223 Now, as the <systemitem class="username">root</systemitem> user:
224 </para>
225
226<screen role="root"><userinput>ninja install</userinput></screen>
227
228 <para>
229 As the <option>-DENABLE_DOCUMENTATION=OFF</option> option is used,
230 the documentation is not rebuilt nor installed now. If you need the
231 documentation, you can either install <xref linkend='gi-docgen'/>
232 and remove this option from the <command>cmake</command> command,
233 or install the pre-built documentation instead:
234 </para>
235
236<screen role='root'><userinput>install -vdm755 /usr/share/gtk-doc/html/{jsc-glib,webkit2gtk{,-web-extension}}-4.1 &amp;&amp;
237install -vm644 ../Documentation/jsc-glib-4.1/* \
238 /usr/share/gtk-doc/html/jsc-glib-4.1 &amp;&amp;
239install -vm644 ../Documentation/webkit2gtk-4.1/* \
240 /usr/share/gtk-doc/html/webkit2gtk-4.1 &amp;&amp;
241install -vm644 ../Documentation/webkit2gtk-web-extension-4.1/* \
242 /usr/share/gtk-doc/html/webkit2gtk-web-extension-4.1</userinput></screen>
243
244 <para>
245 If you want to install the GTK4 version of
246 <application>WebKitGTK</application>, run the following commands:
247 </para>
248
249<screen revision="systemd"><userinput>rm -rf * .[^.]* &amp;&amp;
250
251cmake -DCMAKE_BUILD_TYPE=Release \
252 -DCMAKE_INSTALL_PREFIX=/usr \
253 -DCMAKE_SKIP_RPATH=ON \
254 -DPORT=GTK \
255 -DLIB_INSTALL_DIR=/usr/lib \
256 -DUSE_LIBHYPHEN=OFF \
257 -DENABLE_GAMEPAD=OFF \
258 -DENABLE_MINIBROWSER=ON \
259 -DENABLE_DOCUMENTATION=OFF \
260 -DUSE_WOFF2=OFF \
261 -DUSE_GTK4=ON \
262 -DUSE_WPE_RENDERER=ON \
263 -DENABLE_BUBBLEWRAP_SANDBOX=OFF \
264 -Wno-dev -G Ninja .. &amp;&amp;
265ninja</userinput></screen>
266
267<screen revision="sysv"><userinput>rm -rf * .[^.]* &amp;&amp;
268
269cmake -DCMAKE_BUILD_TYPE=Release \
270 -DCMAKE_INSTALL_PREFIX=/usr \
271 -DCMAKE_SKIP_RPATH=ON \
272 -DPORT=GTK \
273 -DLIB_INSTALL_DIR=/usr/lib \
274 -DUSE_LIBHYPHEN=OFF \
275 -DENABLE_GAMEPAD=OFF \
276 -DENABLE_MINIBROWSER=ON \
277 -DENABLE_DOCUMENTATION=OFF \
278 -DUSE_WOFF2=OFF \
279 -DUSE_GTK4=ON \
280 -DUSE_WPE_RENDERER=ON \
281 -DENABLE_JOURNALD_LOG=OFF \
282 -DENABLE_BUBBLEWRAP_SANDBOX=OFF \
283 -Wno-dev -G Ninja .. &amp;&amp;
284ninja</userinput></screen>
285
286 <para>
287 Now, as the <systemitem class="username">root</systemitem> user:
288 </para>
289
290<screen role="root"><userinput>ninja install</userinput></screen>
291
292 </sect2>
293
294 <sect2 role="commands">
295 <title>Command Explanations</title>
296
297<!-- <para>
298 <command>sed ... TextCheckerEnchant.cpp</command>: This command
299 is needed to allow the build to complete with enchant-2.x.
300 </para> -->
301
302 <para>
303 <parameter>-DUSE_LIBHYPHEN=OFF</parameter>: This switch disables the
304 default automatic hyphenation implementation. You need to install
305 <ulink
306 url="https://sourceforge.net/projects/hunspell/files/Hyphen/">Hyphen</ulink>
307 if you wish to enable it (replacing OFF with ON or just removing
308 the switch).
309 </para>
310
311 <para>
312 <parameter>-DENABLE_DOCUMENTATION=OFF</parameter>: This switch disables
313 regenerating the documentation. Remove this switch if you have
314 <xref linkend="gi-docgen"/>
315 installed and wish to regenerate the documentation.
316 </para>
317
318 <para>
319 <parameter>-DENABLE_GAMEPAD=OFF</parameter>: This switch disables
320 gamepad support. Remove this switch if you have
321 <ulink url="https://gnome.pages.gitlab.gnome.org/libmanette/">libmanette</ulink>
322 installed and wish to enable it.
323 </para>
324
325 <para>
326 <parameter>-DENABLE_MINIBROWSER=ON</parameter>: This switch enables
327 compiling and installing the MiniBrowser.
328 </para>
329
330 <para>
331 <parameter>-DUSE_WPE_RENDERER=ON</parameter>: This switch uses the WPE
332 renderer, which is recommended by upstream.
333 </para>
334
335 <para>
336 <parameter>-DENABLE_BUBBLEWRAP_SANDBOX=OFF</parameter>: Remove this
337 switch if the optional packages <xref linkend="bubblewrap"/> and
338 <ulink url="https://github.com/flatpak/xdg-dbus-proxy">xdg-dbus-proxy</ulink>
339 are installed.
340 </para>
341
342 <para revision="sysv">
343 <parameter>-DENABLE_JOURNALD_LOG=OFF</parameter>: This switch disables using the
344 systemd journal for logging errors and debugging information since it
345 is not available on SysV systems.
346 </para>
347
348 <para>
349 <option>-DUSE_SYSTEM_MALLOC=ON</option>: This switch enables building
350 against the system installed <application>malloc</application>.
351 </para>
352
353 <para>
354 <option>-DENABLE_GEOLOCATION=OFF</option>: Use this switch if you don't
355 want to install <xref linkend="geoclue2"/>.
356 </para>
357
358 <para>
359 <option>-DUSE_AVIF=OFF</option>: Use this switch if you don't want to
360 install <xref linkend="libavif"/>. Note that you will not have support
361 for AVIF images if you do this.
362 </para>
363
364 <para>
365 <option>-DUSE_WOFF2=ON</option>: Use this switch if the optional
366 package <xref linkend="woff2"/> is installed. This adds additional
367 support for fonts.
368 </para>
369
370 <!-- Uncomment once GTK4 support works, or when it doesn't require
371 a development version of libsoup.
372 <para>
373 <option>-DUSE_GTK4=ON</option>: Use this switch if <xref linkend="gtk4"/>
374 is installed and you wish to build GTK4 support.
375 </para>
376 -->
377
378 </sect2>
379
380 <sect2 role="content">
381 <title>Contents</title>
382
383 <segmentedlist>
384 <segtitle>Installed Program</segtitle>
385 <segtitle>Installed Libraries</segtitle>
386 <segtitle>Installed Directories</segtitle>
387
388 <seglistitem>
389 <seg>
390<!-- Moved to /usr/libexec/webkit2gtk-4.0, so shouldn't appear here
391 jsc,
392 MiniBrowser, and -->
393 WebKitWebDriver
394 </seg>
395 <seg>
396 libjavascriptcoregtk-4.1.so,
397 libjavascriptcoregtk-6.0.so,
398 libwebkit2gtk-4.1.so, and
399 libwebkitgtk-6.0.so
400 </seg>
401 <seg>
402 /usr/include/webkitgtk-4.1,
403 /usr/include/webkitgtk-6.0,
404 /usr/lib{,exec}/webkit2gtk-4.1,
405 /usr/lib{,exec}/webkitgtk-6.0, and
406 /usr/share/gtk-doc/html/{jsc-glib,webkit2gtk{,-web-extension}}-4.1
407 </seg>
408 </seglistitem>
409 </segmentedlist>
410
411 <variablelist>
412 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
413 <?dbfo list-presentation="list"?>
414 <?dbhtml list-presentation="table"?>
415
416<!--
417 <varlistentry id="jsc">
418 <term><command>jsc</command></term>
419 <listitem>
420 <para>
421 is a command-line utility that allows you to run JavaScript programs
422 outside of the context of a web browser.
423 </para>
424 <indexterm zone="webkitgtk jsc">
425 <primary sortas="b-jsc">jsc</primary>
426 </indexterm>
427 </listitem>
428 </varlistentry>
429
430 <varlistentry id="MiniBrowser">
431 <term><command>MiniBrowser</command></term>
432 <listitem>
433 <para>
434 is a very simple graphical browser.
435 </para>
436 <indexterm zone="webkitgtk MiniBrowser">
437 <primary sortas="b-MiniBrowser">MiniBrowser</primary>
438 </indexterm>
439 </listitem>
440 </varlistentry>
441-->
442 <varlistentry id="WebKitWebDriver">
443 <term><command>WebKitWebDriver</command></term>
444 <listitem>
445 <para>
446 allows debugging and automation of web pages and browsers
447 </para>
448 <indexterm zone="webkitgtk WebKitWebDriver">
449 <primary sortas="b-WebKitWebDriver">WebKitWebDriver</primary>
450 </indexterm>
451 </listitem>
452 </varlistentry>
453
454 <varlistentry id="libjavascriptcoregtk-4.1">
455 <term>
456 <filename class="libraryfile">libjavascriptcoregtk-4.1.so</filename>
457 </term>
458 <listitem>
459 <para>
460 contains core JavaScript API functions used by
461 <command>jsc</command> and
462 <filename class="libraryfile">libwebkit2gtk-4.1</filename>
463 </para>
464 <indexterm zone="webkitgtk libjavascriptcoregtk-4.1">
465 <primary sortas="c-libjavascriptcoregtk-4.1">libjavascriptcoregtk-4.1.so</primary>
466 </indexterm>
467 </listitem>
468 </varlistentry>
469
470 <varlistentry id="libjavascriptcoregtk-6.0">
471 <term><filename class="libraryfile">libjavascriptcoregtk-6.0.so</filename></term>
472 <listitem>
473 <para>
474 contains core JavaScript API functions used by
475 <command>jsc</command> and
476 <filename class="libraryfile">libwebkitgtk-6.0.so</filename>
477 </para>
478 <indexterm zone="webkitgtk libjavascriptcoregtk-6.0">
479 <primary sortas="c-libjavascriptcoregtk-6.0">libjavascriptcoregtk-6.0.so</primary>
480 </indexterm>
481 </listitem>
482 </varlistentry>
483
484 <varlistentry id="libwebkit2gtk-4">
485 <term><filename class="libraryfile">libwebkit2gtk-4.1.so</filename></term>
486 <listitem>
487 <para>
488 contains the <application>WebKit2</application> API functions
489 </para>
490 <indexterm zone="webkitgtk libwebkit2gtk-4">
491 <primary sortas="c-libwebkit2gtk-4">libwebkit2gtk-4.1.so</primary>
492 </indexterm>
493 </listitem>
494 </varlistentry>
495
496 <varlistentry id="libwebkitgtk-6">
497 <term><filename class="libraryfile">libwebkitgtk-6.0.so</filename></term>
498 <listitem>
499 <para>
500 contains the <application>WebKit</application> API functions for
501 GTK-4 applications
502 </para>
503 <indexterm zone="webkitgtk libwebkitgtk-6">
504 <primary sortas="c-libwebkitgtk-6">libwebkitgtk-6.0.so</primary>
505 </indexterm>
506 </listitem>
507 </varlistentry>
508
509 </variablelist>
510
511 </sect2>
512
513</sect1>
Note: See TracBrowser for help on using the repository browser.