source: x/lib/webkitgtk.xml@ a2e1b33

qt5new
Last change on this file since a2e1b33 was 95abdf87, checked in by Pierre Labastie <pierre.labastie@…>, 17 months ago

Separate gtk4 and gtk3 instructions in webkigtk

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