source: x/lib/webkitgtk.xml@ e90881c

11.1 11.2 11.3 12.0 12.1 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 upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since e90881c was e90881c, checked in by Pierre Labastie <pierre.labastie@…>, 3 years ago

webkitgtk: add libavif as optional dep and remove mathml

AVIF had been introduced in March 2021, and mathml is included
natively.
  • Property mode set to 100644
File size: 12.8 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 "32334fddc48e3428044bbd9215d0636f">
10 <!ENTITY webkitgtk-size "24 MB">
11 <!ENTITY webkitgtk-buildsize "934 MB (127 MB installed)">
12 <!ENTITY webkitgtk-time "30 SBU (using parallelism=4, estimated 107 SBU using one core)">
13]>
14
15<sect1 id="webkitgtk" xreflabel="WebKitGTK-&webkitgtk-version;">
16 <?dbhtml filename="webkitgtk.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
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+ 2</application>
35 platforms.
36 </para>
37
38 &lfs110a_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;-icu_69-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="icu"/>,
96 <xref linkend="libgudev"/>,
97 <xref linkend="libsecret"/>,
98 <xref linkend="libsoup"/>,
99 <xref linkend="libtasn1"/>,
100 <xref linkend="libwebp"/>,
101 <xref linkend="mesa"/>,
102 <xref linkend="openjpeg2"/>,
103 <xref linkend="ruby"/>,
104 <xref linkend="sqlite"/>,
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="libnotify"/>
116 </para>
117
118 <bridgehead renderas="sect4">Optional</bridgehead>
119 <para role="optional">
120 <xref linkend="bubblewrap"/>,
121 <xref linkend="gtk-doc"/>,
122 <xref linkend="gtk4"/>,
123 <xref linkend="harfbuzz"/>,
124 <xref linkend="wayland"/>,
125 <xref linkend="woff2"/>,
126 <ulink url="https://ccache.dev/">ccache</ulink>,
127 <ulink url="https://sourceforge.net/projects/hunspell/files/Hyphen/">Hyphen</ulink>,
128 <ulink url="https://github.com/AOMediaCodec/libavif">libavif</ulink>,
129 <ulink url="https://gnome.pages.gitlab.gnome.org/libmanette/">libmanette</ulink>, and
130 <ulink url="https://github.com/flatpak/xdg-dbus-proxy">xdg-dbus-proxy</ulink>
131 </para>
132
133 <para condition="html" role="usernotes">
134 User Notes: <ulink url="&blfs-wiki;/webkitgtk"/>
135 </para>
136 </sect2>
137
138 <sect2 role="installation">
139 <title>Installation of WebKitGTK</title>
140
141 <bridgehead renderas="sect3">Installation of
142 <application>WebKitGTK</application></bridgehead>
143
144 <para>
145 Install <application>WebKitGTK</application> by running the
146 following commands:
147 </para>
148
149<screen revision="systemd"><userinput>mkdir -vp build &amp;&amp;
150cd build &amp;&amp;
151
152cmake -DCMAKE_BUILD_TYPE=Release \
153 -DCMAKE_INSTALL_PREFIX=/usr \
154 -DCMAKE_SKIP_RPATH=ON \
155 -DPORT=GTK \
156 -DLIB_INSTALL_DIR=/usr/lib \
157 -DUSE_LIBHYPHEN=OFF \
158 -DENABLE_GAMEPAD=OFF \
159 -DENABLE_MINIBROWSER=ON \
160 -DUSE_WOFF2=OFF \
161 -DUSE_SOUP2=ON \
162 -DUSE_WPE_RENDERER=ON \
163 -DENABLE_BUBBLEWRAP_SANDBOX=OFF \
164 -Wno-dev -G Ninja .. &amp;&amp;
165ninja</userinput></screen>
166
167<screen revision="sysv"><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 -DUSE_WOFF2=OFF \
179 -DUSE_SOUP2=ON \
180 -DUSE_WPE_RENDERER=ON \
181 -DUSE_SYSTEMD=OFF \
182 -DENABLE_BUBBLEWRAP_SANDBOX=OFF \
183 -Wno-dev -G Ninja .. &amp;&amp;
184ninja</userinput></screen>
185
186 <para>
187 This package does not have a working testsuite. However, there is a
188 usable basic graphical web browser in the build directory,
189 <application>build/bin/MiniBrowser</application>. If launching it fails,
190 there is a problem with the build.
191 </para>
192
193 <note><para>
194 When installing, the Makefile does some additional compiling and linking.
195 If you do not have Xorg in /usr, the LIBRARY_PATH and PKG_CONFIG_PATH
196 variables need to be defined for the root user. If using sudo to assume
197 root, use the -E option to pass your current environment variables for the
198 install process.
199 </para></note>
200
201 <para>
202 Now, as the <systemitem class="username">root</systemitem> user:
203 </para>
204
205<screen role="root"><userinput>ninja install &amp;&amp;
206
207install -vdm755 /usr/share/gtk-doc/html/webkit{2,dom}gtk-4.0 &amp;&amp;
208install -vm644 ../Documentation/webkit2gtk-4.0/html/* \
209 /usr/share/gtk-doc/html/webkit2gtk-4.0 &amp;&amp;
210install -vm644 ../Documentation/webkitdomgtk-4.0/html/* \
211 /usr/share/gtk-doc/html/webkitdomgtk-4.0</userinput></screen>
212 </sect2>
213
214 <sect2 role="commands">
215 <title>Command Explanations</title>
216
217<!-- <para>
218 <command>sed ... TextCheckerEnchant.cpp</command>: This command
219 is needed to allow the build to complete with enchant-2.x.
220 </para> -->
221
222 <para>
223 <parameter>-DUSE_LIBHYPHEN=OFF</parameter>: This switch disables
224 default automatic hyphenation implementation. You need to install
225 <ulink
226 url="https://sourceforge.net/projects/hunspell/files/Hyphen/">Hyphen</ulink>,
227 if you wish to enable it (replacing OFF with ON or just removing
228 the switch).
229 </para>
230
231 <para>
232 <parameter>-DENABLE_GAMEPAD=OFF</parameter>: This switch disables
233 gamepad support. Remove this switch if you have
234 <ulink url="https://gnome.pages.gitlab.gnome.org/libmanette/">libmanette</ulink>
235 installed and wish to enable it.
236 </para>
237
238 <para>
239 <parameter>-DENABLE_MINIBROWSER=ON</parameter>: This switch enables
240 compiling and installing the MiniBrowser.
241 </para>
242
243 <para>
244 <parameter>-DUSE_WPE_RENDERER=ON</parameter>: This switch uses the WPE
245 renderer, which is recommended by upstream.
246 </para>
247
248 <para>
249 <parameter>-DENABLE_BUBBLEWRAP_SANDBOX=OFF</parameter>: Remove this
250 switch if the optional packages <xref linkend="bubblewrap"/> and
251 <ulink url="https://github.com/flatpak/xdg-dbus-proxy">xdg-dbus-proxy</ulink>
252 are installed.
253 </para>
254
255 <para revision="sysv">
256 <parameter>-DUSE_SYSTEMD=OFF</parameter>: This switch disables using the
257 systemd journal for logging errors and debugging information since it
258 is not available on SysV systems.
259 </para>
260
261 <para>
262 <option>-DUSE_LIBNOTIFY=OFF</option>: Use this switch if you do not
263 have <application>libnotify</application> installed.
264 </para>
265
266 <para>
267 <option>-DUSE_SYSTEM_MALLOC=ON</option>: This switch enables building
268 against the system installed <application>malloc</application>.
269 </para>
270
271 <para>
272 <option>-DENABLE_GEOLOCATION=OFF</option>: Use this switch if you don't
273 want to install <xref linkend="geoclue2"/>.
274 </para>
275
276 <para>
277 <option>-DENABLE_GTKDOC=ON</option>: Use this switch if <xref
278 linkend="gtk-doc"/> is installed and you wish to rebuild and install the
279 API documentation.
280 </para>
281
282 <para>
283 <option>-DUSE_WOFF2=ON</option>: Use this switch if the optional
284 package <xref linkend="woff2"/> is installed. This adds additional
285 support for fonts.
286 </para>
287
288 <!-- Uncomment once GTK4 support works, or when it doesn't require
289 a development version of libsoup.
290 <para>
291 <option>-DUSE_GTK4=ON</option>: Use this switch if <xref linkend="gtk4"/>
292 is installed and you wish to build GTK4 support.
293 </para>
294 -->
295
296 </sect2>
297
298 <sect2 role="content">
299 <title>Contents</title>
300
301 <segmentedlist>
302 <segtitle>Installed Program</segtitle>
303 <segtitle>Installed Libraries</segtitle>
304 <segtitle>Installed Directories</segtitle>
305
306 <seglistitem>
307 <seg>
308<!-- Moved to /usr/libexec/webkit2gtk-4.0, so shouldn't appear here
309 jsc,
310 MiniBrowser, and -->
311 WebKitWebDriver
312 </seg>
313 <seg>
314 libjavascriptcoregtk-4.0.so and
315 libwebkit2gtk-4.0.so
316 </seg>
317 <seg>
318 /usr/include/webkitgtk-4.0,
319 /usr/lib{,exec}/webkit2gtk-4.0, and
320 /usr/share/gtk-doc/html/webkit{2,dom}gtk-4.0
321 </seg>
322 </seglistitem>
323 </segmentedlist>
324
325 <variablelist>
326 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
327 <?dbfo list-presentation="list"?>
328 <?dbhtml list-presentation="table"?>
329
330<!--
331 <varlistentry id="jsc">
332 <term><command>jsc</command></term>
333 <listitem>
334 <para>
335 is a command-line utility that allows you to run JavaScript programs
336 outside of the context of a web browser.
337 </para>
338 <indexterm zone="webkitgtk jsc">
339 <primary sortas="b-jsc">jsc</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="MiniBrowser">
345 <term><command>MiniBrowser</command></term>
346 <listitem>
347 <para>
348 is a very simple graphical browser.
349 </para>
350 <indexterm zone="webkitgtk MiniBrowser">
351 <primary sortas="b-MiniBrowser">MiniBrowser</primary>
352 </indexterm>
353 </listitem>
354 </varlistentry>
355-->
356 <varlistentry id="WebKitWebDriver">
357 <term><command>WebKitWebDriver</command></term>
358 <listitem>
359 <para>
360 allows debugging and automation of web pages and browsers
361 </para>
362 <indexterm zone="webkitgtk WebKitWebDriver">
363 <primary sortas="b-WebKitWebDriver">WebKitWebDriver</primary>
364 </indexterm>
365 </listitem>
366 </varlistentry>
367
368 <varlistentry id="libjavascriptcoregtk-4.0">
369 <term>
370 <filename class="libraryfile">libjavascriptcoregtk-4.0.so</filename>
371 </term>
372 <listitem>
373 <para>
374 contains core JavaScript API functions used by
375 <command>jsc</command> and
376 <filename class="libraryfile">libwebkit2gtk-4.0</filename>
377 </para>
378 <indexterm zone="webkitgtk libjavascriptcoregtk-4.0">
379 <primary sortas="c-libjavascriptcoregtk-4.0">libjavascriptcoregtk-4.0.0.so</primary>
380 </indexterm>
381 </listitem>
382 </varlistentry>
383
384 <varlistentry id="libwebkit2gtk-4">
385 <term><filename class="libraryfile">libwebkit2gtk-4.0.so</filename></term>
386 <listitem>
387 <para>
388 contains the <application>WebKit2</application> API functions
389 </para>
390 <indexterm zone="webkitgtk libwebkit2gtk-4">
391 <primary sortas="c-libwebkit2gtk-4">libwebkit2gtk-4.0.so</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395
396 </variablelist>
397
398 </sect2>
399
400</sect1>
Note: See TracBrowser for help on using the repository browser.