source: x/lib/webkitgtk.xml@ afe28f4

11.3 12.0 12.1 12.2 gimp3 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new 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 afe28f4 was c5408a2, checked in by Douglas R. Reno <renodr@…>, 21 months ago

Add an entity for the gi-docgen URL and change several packages to use
it.

This should make the different URLs we had previously consistent with
one another, and ease maintenance burden.

This is only temporary though since eventually gi-docgen will become
part of the book, when Pierre's python-modules branch is brought into
trunk.

  • Property mode set to 100644
File size: 13.2 KB
RevLine 
[1a024c3c]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
[8dfc5c3]7 <!ENTITY webkitgtk-download-http "https://webkitgtk.org/releases/webkitgtk-&webkitgtk-version;.tar.xz">
[de4ed8e]8 <!ENTITY webkitgtk-download-ftp " ">
[c7318b4]9 <!ENTITY webkitgtk-md5sum "c234585a51c015a42c80c705222098c6">
10 <!ENTITY webkitgtk-size "31 MB">
11 <!ENTITY webkitgtk-buildsize "1.1 GB (172 MB installed)">
12 <!ENTITY webkitgtk-time "33 SBU (using parallelism=4)">
[1a024c3c]13]>
14
[442c799]15<sect1 id="webkitgtk" xreflabel="WebKitGTK-&webkitgtk-version;">
[de4ed8e]16 <?dbhtml filename="webkitgtk.html"?>
[1a024c3c]17
18
[442c799]19 <title>WebKitGTK-&webkitgtk-version;</title>
[1a024c3c]20
[de4ed8e]21 <indexterm zone="webkitgtk">
[442c799]22 <primary sortas="a-WebKitGTK">WebKitGTK</primary>
[1a024c3c]23 </indexterm>
24
25 <sect2 role="package">
[442c799]26 <title>Introduction to WebKitGTK</title>
[1a024c3c]27
28 <para>
[8558044]29 The <application>WebKitGTK</application> package is a port of the
[4026a19]30 portable web rendering engine <application>WebKit</application> to the
[cbe60bd]31 <application>GTK+ 3</application> and <application>GTK 4</application>
[1a024c3c]32 platforms.
33 </para>
34
[b1c0fa7]35 &lfs112_checked;
[1a024c3c]36
37 <bridgehead renderas="sect3">Package Information</bridgehead>
38 <itemizedlist spacing="compact">
39 <listitem>
40 <para>
[de4ed8e]41 Download (HTTP): <ulink url="&webkitgtk-download-http;"/>
[1a024c3c]42 </para>
43 </listitem>
44 <listitem>
45 <para>
[de4ed8e]46 Download (FTP): <ulink url="&webkitgtk-download-ftp;"/>
[1a024c3c]47 </para>
48 </listitem>
49 <listitem>
50 <para>
[de4ed8e]51 Download MD5 sum: &webkitgtk-md5sum;
[1a024c3c]52 </para>
53 </listitem>
54 <listitem>
55 <para>
[de4ed8e]56 Download size: &webkitgtk-size;
[1a024c3c]57 </para>
58 </listitem>
59 <listitem>
60 <para>
[de4ed8e]61 Estimated disk space required: &webkitgtk-buildsize;
[1a024c3c]62 </para>
63 </listitem>
64 <listitem>
65 <para>
[de4ed8e]66 Estimated build time: &webkitgtk-time;
[1a024c3c]67 </para>
68 </listitem>
69 </itemizedlist>
70
[dbfabc6]71<!--
[b01309e7]72 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
73 <itemizedlist spacing="compact">
74 <listitem>
75 <para>
76 Required patch:
[8f1785c]77 <ulink url="&patch-root;/webkitgtk-&webkitgtk-version;-upstream_fix-1.patch"/>
[b01309e7]78 </para>
79 </listitem>
80 </itemizedlist>
[dbfabc6]81-->
[b01309e7]82
[442c799]83 <bridgehead renderas="sect3">WebKitGTK Dependencies</bridgehead>
[1a024c3c]84
85 <bridgehead renderas="sect4">Required</bridgehead>
86 <para role="required">
[4026a19]87 <xref linkend="cairo"/>,
[1a024c3c]88 <xref linkend="cmake"/>,
89 <xref linkend="gst10-plugins-base"/>,
[ad930e67]90 <xref linkend="gst10-plugins-bad"/>,
[1a024c3c]91 <xref linkend="gtk3"/>,
92 <xref linkend="icu"/>,
[885bcd41]93 <xref linkend="lcms2"/>,
[f175d6f6]94 <xref linkend="libgudev"/>,
[1a024c3c]95 <xref linkend="libsecret"/>,
[c7318b4]96 <xref linkend="libsoup3"/>,
[40454cd2]97 <xref linkend="libtasn1"/>,
[1a024c3c]98 <xref linkend="libwebp"/>,
[7a395d1]99 <xref linkend="mesa"/>,
[2367283]100 <xref linkend="openjpeg2"/>,
[1a024c3c]101 <xref linkend="ruby"/>,
[fbfb998]102 <xref linkend="sqlite"/>,
103 <xref linkend="which"/>, and
104 <xref linkend="wpebackend-fdo"/>
[1a024c3c]105 </para>
106
107 <bridgehead renderas="sect4">Recommended</bridgehead>
[fddab91]108 <para role="recommended">
[decb6bc5]109 <xref linkend="enchant"/>,
[560b86d]110 <xref linkend="geoclue2"/>,
[c7318b4]111 <xref linkend="gobject-introspection"/>, and
112 <xref linkend="hicolor-icon-theme"/>
[4026a19]113 </para>
[1a024c3c]114
115 <bridgehead renderas="sect4">Optional</bridgehead>
[fddab91]116 <para role="optional">
[0940157]117 <xref linkend="bubblewrap"/>,
[9d31900]118 <xref linkend="gtk4"/>,
[1a024c3c]119 <xref linkend="harfbuzz"/>,
[47d5a9e5]120 <xref linkend="wayland"/>,
121 <xref linkend="woff2"/>,
[9851978]122 <ulink url="https://ccache.dev/">ccache</ulink>,
[c5408a2]123 <ulink url="&gi-docgen-url;">gi-docgen</ulink>,
[c6b192c]124 <ulink url="https://sourceforge.net/projects/hunspell/files/Hyphen/">Hyphen</ulink>,
[e90881c]125 <ulink url="https://github.com/AOMediaCodec/libavif">libavif</ulink>,
[fbfb998]126 <ulink url="https://gnome.pages.gitlab.gnome.org/libmanette/">libmanette</ulink>, and
[12b10249]127 <ulink url="https://github.com/flatpak/xdg-dbus-proxy">xdg-dbus-proxy</ulink>
[1a024c3c]128 </para>
129
130 <para condition="html" role="usernotes">
131 User Notes: <ulink url="&blfs-wiki;/webkitgtk"/>
132 </para>
133 </sect2>
134
135 <sect2 role="installation">
[442c799]136 <title>Installation of WebKitGTK</title>
[1a024c3c]137
138 <bridgehead renderas="sect3">Installation of
[442c799]139 <application>WebKitGTK</application></bridgehead>
[1a024c3c]140
[dbfabc6]141<!--
[8f1785c]142 <para>
143 Fix an issue causing a crash viewing some web pages:
144 </para>
145
146<screen><userinput>patch -Np1 -i ../webkitgtk-&webkitgtk-version;-upstream_fix-1.patch</userinput></screen>
[dbfabc6]147-->
[8f1785c]148
[1a024c3c]149 <para>
[442c799]150 Install <application>WebKitGTK</application> by running the
[1a024c3c]151 following commands:
152 </para>
[6fe4f013]153
[8252e757]154<screen revision="systemd"><userinput>mkdir -vp build &amp;&amp;
[24dfdcd]155cd build &amp;&amp;
[1a024c3c]156
[42b7dab]157cmake -DCMAKE_BUILD_TYPE=Release \
158 -DCMAKE_INSTALL_PREFIX=/usr \
159 -DCMAKE_SKIP_RPATH=ON \
160 -DPORT=GTK \
161 -DLIB_INSTALL_DIR=/usr/lib \
[a78d8510]162 -DUSE_LIBHYPHEN=OFF \
[40454cd2]163 -DENABLE_GAMEPAD=OFF \
[7c4f32b]164 -DENABLE_MINIBROWSER=ON \
[c7318b4]165 -DENABLE_DOCUMENTATION=OFF \
[f858bd7]166 -DUSE_WOFF2=OFF \
[fbfb998]167 -DUSE_WPE_RENDERER=ON \
[12b10249]168 -DENABLE_BUBBLEWRAP_SANDBOX=OFF \
169 -Wno-dev -G Ninja .. &amp;&amp;
[4291c1e]170ninja</userinput></screen>
[1a024c3c]171
[8252e757]172<screen revision="sysv"><userinput>mkdir -vp build &amp;&amp;
173cd build &amp;&amp;
174
175cmake -DCMAKE_BUILD_TYPE=Release \
176 -DCMAKE_INSTALL_PREFIX=/usr \
177 -DCMAKE_SKIP_RPATH=ON \
178 -DPORT=GTK \
179 -DLIB_INSTALL_DIR=/usr/lib \
180 -DUSE_LIBHYPHEN=OFF \
[1b1a555]181 -DENABLE_GAMEPAD=OFF \
[8252e757]182 -DENABLE_MINIBROWSER=ON \
[c7318b4]183 -DENABLE_DOCUMENTATION=OFF \
[8252e757]184 -DUSE_WOFF2=OFF \
[fbfb998]185 -DUSE_WPE_RENDERER=ON \
[c38d051]186 -DENABLE_JOURNALD_LOG=OFF \
[8252e757]187 -DENABLE_BUBBLEWRAP_SANDBOX=OFF \
188 -Wno-dev -G Ninja .. &amp;&amp;
189ninja</userinput></screen>
190
[1a024c3c]191 <para>
[48771ae]192 This package does not have a working test suite. However, there is a
[c69b5e72]193 usable basic graphical web browser in the build directory,
[7c4f32b]194 <application>build/bin/MiniBrowser</application>. If launching it fails,
195 there is a problem with the build.
[1a024c3c]196 </para>
197
[885bcd41]198<!-- Since we're using Ninja now instead of autotools, this isn't valid anymore
[1a024c3c]199 <note><para>
200 When installing, the Makefile does some additional compiling and linking.
201 If you do not have Xorg in /usr, the LIBRARY_PATH and PKG_CONFIG_PATH
202 variables need to be defined for the root user. If using sudo to assume
203 root, use the -E option to pass your current environment variables for the
204 install process.
205 </para></note>
[885bcd41]206-->
[1a024c3c]207
208 <para>
209 Now, as the <systemitem class="username">root</systemitem> user:
210 </para>
211
[4291c1e]212<screen role="root"><userinput>ninja install &amp;&amp;
[1a024c3c]213
[c7318b4]214install -vdm755 /usr/share/gtk-doc/html/{jsc-glib,webkit2gtk{,-web-extension}}-4.1 &amp;&amp;
215install -vm644 ../Documentation/jsc-glib-4.1/* \
[1936c94]216 /usr/share/gtk-doc/html/jsc-glib-4.1 &amp;&amp;
[c7318b4]217install -vm644 ../Documentation/webkit2gtk-4.1/* \
218 /usr/share/gtk-doc/html/webkit2gtk-4.1 &amp;&amp;
219install -vm644 ../Documentation/webkit2gtk-web-extension-4.1/* \
220 /usr/share/gtk-doc/html/webkit2gtk-web-extension-4.1</userinput></screen>
[1a024c3c]221 </sect2>
222
223 <sect2 role="commands">
224 <title>Command Explanations</title>
225
[016e770]226<!-- <para>
[fabeff7]227 <command>sed ... TextCheckerEnchant.cpp</command>: This command
[af451f4]228 is needed to allow the build to complete with enchant-2.x.
[016e770]229 </para> -->
[fabeff7]230
[a78d8510]231 <para>
[885bcd41]232 <parameter>-DUSE_LIBHYPHEN=OFF</parameter>: This switch disables the
[a78d8510]233 default automatic hyphenation implementation. You need to install
234 <ulink
[885bcd41]235 url="https://sourceforge.net/projects/hunspell/files/Hyphen/">Hyphen</ulink>
[a78d8510]236 if you wish to enable it (replacing OFF with ON or just removing
237 the switch).
238 </para>
239
[c7318b4]240 <para>
241 <parameter>-DENABLE_DOCUMENTATION=OFF</parameter>: This switch disables
242 regenerating the documentation. Remove this switch if you have
[c5408a2]243 <ulink url="&gi-docgen-url;">gi-docgen</ulink>
[c7318b4]244 installed and wish to regenerate the documentation.
245 </para>
246
[40454cd2]247 <para>
248 <parameter>-DENABLE_GAMEPAD=OFF</parameter>: This switch disables
249 gamepad support. Remove this switch if you have
250 <ulink url="https://gnome.pages.gitlab.gnome.org/libmanette/">libmanette</ulink>
251 installed and wish to enable it.
252 </para>
253
[7c4f32b]254 <para>
[8252e757]255 <parameter>-DENABLE_MINIBROWSER=ON</parameter>: This switch enables
256 compiling and installing the MiniBrowser.
[7c4f32b]257 </para>
258
[aa41434]259 <para>
[fbfb998]260 <parameter>-DUSE_WPE_RENDERER=ON</parameter>: This switch uses the WPE
261 renderer, which is recommended by upstream.
[aa41434]262 </para>
263
264 <para>
[8558044]265 <parameter>-DENABLE_BUBBLEWRAP_SANDBOX=OFF</parameter>: Remove this
[8252e757]266 switch if the optional packages <xref linkend="bubblewrap"/> and
[0940157]267 <ulink url="https://github.com/flatpak/xdg-dbus-proxy">xdg-dbus-proxy</ulink>
268 are installed.
[aa41434]269 </para>
[8252e757]270
271 <para revision="sysv">
[c38d051]272 <parameter>-DENABLE_JOURNALD_LOG=OFF</parameter>: This switch disables using the
[8252e757]273 systemd journal for logging errors and debugging information since it
274 is not available on SysV systems.
275 </para>
[aa41434]276
[1a024c3c]277 <para>
278 <option>-DUSE_SYSTEM_MALLOC=ON</option>: This switch enables building
279 against the system installed <application>malloc</application>.
280 </para>
281
282 <para>
283 <option>-DENABLE_GEOLOCATION=OFF</option>: Use this switch if you don't
[560b86d]284 want to install <xref linkend="geoclue2"/>.
[1a024c3c]285 </para>
286
[f858bd7]287 <para>
[8558044]288 <option>-DUSE_WOFF2=ON</option>: Use this switch if the optional
[1f61010e]289 package <xref linkend="woff2"/> is installed. This adds additional
290 support for fonts.
[f858bd7]291 </para>
292
[9d31900]293 <!-- Uncomment once GTK4 support works, or when it doesn't require
294 a development version of libsoup.
295 <para>
296 <option>-DUSE_GTK4=ON</option>: Use this switch if <xref linkend="gtk4"/>
297 is installed and you wish to build GTK4 support.
298 </para>
299 -->
300
[1a024c3c]301 </sect2>
302
303 <sect2 role="content">
304 <title>Contents</title>
305
306 <segmentedlist>
307 <segtitle>Installed Program</segtitle>
308 <segtitle>Installed Libraries</segtitle>
309 <segtitle>Installed Directories</segtitle>
310
311 <seglistitem>
312 <seg>
[da1575a]313<!-- Moved to /usr/libexec/webkit2gtk-4.0, so shouldn't appear here
[8558044]314 jsc,
[da1575a]315 MiniBrowser, and -->
[4291c1e]316 WebKitWebDriver
[1a024c3c]317 </seg>
318 <seg>
[c7318b4]319 libjavascriptcoregtk-4.1.so and
320 libwebkit2gtk-4.1.so
[1a024c3c]321 </seg>
322 <seg>
[c7318b4]323 /usr/include/webkitgtk-4.1,
324 /usr/lib{,exec}/webkit2gtk-4.1, and
325 /usr/share/gtk-doc/html/{jsc-glib,webkit2gtk{,-web-extension}}-4.1
[1a024c3c]326 </seg>
327 </seglistitem>
328 </segmentedlist>
329
330 <variablelist>
331 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
332 <?dbfo list-presentation="list"?>
333 <?dbhtml list-presentation="table"?>
334
[da1575a]335<!--
[1a024c3c]336 <varlistentry id="jsc">
337 <term><command>jsc</command></term>
338 <listitem>
339 <para>
340 is a command-line utility that allows you to run JavaScript programs
341 outside of the context of a web browser.
342 </para>
[de4ed8e]343 <indexterm zone="webkitgtk jsc">
[1a024c3c]344 <primary sortas="b-jsc">jsc</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348
[7c4f32b]349 <varlistentry id="MiniBrowser">
350 <term><command>MiniBrowser</command></term>
351 <listitem>
352 <para>
353 is a very simple graphical browser.
354 </para>
355 <indexterm zone="webkitgtk MiniBrowser">
356 <primary sortas="b-MiniBrowser">MiniBrowser</primary>
357 </indexterm>
358 </listitem>
359 </varlistentry>
[da1575a]360-->
[4d185c9e]361 <varlistentry id="WebKitWebDriver">
362 <term><command>WebKitWebDriver</command></term>
363 <listitem>
364 <para>
[4c24eb0a]365 allows debugging and automation of web pages and browsers
[4d185c9e]366 </para>
367 <indexterm zone="webkitgtk WebKitWebDriver">
368 <primary sortas="b-WebKitWebDriver">WebKitWebDriver</primary>
369 </indexterm>
370 </listitem>
371 </varlistentry>
372
[c7318b4]373 <varlistentry id="libjavascriptcoregtk-4.1">
[4c24eb0a]374 <term>
[c7318b4]375 <filename class="libraryfile">libjavascriptcoregtk-4.1.so</filename>
[4c24eb0a]376 </term>
[1a024c3c]377 <listitem>
378 <para>
379 contains core JavaScript API functions used by
[4c24eb0a]380 <command>jsc</command> and
[c7318b4]381 <filename class="libraryfile">libwebkit2gtk-4.1</filename>
[1a024c3c]382 </para>
[c7318b4]383 <indexterm zone="webkitgtk libjavascriptcoregtk-4.1">
384 <primary sortas="c-libjavascriptcoregtk-4.1">libjavascriptcoregtk-4.1.so</primary>
[1a024c3c]385 </indexterm>
386 </listitem>
387 </varlistentry>
388
389 <varlistentry id="libwebkit2gtk-4">
[c7318b4]390 <term><filename class="libraryfile">libwebkit2gtk-4.1.so</filename></term>
[1a024c3c]391 <listitem>
392 <para>
[4c24eb0a]393 contains the <application>WebKit2</application> API functions
[1a024c3c]394 </para>
[de4ed8e]395 <indexterm zone="webkitgtk libwebkit2gtk-4">
[c7318b4]396 <primary sortas="c-libwebkit2gtk-4">libwebkit2gtk-4.1.so</primary>
[1a024c3c]397 </indexterm>
398 </listitem>
399 </varlistentry>
400
401 </variablelist>
402
403 </sect2>
404
405</sect1>
Note: See TracBrowser for help on using the repository browser.