source: archive/xulrunner.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: 13.3 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 xulrunner-download-http
8 "http://releases.mozilla.org/pub/mozilla.org/firefox/releases/&firefox-version;/source/firefox-&firefox-version;.source.tar.bz2">-->
9 <!ENTITY xulrunner-download-http
10 "http:///ftp.mozilla.org/pub/mozilla.org/firefox/releases/&firefox-version;/source/firefox-&firefox-version;.source.tar.bz2">
11 <!ENTITY xulrunner-download-ftp
12 "ftp://ftp.mozilla.org/pub/mozilla.org/firefox/releases/&firefox-version;/source/firefox-&firefox-version;.source.tar.bz2">
13 <!ENTITY xulrunner-md5sum "499b70a9f08a2291d528e87eaf8804a3">
14 <!ENTITY xulrunner-size "141 MB">
15 <!-- measured on LFS-7.5 x86_64 -->
16 <!ENTITY xulrunner-buildsize "4.9 GB (103 MB installed)">
17 <!ENTITY xulrunner-time "46 SBU">
18]>
19
20<sect1 id="xulrunner" xreflabel="Xulrunner-&xulrunner-version;">
21 <?dbhtml filename="xulrunner.html" ?>
22
23
24 <title>Xulrunner-&xulrunner-version;</title>
25
26 <indexterm zone="xulrunner">
27 <primary sortas="a-Xulrunner">Xulrunner</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to Xulrunner</title>
32
33 <para>
34 <application>Xulrunner</application> is a runtime environment for XUL
35 applications, and forms the major part of the
36 <application>Mozilla</application> codebase. In particular, it provides
37 the Gecko engine together with pkgconfig files so that other applications
38 can find and use it.
39 </para>
40
41 &lfs75_checked;
42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>
47 Download (HTTP): <ulink url="&xulrunner-download-http;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download (FTP): <ulink url="&xulrunner-download-ftp;"/>
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download MD5 sum: &xulrunner-md5sum;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Download size: &xulrunner-size;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated disk space required: &xulrunner-buildsize;
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Estimated build time: &xulrunner-time;
73 </para>
74 </listitem>
75 </itemizedlist>
76
77 <bridgehead renderas="sect3">Xulrunner Dependencies</bridgehead>
78
79 <bridgehead renderas="sect4">Required</bridgehead>
80 <para role="required">
81 <xref linkend="alsa-lib"/>,
82 <xref linkend="gtk2"/>,
83 <xref linkend="zip"/> and
84 <xref linkend="unzip"/>
85 </para>
86
87 <bridgehead renderas="sect4">Recommended</bridgehead>
88 <para role="recommended">
89 <xref linkend="icu"/>,
90 <xref linkend="libevent"/>,
91 <xref linkend="libvpx"/>,
92 <xref linkend="nspr"/>,
93 <xref linkend="nss"/>,
94 <xref linkend="sqlite"/> and
95 <xref linkend="yasm"/>
96 </para>
97
98 <note>
99 <para>
100 If you don't install recommended dependencies,
101 then internal copies of those packages will
102 be used. They might be tested to work, but
103 they can be out of date or contain security
104 holes.
105 </para>
106 </note>
107
108 <note>
109 <para>
110 With <application>Firefox-31.0</application> and later versions, you
111 must have installed <application>Openssl</application> before
112 <application>Python 2</application>, or the build system will quickly
113 fail with output including "ImportError: cannot import name
114 HTTPSHandler". If you are in any doubt about this (e.g. upgrading
115 from an older version of Xulrunner), check if
116 <filename>/usr/lib/python2.7/lib-dynload/_ssl.so</filename> exists.
117 If it does not, reinstall <xref linkend="python2"/> (after
118 installing <xref linkend="openssl"/> - the latest version of any
119 <emphasis>currently maintained</emphasis> version of Openssl should
120 be satisfactory if already installed - if that package has not already
121 been installed).
122 </para>
123 </note>
124
125 <bridgehead renderas="sect4">Optional</bridgehead>
126 <para role="optional">
127 <xref linkend="curl"/>,
128 <xref linkend="dbus-glib"/>,
129 <xref linkend="doxygen"/>,
130 <xref linkend="gst-plugins-base"/> (with
131 <xref linkend="gst-plugins-good"/> and
132 <xref linkend="gst-ffmpeg"/> at runtime), or
133 <xref linkend="gst10-plugins-base"/> (with
134 <xref linkend="gst10-plugins-good"/> and
135 <xref linkend="gst10-libav"/> at runtime),
136 <ulink url="http://hunspell.sourceforge.net/">Hunspell</ulink>,
137 <xref linkend="libnotify"/>,
138 <xref linkend="openjdk"/>,
139 <xref linkend="pulseaudio"/>,
140 <xref linkend="startup-notification"/>,
141 <xref linkend="wget"/> and
142 <xref linkend="wireless_tools"/>
143 </para>
144
145 <para condition="html" role="usernotes">
146 User Notes: <ulink url="&blfs-wiki;/xulrunner"/>
147 </para>
148 </sect2>
149
150 <sect2 role="installation">
151 <title>Installation of Xulrunner</title>
152
153 <para>
154 The configuration of <application>Xulrunner</application> is accomplished
155 by creating a <filename>mozconfig</filename> file containing the desired
156 configuration options. A default <filename>mozconfig</filename> is created
157 below. To see the entire list of available configuration options (and an
158 abbreviated description of each one), issue <command>./configure
159 --help</command>. You should review the entire file and comment or
160 uncomment options as necessary.
161 </para>
162
163<screen><userinput>cat &gt; mozconfig &lt;&lt; "EOF"
164# If you have a multicore machine, firefox will now use all the cores by
165# default. Exceptionally, you can reduce the number of cores, e.g. to 1,
166# by uncommenting the next line and setting a valid number of CPU cores.
167#mk_add_options MOZ_MAKE_FLAGS="-j1"
168
169# If you have installed DBus-Glib comment out this line:
170ac_add_options --disable-dbus
171
172# If you have installed dbus-glib, and you have installed (or will install)
173# wireless-tools, and you wish to use geolocation web services, comment out
174# this line
175ac_add_options --disable-necko-wifi
176
177# If you have installed libnotify comment out this line:
178ac_add_options --disable-libnotify
179
180# GStreamer is necessary for H.264 video playback in HTML5 Video Player;
181# to be enabled, also remember to set "media.gstreamer.enabled" to "true"
182# in about:config. If you have GStreamer 0.x.y, uncomment this line:
183#ac_add_options --enable-gstreamer
184# or uncomment this line, if you have GStreamer 1.x.y
185#ac_add_options --enable-gstreamer=1.0
186
187# Uncomment these lines if you have installed optional dependencies:
188#ac_add_options --enable-system-hunspell
189#ac_add_options --enable-startup-notification
190
191# Comment out following option if you have PulseAudio installed
192ac_add_options --disable-pulseaudio
193
194# If you have not installed Yasm then uncomment this line:
195#ac_add_options --disable-webm
196
197# Comment out following options if you have not installed
198# recommended dependencies:
199ac_add_options --enable-system-sqlite
200ac_add_options --with-system-libevent
201ac_add_options --with-system-libvpx
202ac_add_options --with-system-nspr
203ac_add_options --with-system-nss
204ac_add_options --with-system-icu
205
206# The BLFS editors recommend not changing anything below this line:
207ac_add_options --prefix=/usr
208ac_add_options --enable-application=xulrunner
209
210ac_add_options --disable-crashreporter
211ac_add_options --disable-updater
212ac_add_options --disable-tests
213
214ac_add_options --enable-optimize
215ac_add_options --enable-strip
216ac_add_options --enable-install-strip
217
218ac_add_options --enable-system-cairo
219ac_add_options --enable-system-ffi
220ac_add_options --enable-system-pixman
221
222ac_add_options --enable-shared-js
223ac_add_options --with-pthreads
224
225ac_add_options --with-system-bz2
226ac_add_options --with-system-jpeg
227ac_add_options --with-system-png
228ac_add_options --with-system-zlib
229
230mk_add_options MOZ_OBJDIR=@TOPSRCDIR@/xulrunner-build-dir
231EOF</userinput></screen>
232
233 <note>
234 <para>
235 <application>Xulrunner</application>'s build uses large amount of
236 memory. On some systems, the RAM/Swap combination needs 6 GB available.
237 </para>
238 </note>
239
240 <para>
241 Build <application>Xulrunner</application> by issuing the following
242 commands:
243 </para>
244
245 <note><para>
246 If you are compiling <application>Xulrunner</application> in chroot,
247 prepend <envar>SHELL=/bin/bash</envar> to the first make command below.
248 </para></note>
249
250<screen><userinput>sed -i '/^template class/s/JS::WeakMapPtr/JS_PUBLIC_API(&amp;)/' \
251 js/src/vm/WeakMapPtr.cpp &amp;&amp;
252make -f client.mk</userinput></screen>
253
254 <para>
255 This package does not come with a test suite.
256 </para>
257
258 <para>
259 Install, as the <systemitem class="username">root</systemitem> user:
260 </para>
261
262<screen role="root"><userinput>make -C xulrunner-build-dir install &amp;&amp;
263
264mkdir -pv /usr/lib/mozilla/plugins &amp;&amp;
265rm -rf /usr/lib/xulrunner-&xulrunner-version;/plugins &amp;&amp;
266ln -sv ../mozilla/plugins /usr/lib/xulrunner-&xulrunner-version; &amp;&amp;
267
268chmod -v 755 /usr/lib/xulrunner-devel-&xulrunner-version;/sdk/bin/xpcshell &amp;&amp;
269
270for library in libmozalloc.so libmozjs.so libxul.so; do
271 ln -sfv ../../../xulrunner-&xulrunner-version;/$library \
272 /usr/lib/xulrunner-devel-&xulrunner-version;/sdk/lib/$library
273 ln -sfv xulrunner-&xulrunner-version;/$library /usr/lib/$library
274done
275
276ln -sfv ../xulrunner-devel-&xulrunner-version;/sdk/bin/run-mozilla.sh \
277 /usr/lib/xulrunner-&xulrunner-version;
278ln -sfv ../xulrunner-devel-&xulrunner-version;/sdk/bin/xpcshell \
279 /usr/lib/xulrunner-&xulrunner-version;</userinput></screen>
280
281 </sect2>
282
283 <sect2 role="commands">
284 <title>Command Explanations</title>
285
286 <para>
287 <command>sed -i ... js/src/vm/WeakMapPtr.cpp</command>: Fixes build with
288 <command>ac_add_options --enable-shared-js</command>.
289 </para>
290
291 <para>
292 <command>make -f client.mk ...</command>: Mozilla products are packaged to
293 allow the use of a configuration file which can be used to pass the
294 configuration settings to the <command>configure</command> command.
295 <command>make</command> uses the <filename>client.mk</filename> file to
296 get initial configuration and setup parameters.
297 </para>
298
299 <para>
300 <command>ln -sfv ../mozilla/plugins ...</command>: Some packages will
301 install browser plugins into
302 <filename class="directory">/usr/lib/mozilla/plugins</filename>.
303 Creating this symlink <application>Xulrunner</application> keeps
304 additional plugins in a common directory.
305 </para>
306
307 <para>
308 <command>for library in libmozalloc.so libmozjs.so libxul.so ...
309 </command>: The libraries shipped with this package are installed into
310 <filename class="directory">/usr/lib/xulrunner-&xulrunner-version;</filename>
311 which means they will not be found at runtime. These commands make
312 relative symbolic links to the shared libraries from
313 <filename class="directory">/usr/lib</filename>. They will also replace duplicate
314 libraries that are installed in
315 <filename class="directory">/usr/lib/xulrunner-devel-&xulrunner-version;/sdk/lib</filename>
316 with symlinks in order to save some space.
317 </para>
318
319 <para>
320 <command>ln -sfv ../xulrunner-devel-&xulrunner-version;/sdk/bin/ ...</command>
321 The <filename>run-mozilla.sh</filename> and <filename>xpcshell</filename> files
322 have been moved in this version, but the code which installs
323 <application>Firefox</application> (when linked to xulrunner) was not updated.
324 These symlinks allow<application>Firefox</application> to install when built against
325 <application>Xulrunner</application>.
326 </para>
327
328 </sect2>
329
330 <sect2 role="content">
331 <title>Contents</title>
332
333 <segmentedlist>
334 <segtitle>Installed Programs</segtitle>
335 <segtitle>Installed Libraries</segtitle>
336 <segtitle>Installed Directories</segtitle>
337
338 <seglistitem>
339 <seg>
340 xulrunner
341 </seg>
342 <seg>
343 Numerous libraries, browser components, plugins, extensions, and
344 helper modules installed in <filename
345 class="directory">/usr/lib/xulrunner-&xulrunner-version;</filename>
346 </seg>
347 <seg>
348 /usr/include/xulrunner-&xulrunner-version;,
349 /usr/lib/xulrunner-&xulrunner-version;,
350 /usr/lib/xulrunner-devel-&xulrunner-version; and
351 /usr/share/idl/xulrunner-&xulrunner-version;
352 </seg>
353 </seglistitem>
354 </segmentedlist>
355
356 <variablelist>
357 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
358 <?dbfo list-presentation="list"?>
359 <?dbhtml list-presentation="table"?>
360
361 <varlistentry id="xulrunner-prog">
362 <term><command>xulrunner</command></term>
363 <listitem>
364 <para>
365 is a shell script used for identifying the installed version
366 and running <application>Xulrunner</application> applications.
367 </para>
368 <indexterm zone="xulrunner xulrunner-prog">
369 <primary sortas="b-xulrunner">xulrunner</primary>
370 </indexterm>
371 </listitem>
372 </varlistentry>
373
374 </variablelist>
375
376 </sect2>
377
378</sect1>
Note: See TracBrowser for help on using the repository browser.