source: x/lib/webkitgtk.xml@ eb2a639

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

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