source: archive/webkitgtk2.xml

trunk
Last change on this file was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 17 months ago

Remove sect1info tags

They only contain a date tag that is nowhere used.

  • Property mode set to 100644
File size: 12.9 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 webkitgtk2-download-http "http://webkitgtk.org/releases/webkitgtk-&webkitgtk2-version;.tar.xz">
8 <!ENTITY webkitgtk2-download-ftp " ">
9 <!ENTITY webkitgtk2-md5sum "1b3f18d4087dfc648e8060c14e16e202">
10 <!ENTITY webkitgtk2-size "9.4 MB">
11 <!ENTITY webkitgtk2-buildsize "1.5 GB (both built)">
12 <!ENTITY webkitgtk2-time "50 SBU (using parallelism=4, both built, webkitgtk-3.0 takes a little longer than webkitgtk-1.0)">
13]>
14
15<sect1 id="webkitgtk2" xreflabel="WebKitGTK+-&webkitgtk2-version;">
16 <?dbhtml filename="webkitgtk2.html"?>
17
18
19 <title>WebKitGTK+-&webkitgtk2-version;</title>
20
21 <indexterm zone="webkitgtk2">
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> is the port of the portable web
30 rendering engine <application>WebKit</application> to the
31 <application>GTK+ 3</application> and/or <application>GTK+
32 2</application> platforms.
33 </para>
34
35 &lfs79_checked;
36
37 <bridgehead renderas="sect3">Package Information</bridgehead>
38 <itemizedlist spacing="compact">
39 <listitem>
40 <para>
41 Download (HTTP): <ulink url="&webkitgtk2-download-http;"/>
42 </para>
43 </listitem>
44 <listitem>
45 <para>
46 Download (FTP): <ulink url="&webkitgtk2-download-ftp;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download MD5 sum: &webkitgtk2-md5sum;
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download size: &webkitgtk2-size;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Estimated disk space required: &webkitgtk2-buildsize;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated build time: &webkitgtk2-time;
67 </para>
68 </listitem>
69 </itemizedlist>
70
71 <bridgehead renderas="sect3">WebKitGTK+ Dependencies</bridgehead>
72
73 <bridgehead renderas="sect4">Required</bridgehead>
74 <para role="required">
75 <xref linkend="gst10-plugins-base"/>,
76 <xref linkend="gtk2"/> or
77 <xref linkend="gtk3"/>,
78 <xref linkend="icu"/>,
79 <xref linkend="libgudev"/>,
80 <xref linkend="libsecret"/>,
81 <xref linkend="libsoup"/>,
82 <xref linkend="libwebp"/>,
83 <xref linkend="mesa"/>,
84 <xref linkend="ruby"/>,
85 <xref linkend="sqlite"/> and
86 <xref linkend="which"/>
87 </para>
88
89 <note><para>
90 <application>WebKit2</application> links against<application>GTK+
91 2</application> (even if <application>GTK+ 3</application> is being
92 used), in order to be able to use NPAPI plugins such as Adobe Flash.
93 </para></note>
94
95
96 <bridgehead renderas="sect4">Recommended</bridgehead>
97 <para role="recommended">
98 <xref linkend="enchant"/>,
99 <xref linkend="geoclue"/>,
100 <xref linkend="gobject-introspection"/>,
101 <xref linkend="hicolor-icon-theme"/>
102 </para>
103
104 <bridgehead renderas="sect4">Optional</bridgehead>
105 <para role="optional">
106 <xref linkend="gtk-doc"/>,
107 <xref linkend="harfbuzz"/>,
108 <xref linkend="llvm"/>,
109 <ulink url="http://freedesktop.org/wiki/Software/GeoClue/">GeoClue2</ulink>, and
110 <ulink url="http://xsltml.sourceforge.net/">MathML</ulink>
111 </para>
112
113 <para condition="html" role="usernotes">
114 User Notes: <ulink url="&blfs-wiki;/webkitgtk"/>
115 </para>
116 </sect2>
117
118 <sect2 role="installation">
119 <title>Installation of WebKitGTK+</title>
120
121 <para>
122 If you have not installed <xref linkend="gtk-doc"/>, fix a bug that will
123 cause <command>make install</command> to fail:
124 </para>
125
126<screen><userinput>sed -e '/generate-gtkdoc --rebase/s:^:# :' \
127 -i GNUmakefile.in</userinput></screen>
128
129 <para>
130 Upstream standard now is to link this package against <application>GTK+
131 3</application>. However, for backward compatibility, many users need
132 also another instance, linked to <application>GTK+ 2</application>. Both
133 can be installed in the same system, without any problems. However, some
134 packages can alternatively be linked to either one. Here, both build
135 methods are presented and recommended to be built, but if you know which
136 one you need, just jump to the respective part.
137 </para>
138
139<!-- ==== WebKitGTK+ against GTK+ 3 ====== -->
140 <bridgehead renderas="sect3">Build and install
141 <application>WebKitGTK+</application> against <application>GTK+
142 3</application></bridgehead>
143
144 <para>
145 Install <application>WebKitGTK+</application> by running the
146 following commands:
147 </para>
148
149<screen><userinput>mkdir -vp build-3 &amp;&amp;
150cp -a Documentation build-3 &amp;&amp;
151cd build-3 &amp;&amp;
152
153../configure --prefix=/usr --enable-introspection &amp;&amp;
154make</userinput></screen>
155
156 <para>
157 This package does not have a working testsuite. However, there are two
158 useable basic graphical web browsers in the build directory,
159 <application>Programs/GtkLauncher</application> and
160 <application>Programs/MiniBrowser</application>. If launching any one
161 fails, there is a problem with the build.
162 </para>
163
164 <note><para>
165 When installing, the Makefile does some additional compiling and linking.
166 If you do not have Xorg in /usr, the LIBRARY_PATH and PKG_CONFIG_PATH
167 variables need to be defined for the root user. If using sudo to assume
168 root, use the -E option to pass your current environment variables for the
169 install process.
170 </para></note>
171
172 <para>
173 Now, as the <systemitem class="username">root</systemitem> user:
174 </para>
175
176<screen role="root"><userinput>make install</userinput></screen>
177
178 <para>
179 Finally, leave the buid directory:
180 </para>
181
182<screen><userinput>cd ..</userinput></screen>
183
184<!-- ==== WebKitGTK+ against GTK+ 2 ====== -->
185 <bridgehead renderas="sect3">Build and install
186 <application>WebKitGTK+</application> against <application>GTK+
187 2</application></bridgehead>
188
189 <para>
190 Install <application>WebKitGTK+</application> by running the
191 following commands:
192 </para>
193
194<screen><userinput>mkdir -vp build-1</userinput></screen>
195
196 <para>
197 If you have built and installed the package against <application>GTK+
198 3</application>. skip the following command, because the previous
199 docummentation also applies here:
200 </para>
201
202<screen><userinput>cp -a Documentation build-1</userinput></screen>
203
204 <para>
205 Now, change into the build directory and effectively start the build and
206 install:
207 </para>
208
209<screen><userinput>cd build-1 &amp;&amp;
210
211../configure --prefix=/usr \
212 --with-gtk=2.0 \
213 --disable-webkit2 &amp;&amp;
214make</userinput></screen>
215
216 <para>
217 This package does not have a working testsuite. However, there is one
218 useable basic graphical web browser in the build directory,
219 <application>Programs/GtkLauncher</application>. If launching it
220 fails, there is a problem with the build.
221 </para>
222
223 <note><para>
224 When installing, the Makefile does some additional compiling and linking.
225 If you do not have Xorg in /usr, the LIBRARY_PATH and PKG_CONFIG_PATH
226 variables need to be defined for the root user. If using sudo to assume
227 root, use the -E option to pass your current environment variables for the
228 install process.
229 </para></note>
230
231 <para>
232 Now, as the <systemitem class="username">root</systemitem> user:
233 </para>
234
235<screen role="root"><userinput>make install</userinput></screen>
236
237 <para>
238 Finally, leave the buid directory:
239 </para>
240
241<screen><userinput>cd ..</userinput></screen>
242
243 </sect2>
244
245 <sect2 role="commands">
246 <title>Command Explanations</title>
247
248 <para>
249 <option>--enable-introspection</option>: This switch enables support for
250 <application>Gobject Introspection</application> and is required for a
251 <application>GNOME</application> Desktop. Remove if you don't have
252 <application>Gobject Introspection</application> installed or you don't
253 want to install <application>GNOME</application>.
254 </para>
255
256 <para>
257 <option>--disable-geolocation</option>: Use this option if you did not
258 install <xref linkend="geoclue"/> or <command>configure</command> will
259 fail.
260 </para>
261
262 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
263 href="../../xincludes/gtk-doc-rebuild.xml"/>
264
265 </sect2>
266
267 <sect2 role="content">
268 <title>Contents</title>
269
270 <segmentedlist>
271 <segtitle>Installed Programs</segtitle>
272 <segtitle>Installed Libraries</segtitle>
273 <segtitle>Installed Directories</segtitle>
274
275 <seglistitem>
276 <seg>
277 jsc-1 and jsc-3
278 </seg>
279 <seg>
280 libjavascriptcoregtk-{1,3}.0.so,
281 libwebkit2gtk-3.0.so, and
282 libwebkitgtk-{1,3}.0.so
283 </seg>
284 <seg>
285 /usr/include/webkitgtk-{1,3}.0,
286 /usr/lib/webkit2gtk-3.0,
287 /usr/share/gtk-doc/html/webkit{2,dom,}gtk, and
288 /usr/share/webkitgtk-{1,3}.0
289 </seg>
290 </seglistitem>
291 </segmentedlist>
292
293 <variablelist>
294 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
295 <?dbfo list-presentation="list"?>
296 <?dbhtml list-presentation="table"?>
297
298 <varlistentry id="jsc-1">
299 <term><command>jsc-1</command></term>
300 <listitem>
301 <para>
302 is a command-line utility that allows you to run JavaScript programs
303 outside of the context of a web browser.
304 </para>
305 <indexterm zone="webkitgtk2 jsc-1">
306 <primary sortas="b-jsc-1">jsc-1</primary>
307 </indexterm>
308 </listitem>
309 </varlistentry>
310
311 <varlistentry id="jsc-3">
312 <term><command>jsc-3</command></term>
313 <listitem>
314 <para>
315 is a command-line utility that allows you to run JavaScript programs
316 outside of the context of a web browser.
317 </para>
318 <indexterm zone="webkitgtk2 jsc-3">
319 <primary sortas="b-jsc-3">jsc-3</primary>
320 </indexterm>
321 </listitem>
322 </varlistentry>
323
324 <varlistentry id="libjavascriptcoregtk-1">
325 <term><filename
326 class="libraryfile">libjavascriptcoregtk-1.0.so</filename></term>
327 <listitem>
328 <para>
329 contains core JavaScript API functions used by
330 <command>jsc-1</command> and <filename
331 class="libraryfile">libwebkitgtk-1.0.so</filename>.
332 </para>
333 <indexterm zone="webkitgtk2 libjavascriptcoregtk-1">
334 <primary sortas="c-libjavascriptcoregtk-1">libjavascriptcoregtk-1.0.so</primary>
335 </indexterm>
336 </listitem>
337 </varlistentry>
338
339 <varlistentry id="libjavascriptcoregtk-3">
340 <term><filename
341 class="libraryfile">libjavascriptcoregtk-3.0.so</filename></term>
342 <listitem>
343 <para>
344 contains core JavaScript API functions used by
345 <command>jsc-3</command> and <filename
346 class="libraryfile">libwebkitgtk-3.0.so</filename>.
347 </para>
348 <indexterm zone="webkitgtk2 libjavascriptcoregtk-3">
349 <primary sortas="c-libjavascriptcoregtk-3">libjavascriptcoregtk-3.0.so</primary>
350 </indexterm>
351 </listitem>
352 </varlistentry>
353
354 <varlistentry id="libwebkitgtk-1">
355 <term><filename class="libraryfile">libwebkitgtk-1.0.so</filename></term>
356 <listitem>
357 <para>
358 contains the <application>WebKitGTK+</application> API functions for
359 <application>GTK+ 2</application>.
360 </para>
361 <indexterm zone="webkitgtk2 libwebkitgtk-1">
362 <primary sortas="c-libwebkitgtk-1">libwebkitgtk-1.0.so</primary>
363 </indexterm>
364 </listitem>
365 </varlistentry>
366
367 <varlistentry id="libwebkitgtk-3">
368 <term><filename class="libraryfile">libwebkitgtk-3.0.so</filename></term>
369 <listitem>
370 <para>
371 contains the <application>WebKitGTK+</application> API functions for
372 <application>GTK+ 3</application>.
373 </para>
374 <indexterm zone="webkitgtk2 libwebkitgtk-3">
375 <primary sortas="c-libwebkitgtk-3">libwebkitgtk-3.0.so</primary>
376 </indexterm>
377 </listitem>
378 </varlistentry>
379
380 <varlistentry id="libwebkit2gtk-3">
381 <term><filename class="libraryfile">libwebkit2gtk-3.0.so</filename></term>
382 <listitem>
383 <para>
384 contains the <application>WebKit2</application> API functions.
385 </para>
386 <indexterm zone="webkitgtk2 libwebkit2gtk-3">
387 <primary sortas="c-libwebkit2gtk-3">libwebkit2gtk-3.0.so</primary>
388 </indexterm>
389 </listitem>
390 </varlistentry>
391
392 </variablelist>
393
394 </sect2>
395
396</sect1>
Note: See TracBrowser for help on using the repository browser.