source: x/lib/webkitgtk.xml@ 053e0a1

12.0 12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since 053e0a1 was 053e0a1, checked in by Douglas R. Reno <renodr@…>, 10 months ago

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