source: x/lib/webkitgtk.xml@ d28f324

11.0 11.1 11.2 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since d28f324 was d28f324, checked in by Douglas R. Reno <renodr@…>, 16 months ago

Package update
Update to WebKitGTK+-2.32.3

  • Property mode set to 100644
File size: 12.7 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 "f31b802de421865ea9f1391ec8190519">
10 <!ENTITY webkitgtk-size "22 MB">
11 <!ENTITY webkitgtk-buildsize "909 MB (127 MB installed)">
12 <!ENTITY webkitgtk-time "29 SBU (using parallelism=4, estimated 97 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 &lfs101_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="http://xsltml.sourceforge.net/">MathML</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_WPE_RENDERER=ON \
162 -DENABLE_BUBBLEWRAP_SANDBOX=OFF \
163 -Wno-dev -G Ninja .. &amp;&amp;
164ninja</userinput></screen>
165
166<screen revision="sysv"><userinput>mkdir -vp build &amp;&amp;
167cd build &amp;&amp;
168
169cmake -DCMAKE_BUILD_TYPE=Release \
170 -DCMAKE_INSTALL_PREFIX=/usr \
171 -DCMAKE_SKIP_RPATH=ON \
172 -DPORT=GTK \
173 -DLIB_INSTALL_DIR=/usr/lib \
174 -DUSE_LIBHYPHEN=OFF \
175 -DENABLE_GAMEPAD=OFF \
176 -DENABLE_MINIBROWSER=ON \
177 -DUSE_WOFF2=OFF \
178 -DUSE_WPE_RENDERER=ON \
179 -DUSE_SYSTEMD=OFF \
180 -DENABLE_BUBBLEWRAP_SANDBOX=OFF \
181 -Wno-dev -G Ninja .. &amp;&amp;
182ninja</userinput></screen>
183
184 <para>
185 This package does not have a working testsuite. However, there is a
186 usable basic graphical web browser in the build directory,
187 <application>build/bin/MiniBrowser</application>. If launching it fails,
188 there is a problem with the build.
189 </para>
190
191 <note><para>
192 When installing, the Makefile does some additional compiling and linking.
193 If you do not have Xorg in /usr, the LIBRARY_PATH and PKG_CONFIG_PATH
194 variables need to be defined for the root user. If using sudo to assume
195 root, use the -E option to pass your current environment variables for the
196 install process.
197 </para></note>
198
199 <para>
200 Now, as the <systemitem class="username">root</systemitem> user:
201 </para>
202
203<screen role="root"><userinput>ninja install &amp;&amp;
204
205install -vdm755 /usr/share/gtk-doc/html/webkit{2,dom}gtk-4.0 &amp;&amp;
206install -vm644 ../Documentation/webkit2gtk-4.0/html/* \
207 /usr/share/gtk-doc/html/webkit2gtk-4.0 &amp;&amp;
208install -vm644 ../Documentation/webkitdomgtk-4.0/html/* \
209 /usr/share/gtk-doc/html/webkitdomgtk-4.0</userinput></screen>
210 </sect2>
211
212 <sect2 role="commands">
213 <title>Command Explanations</title>
214
215<!-- <para>
216 <command>sed ... TextCheckerEnchant.cpp</command>: This command
217 is needed to allow the build to complete with enchant-2.x.
218 </para> -->
219
220 <para>
221 <parameter>-DUSE_LIBHYPHEN=OFF</parameter>: This switch disables
222 default automatic hyphenation implementation. You need to install
223 <ulink
224 url="https://sourceforge.net/projects/hunspell/files/Hyphen/">Hyphen</ulink>,
225 if you wish to enable it (replacing OFF with ON or just removing
226 the switch).
227 </para>
228
229 <para>
230 <parameter>-DENABLE_GAMEPAD=OFF</parameter>: This switch disables
231 gamepad support. Remove this switch if you have
232 <ulink url="https://gnome.pages.gitlab.gnome.org/libmanette/">libmanette</ulink>
233 installed and wish to enable it.
234 </para>
235
236 <para>
237 <parameter>-DENABLE_MINIBROWSER=ON</parameter>: This switch enables
238 compiling and installing the MiniBrowser.
239 </para>
240
241 <para>
242 <parameter>-DUSE_WPE_RENDERER=ON</parameter>: This switch uses the WPE
243 renderer, which is recommended by upstream.
244 </para>
245
246 <para>
247 <parameter>-DENABLE_BUBBLEWRAP_SANDBOX=OFF</parameter>: Remove this
248 switch if the optional packages <xref linkend="bubblewrap"/> and
249 <ulink url="https://github.com/flatpak/xdg-dbus-proxy">xdg-dbus-proxy</ulink>
250 are installed.
251 </para>
252
253 <para revision="sysv">
254 <parameter>-DUSE_SYSTEMD=OFF</parameter>: This switch disables using the
255 systemd journal for logging errors and debugging information since it
256 is not available on SysV systems.
257 </para>
258
259 <para>
260 <option>-DUSE_LIBNOTIFY=OFF</option>: Use this switch if you do not
261 have <application>libnotify</application> installed.
262 </para>
263
264 <para>
265 <option>-DUSE_SYSTEM_MALLOC=ON</option>: This switch enables building
266 against the system installed <application>malloc</application>.
267 </para>
268
269 <para>
270 <option>-DENABLE_GEOLOCATION=OFF</option>: Use this switch if you don't
271 want to install <xref linkend="geoclue2"/>.
272 </para>
273
274 <para>
275 <option>-DENABLE_GTKDOC=ON</option>: Use this switch if <xref
276 linkend="gtk-doc"/> is installed and you wish to rebuild and install the
277 API documentation.
278 </para>
279
280 <para>
281 <option>-DUSE_WOFF2=ON</option>: Use this switch if the optional
282 package <xref linkend="woff2"/> is installed. This adds additional
283 support for fonts.
284 </para>
285
286 <!-- Uncomment once GTK4 support works, or when it doesn't require
287 a development version of libsoup.
288 <para>
289 <option>-DUSE_GTK4=ON</option>: Use this switch if <xref linkend="gtk4"/>
290 is installed and you wish to build GTK4 support.
291 </para>
292 -->
293
294 </sect2>
295
296 <sect2 role="content">
297 <title>Contents</title>
298
299 <segmentedlist>
300 <segtitle>Installed Program</segtitle>
301 <segtitle>Installed Libraries</segtitle>
302 <segtitle>Installed Directories</segtitle>
303
304 <seglistitem>
305 <seg>
306<!-- Moved to /usr/libexec/webkit2gtk-4.0, so shouldn't appear here
307 jsc,
308 MiniBrowser, and -->
309 WebKitWebDriver
310 </seg>
311 <seg>
312 libjavascriptcoregtk-4.0.so and
313 libwebkit2gtk-4.0.so
314 </seg>
315 <seg>
316 /usr/include/webkitgtk-4.0,
317 /usr/lib{,exec}/webkit2gtk-4.0, and
318 /usr/share/gtk-doc/html/webkit{2,dom}gtk-4.0
319 </seg>
320 </seglistitem>
321 </segmentedlist>
322
323 <variablelist>
324 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
325 <?dbfo list-presentation="list"?>
326 <?dbhtml list-presentation="table"?>
327
328<!--
329 <varlistentry id="jsc">
330 <term><command>jsc</command></term>
331 <listitem>
332 <para>
333 is a command-line utility that allows you to run JavaScript programs
334 outside of the context of a web browser.
335 </para>
336 <indexterm zone="webkitgtk jsc">
337 <primary sortas="b-jsc">jsc</primary>
338 </indexterm>
339 </listitem>
340 </varlistentry>
341
342 <varlistentry id="MiniBrowser">
343 <term><command>MiniBrowser</command></term>
344 <listitem>
345 <para>
346 is a very simple graphical browser.
347 </para>
348 <indexterm zone="webkitgtk MiniBrowser">
349 <primary sortas="b-MiniBrowser">MiniBrowser</primary>
350 </indexterm>
351 </listitem>
352 </varlistentry>
353-->
354 <varlistentry id="WebKitWebDriver">
355 <term><command>WebKitWebDriver</command></term>
356 <listitem>
357 <para>
358 allows debugging and automation of web pages and browsers
359 </para>
360 <indexterm zone="webkitgtk WebKitWebDriver">
361 <primary sortas="b-WebKitWebDriver">WebKitWebDriver</primary>
362 </indexterm>
363 </listitem>
364 </varlistentry>
365
366 <varlistentry id="libjavascriptcoregtk-4.0">
367 <term>
368 <filename class="libraryfile">libjavascriptcoregtk-4.0.so</filename>
369 </term>
370 <listitem>
371 <para>
372 contains core JavaScript API functions used by
373 <command>jsc</command> and
374 <filename class="libraryfile">libwebkit2gtk-4.0</filename>
375 </para>
376 <indexterm zone="webkitgtk libjavascriptcoregtk-4.0">
377 <primary sortas="c-libjavascriptcoregtk-4.0">libjavascriptcoregtk-4.0.0.so</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="libwebkit2gtk-4">
383 <term><filename class="libraryfile">libwebkit2gtk-4.0.so</filename></term>
384 <listitem>
385 <para>
386 contains the <application>WebKit2</application> API functions
387 </para>
388 <indexterm zone="webkitgtk libwebkit2gtk-4">
389 <primary sortas="c-libwebkit2gtk-4">libwebkit2gtk-4.0.so</primary>
390 </indexterm>
391 </listitem>
392 </varlistentry>
393
394 </variablelist>
395
396 </sect2>
397
398</sect1>
Note: See TracBrowser for help on using the repository browser.