source: x/lib/webkitgtk.xml

trunk
Last change on this file was 11863c1d, checked in by Xi Ruoyao <xry111@…>, 5 days ago

webkitgtk: Add -DENABLE_WEBDRIVER=OFF for sysv gtk-3 build too

Stupid I. I didn't realize this package needs different cmake commands
for systemd and sysv.

Reported-by: Thomas Trepl <thomas@…>
  • Property mode set to 100644
File size: 17.4 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
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 "b3a4504892162b30a774d3afde4707f7">
10 <!ENTITY webkitgtk-size "35 MB">
11 <!ENTITY webkitgtk-buildsize "1.2 GB (156 MB installed, add 151 MB for GTK-4)">
12 <!ENTITY webkitgtk-time "25 SBU (for GTK-3, using parallelism=8, add 25 SBU for GTK-4)">
13
14 <!ENTITY libbacktrace
15 "<ulink url='https://github.com/ianlancetaylor/libbacktrace'>libbacktrace</ulink>">
16]>
17
18<sect1 id="webkitgtk" xreflabel="WebKitGTK-&webkitgtk-version;">
19 <?dbhtml filename="webkitgtk.html"?>
20
21
22 <title>WebKitGTK-&webkitgtk-version;</title>
23
24 <indexterm zone="webkitgtk">
25 <primary sortas="a-WebKitGTK">WebKitGTK</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to WebKitGTK</title>
30
31 <para>
32 The <application>WebKitGTK</application> package is a port of the
33 portable web rendering engine <application>WebKit</application> to the
34 <application>GTK+ 3</application> and <application>GTK 4</application>
35 platforms.
36 </para>
37
38 &lfs121_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&webkitgtk-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&webkitgtk-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &webkitgtk-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &webkitgtk-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &webkitgtk-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &webkitgtk-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73
74<!--
75 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
76 <itemizedlist spacing="compact">
77 <listitem>
78 <para>
79 Required patch:
80 <ulink url="&patch-root;/webkitgtk-&webkitgtk-version;-upstream_fixes-1.patch"/>
81 </para>
82 </listitem>
83 </itemizedlist>
84-->
85
86 <bridgehead renderas="sect3">WebKitGTK Dependencies</bridgehead>
87
88 <bridgehead renderas="sect4">Required</bridgehead>
89 <para role="required">
90 <xref linkend="cairo"/>,
91 <xref linkend="cmake"/>,
92 <xref linkend="gst10-plugins-base"/>,
93 <xref linkend="gst10-plugins-bad"/>,
94 <xref linkend="gtk3"/>,
95 <xref linkend="gtk4"/>,
96 <xref linkend="icu"/>,
97 <xref linkend="lcms2"/>,
98 <xref linkend="libgudev"/>,
99 <xref linkend="libsecret"/>,
100 <xref linkend="libsoup3"/>,
101 <xref linkend="libtasn1"/>,
102 <xref linkend="libwebp"/>,
103 <xref linkend="mesa"/>,
104 <xref linkend="openjpeg2"/>,
105 <xref linkend="ruby"/>,
106 <xref linkend="sqlite"/>,
107 <xref linkend="unifdef"/>, and
108 <xref linkend="which"/>
109 </para>
110
111 <bridgehead renderas="sect4">Recommended</bridgehead>
112 <para role="recommended">
113 <xref linkend="bubblewrap"/>,
114 <xref linkend="enchant"/>,
115 <xref linkend="geoclue2"/>,
116 &gobject-introspection;,
117 <xref linkend="hicolor-icon-theme"/>,
118 <xref linkend="libavif"/>,
119 <xref linkend="libjxl"/>,
120 <xref linkend="libseccomp"/>, and
121 <xref linkend="xdg-dbus-proxy"/>
122 </para>
123
124 <bridgehead renderas="sect4">Optional</bridgehead>
125 <para role="optional">
126 <xref linkend="gi-docgen"/>,
127 <xref linkend="harfbuzz"/>,
128 <xref linkend="wayland"/>,
129 <xref linkend="woff2"/>,
130 <ulink url="https://ccache.dev/">ccache</ulink>,
131 <ulink url="https://sourceforge.net/projects/hunspell/files/Hyphen/">Hyphen</ulink>,
132 &libbacktrace;, and
133 <!--<ulink url="https://github.com/libjxl/libjxl">libjxl</ulink>, and-->
134 <ulink url="https://gnome.pages.gitlab.gnome.org/libmanette/">libmanette</ulink>
135 </para>
136
137 </sect2>
138
139 <sect2 role="installation">
140 <title>Installation of WebKitGTK</title>
141
142 <bridgehead renderas="sect3">Installation of
143 <application>WebKitGTK</application></bridgehead>
144
145 <important>
146 <para>
147 This package allows building with either GTK-3 or GTK-4, but not both
148 in the same build. The GTK-4 version is needed for packages such as
149 <xref linkend="epiphany"/>. Other packages, such as
150 <xref linkend="balsa"/> or <xref linkend="evolution"/>, require the
151 GTK-3 version. Both versions can be installed side by side on the
152 same system. We give build instructions for both cases below, but
153 the only difference is the setting of <command>-DUSE_GTK4</command>
154 </para>
155 </important>
156
157 <para>
158 If you want to install the GTK+-3 version of
159 <application>WebKitGTK</application>, run the following commands:
160 </para>
161
162<screen revision="systemd"><userinput>mkdir -vp build &amp;&amp;
163cd build &amp;&amp;
164
165cmake -DCMAKE_BUILD_TYPE=Release \
166 -DCMAKE_INSTALL_PREFIX=/usr \
167 -DCMAKE_SKIP_RPATH=ON \
168 -DPORT=GTK \
169 -DLIB_INSTALL_DIR=/usr/lib \
170 -DUSE_LIBBACKTRACE=OFF \
171 -DUSE_LIBHYPHEN=OFF \
172 -DENABLE_GAMEPAD=OFF \
173 -DENABLE_MINIBROWSER=ON \
174 -DENABLE_DOCUMENTATION=OFF \
175 -DENABLE_WEBDRIVER=OFF \
176 -DUSE_WOFF2=OFF \
177 -DUSE_GTK4=OFF \
178 -DENABLE_BUBBLEWRAP_SANDBOX=ON \
179 -Wno-dev -G Ninja .. &amp;&amp;
180ninja</userinput></screen>
181
182<screen revision="sysv"><userinput>mkdir -vp build &amp;&amp;
183cd build &amp;&amp;
184
185cmake -DCMAKE_BUILD_TYPE=Release \
186 -DCMAKE_INSTALL_PREFIX=/usr \
187 -DCMAKE_SKIP_RPATH=ON \
188 -DPORT=GTK \
189 -DLIB_INSTALL_DIR=/usr/lib \
190 -DUSE_LIBBACKTRACE=OFF \
191 -DUSE_LIBHYPHEN=OFF \
192 -DENABLE_GAMEPAD=OFF \
193 -DENABLE_MINIBROWSER=ON \
194 -DENABLE_DOCUMENTATION=OFF \
195 -DENABLE_WEBDRIVER=OFF \
196 -DUSE_WOFF2=OFF \
197 -DUSE_GTK4=OFF \
198 -DENABLE_JOURNALD_LOG=OFF \
199 -DENABLE_BUBBLEWRAP_SANDBOX=ON \
200 -Wno-dev -G Ninja .. &amp;&amp;
201ninja</userinput></screen>
202
203 <para>
204 This package does not have a working test suite. However, there is a
205 usable basic graphical web browser in the build directory,
206 <application>build/bin/MiniBrowser</application>. If launching it fails,
207 there is a problem with the build.
208 </para>
209
210 <para>
211 Now, as the <systemitem class="username">root</systemitem> user:
212 </para>
213
214<screen role="root"><userinput>ninja install</userinput></screen>
215
216 <para>
217 If you want to install the GTK4 version of
218 <application>WebKitGTK</application>, run the following commands:
219 </para>
220
221<screen revision="systemd"><userinput>rm -rf * .[^.]* &amp;&amp;
222
223cmake -DCMAKE_BUILD_TYPE=Release \
224 -DCMAKE_INSTALL_PREFIX=/usr \
225 -DCMAKE_SKIP_RPATH=ON \
226 -DPORT=GTK \
227 -DLIB_INSTALL_DIR=/usr/lib \
228 -DUSE_LIBBACKTRACE=OFF \
229 -DUSE_LIBHYPHEN=OFF \
230 -DENABLE_GAMEPAD=OFF \
231 -DENABLE_MINIBROWSER=ON \
232 -DENABLE_DOCUMENTATION=OFF \
233 -DUSE_WOFF2=OFF \
234 -DUSE_GTK4=ON \
235 -DENABLE_BUBBLEWRAP_SANDBOX=ON \
236 -Wno-dev -G Ninja .. &amp;&amp;
237ninja</userinput></screen>
238
239<screen revision="sysv"><userinput>rm -rf * .[^.]* &amp;&amp;
240
241cmake -DCMAKE_BUILD_TYPE=Release \
242 -DCMAKE_INSTALL_PREFIX=/usr \
243 -DCMAKE_SKIP_RPATH=ON \
244 -DPORT=GTK \
245 -DLIB_INSTALL_DIR=/usr/lib \
246 -DUSE_LIBBACKTRACE=OFF \
247 -DUSE_LIBHYPHEN=OFF \
248 -DENABLE_GAMEPAD=OFF \
249 -DENABLE_MINIBROWSER=ON \
250 -DENABLE_DOCUMENTATION=OFF \
251 -DUSE_WOFF2=OFF \
252 -DUSE_GTK4=ON \
253 -DENABLE_JOURNALD_LOG=OFF \
254 -DENABLE_BUBBLEWRAP_SANDBOX=ON \
255 -Wno-dev -G Ninja .. &amp;&amp;
256ninja</userinput></screen>
257
258 <para>
259 Now, as the <systemitem class="username">root</systemitem> user:
260 </para>
261
262<screen role="root"><userinput>ninja install</userinput></screen>
263
264 <para>
265 As the <option>-DENABLE_DOCUMENTATION=OFF</option> option is used,
266 the documentation is not rebuilt nor installed now. If you need the
267 documentation, you can either install <xref linkend='gi-docgen'/>
268 and remove this option from the <command>cmake</command> command,
269 or install the pre-built documentation (only for the GTK-4 version)
270 instead:
271 </para>
272
273<screen role='root'><userinput>install -vdm755 /usr/share/gtk-doc/html &amp;&amp;
274cp -rv ../Documentation/* /usr/share/gtk-doc/html</userinput></screen>
275
276 </sect2>
277
278 <sect2 role="commands">
279 <title>Command Explanations</title>
280
281<!-- <para>
282 <command>sed ... TextCheckerEnchant.cpp</command>: This command
283 is needed to allow the build to complete with enchant-2.x.
284 </para> -->
285
286 <para>
287 <parameter>-DUSE_LIBBACKTRACE=OFF</parameter>: This switch disables
288 the use of libbacktrace for dumping a stack trace when a crash
289 happens. You need to install &libbacktrace; if you wish to enable it
290 (replacing OFF with ON or just removing the switch).
291 </para>
292
293 <para>
294 <parameter>-DUSE_LIBHYPHEN=OFF</parameter>: This switch disables the
295 default automatic hyphenation implementation. You need to install
296 <ulink
297 url="https://sourceforge.net/projects/hunspell/files/Hyphen/">Hyphen</ulink>
298 if you wish to enable it (replacing OFF with ON or just removing
299 the switch).
300 </para>
301
302 <para>
303 <parameter>-DENABLE_DOCUMENTATION=OFF</parameter>: This switch disables
304 regenerating the documentation. Remove this switch if you have
305 <xref linkend="gi-docgen"/>
306 installed and wish to regenerate the documentation.
307 </para>
308
309 <para>
310 <parameter>-DENABLE_GAMEPAD=OFF</parameter>: This switch disables
311 gamepad support. Remove this switch if you have
312 <ulink url="https://gnome.pages.gitlab.gnome.org/libmanette/">libmanette</ulink>
313 installed and wish to enable it.
314 </para>
315
316 <para>
317 <parameter>-DENABLE_MINIBROWSER=ON</parameter>: This switch enables
318 compiling and installing the MiniBrowser.
319 </para>
320
321 <para>
322 <parameter>-DENABLE_WEBDRIVER=OFF</parameter>: This switch disables
323 compiling and installing <command>WebKitWebDriver</command>. We use
324 it for the GTK-3 build because the <command>WebKitWebDriver</command>
325 from the GTK-3 build will be overwritten by the GTK-4 build anyway.
326 Remove this option if you don't plan to build this package with
327 GTK-4.
328 </para>
329
330<!--
331 <para>
332 <parameter>-DUSE_JPEGXL=OFF</parameter>: This switch turns off support
333 for JPEG-XL images. Remove it if you have the optional package
334 <ulink url="https://github.com/libjxl/libjxl">libjxl</ulink> installed.
335 </para>
336-->
337 <para>
338 <parameter>-DENABLE_BUBBLEWRAP_SANDBOX=ON</parameter>: This switch
339 enables the Bubblewrap sandbox, which helps mitigate the impact of most
340 security vulnerabilities in this package. Change this switch to OFF if
341 you do not want to install <xref linkend="bubblewrap" role="nodep"/>,
342 <xref linkend='libseccomp' role="nodep"/>, or
343 <xref linkend="xdg-dbus-proxy" role="nodep"/>, but note that this may
344 put you at risk.
345 <!-- Note: This works well on both i686 and x86_64. -renodr -->
346 </para>
347
348 <para revision="sysv">
349 <parameter>-DENABLE_JOURNALD_LOG=OFF</parameter>: This switch disables using the
350 systemd journal for logging errors and debugging information since it
351 is not available on SysV systems.
352 </para>
353
354 <para>
355 <option>-DUSE_SYSTEM_MALLOC=ON</option>: This switch enables building
356 against the system installed <application>malloc</application>.
357 </para>
358
359 <para>
360 <option>-DENABLE_GEOLOCATION=OFF</option>: Use this switch if you don't
361 want to install <xref linkend="geoclue2"/>.
362 </para>
363
364 <para>
365 <option>-DUSE_AVIF=OFF</option>: Use this switch if you don't want to
366 install <xref linkend="libavif"/>. Note that you will not have support
367 for AVIF images if you do this.
368 </para>
369
370 <para>
371 <option>-DUSE_WOFF2=ON</option>: Use this switch if the optional
372 package <xref linkend="woff2"/> is installed. This adds additional
373 support for fonts.
374 </para>
375
376 <para>
377 <option>-DUSE_JPEGXL=OFF</option>: Use this switch if the recommended
378 package <xref linkend="libjxl"/> is not installed. Note that you will not
379 have support for JPEG XL images if this option is passed.
380 </para>
381
382 </sect2>
383
384 <sect2 role="content">
385 <title>Contents</title>
386
387 <segmentedlist>
388 <segtitle>Installed Program</segtitle>
389 <segtitle>Installed Libraries</segtitle>
390 <segtitle>Installed Directories</segtitle>
391
392 <seglistitem>
393 <seg>
394<!-- Moved to /usr/libexec/webkit2gtk-4.0, so shouldn't appear here
395 jsc,
396 MiniBrowser, and -->
397 WebKitWebDriver
398 </seg>
399 <seg>
400 libjavascriptcoregtk-4.1.so,
401 libjavascriptcoregtk-6.0.so,
402 libwebkit2gtk-4.1.so, and
403 libwebkitgtk-6.0.so
404 </seg>
405 <seg>
406 /usr/include/webkitgtk-4.1,
407 /usr/include/webkitgtk-6.0,
408 /usr/lib{,exec}/webkit2gtk-4.1,
409 /usr/lib{,exec}/webkitgtk-6.0,
410 /usr/share/gtk-doc/html/{jsc-glib,webkit2gtk{,-web-extension}}-4.1
411 (optional), and
412 /usr/share/gtk-doc/html/{jsc-glib,webkit2gtk{,-web-process-extension}}-6.0
413 </seg>
414 </seglistitem>
415 </segmentedlist>
416
417 <variablelist>
418 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
419 <?dbfo list-presentation="list"?>
420 <?dbhtml list-presentation="table"?>
421
422<!--
423 <varlistentry id="jsc">
424 <term><command>jsc</command></term>
425 <listitem>
426 <para>
427 is a command-line utility that allows you to run JavaScript programs
428 outside of the context of a web browser.
429 </para>
430 <indexterm zone="webkitgtk jsc">
431 <primary sortas="b-jsc">jsc</primary>
432 </indexterm>
433 </listitem>
434 </varlistentry>
435
436 <varlistentry id="MiniBrowser">
437 <term><command>MiniBrowser</command></term>
438 <listitem>
439 <para>
440 is a very simple graphical browser.
441 </para>
442 <indexterm zone="webkitgtk MiniBrowser">
443 <primary sortas="b-MiniBrowser">MiniBrowser</primary>
444 </indexterm>
445 </listitem>
446 </varlistentry>
447-->
448 <varlistentry id="WebKitWebDriver">
449 <term><command>WebKitWebDriver</command></term>
450 <listitem>
451 <para>
452 allows debugging and automation of web pages and browsers
453 </para>
454 <indexterm zone="webkitgtk WebKitWebDriver">
455 <primary sortas="b-WebKitWebDriver">WebKitWebDriver</primary>
456 </indexterm>
457 </listitem>
458 </varlistentry>
459
460 <varlistentry id="libjavascriptcoregtk-4.1">
461 <term>
462 <filename class="libraryfile">libjavascriptcoregtk-4.1.so</filename>
463 </term>
464 <listitem>
465 <para>
466 contains core JavaScript API functions used by
467 <command>jsc</command> and
468 <filename class="libraryfile">libwebkit2gtk-4.1</filename>
469 </para>
470 <indexterm zone="webkitgtk libjavascriptcoregtk-4.1">
471 <primary sortas="c-libjavascriptcoregtk-4.1">libjavascriptcoregtk-4.1.so</primary>
472 </indexterm>
473 </listitem>
474 </varlistentry>
475
476 <varlistentry id="libjavascriptcoregtk-6.0">
477 <term><filename class="libraryfile">libjavascriptcoregtk-6.0.so</filename></term>
478 <listitem>
479 <para>
480 contains core JavaScript API functions used by
481 <command>jsc</command> and
482 <filename class="libraryfile">libwebkitgtk-6.0</filename>
483 </para>
484 <indexterm zone="webkitgtk libjavascriptcoregtk-6.0">
485 <primary sortas="c-libjavascriptcoregtk-6.0">libjavascriptcoregtk-6.0.so</primary>
486 </indexterm>
487 </listitem>
488 </varlistentry>
489
490 <varlistentry id="libwebkit2gtk-4">
491 <term><filename class="libraryfile">libwebkit2gtk-4.1.so</filename></term>
492 <listitem>
493 <para>
494 contains the <application>WebKit2</application> API functions
495 </para>
496 <indexterm zone="webkitgtk libwebkit2gtk-4">
497 <primary sortas="c-libwebkit2gtk-4">libwebkit2gtk-4.1.so</primary>
498 </indexterm>
499 </listitem>
500 </varlistentry>
501
502 <varlistentry id="libwebkitgtk-6">
503 <term><filename class="libraryfile">libwebkitgtk-6.0.so</filename></term>
504 <listitem>
505 <para>
506 contains the <application>WebKit</application> API functions for
507 GTK-4 applications
508 </para>
509 <indexterm zone="webkitgtk libwebkitgtk-6">
510 <primary sortas="c-libwebkitgtk-6">libwebkitgtk-6.0.so</primary>
511 </indexterm>
512 </listitem>
513 </varlistentry>
514
515 </variablelist>
516
517 </sect2>
518
519</sect1>
Note: See TracBrowser for help on using the repository browser.