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 "http://releases.mozilla.org/pub/mozilla.org/firefox/releases/&firefox-version;/source/firefox-&firefox-version;.source.tar.bz2">
|
---|
8 | <!ENTITY xulrunner-download-ftp "ftp://ftp.mozilla.org/pub/mozilla.org/firefox/releases/&firefox-version;/source/firefox-&firefox-version;.source.tar.bz2">
|
---|
9 | <!-- md5sum and size should match firefox, but the buildize and time will differ -->
|
---|
10 | <!ENTITY xulrunner-md5sum "f698dd0f8f145d84933a50f69662c8db">
|
---|
11 | <!ENTITY xulrunner-size "50 MB">
|
---|
12 | <!ENTITY xulrunner-buildsize "895 MB">
|
---|
13 | <!ENTITY xulrunner-time "12 SBU">
|
---|
14 | ]>
|
---|
15 |
|
---|
16 | <sect1 id="xulrunner" xreflabel="Xulrunner-&xulrunner-version;">
|
---|
17 | <?dbhtml filename="xulrunner.html" ?>
|
---|
18 |
|
---|
19 | <sect1info>
|
---|
20 | <othername>$LastChangedBy$</othername>
|
---|
21 | <date>$Date$</date>
|
---|
22 | </sect1info>
|
---|
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><application>Xulrunner</application> is a runtime environment for XUL
|
---|
34 | applications, and forms the major part of the <application>Mozilla</application>
|
---|
35 | codebase. In particular, it provides the gecko engine together with pkgconfig
|
---|
36 | files so that applications such as <application>Yelp</application> can find
|
---|
37 | and use it. However, be aware that Gnome applications are transitioning to
|
---|
38 | <application>Webkit</application> instead of gecko.</para>
|
---|
39 |
|
---|
40 | &lfs67_checked;
|
---|
41 |
|
---|
42 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
43 | <itemizedlist spacing="compact">
|
---|
44 | <listitem>
|
---|
45 | <para>Download (HTTP): <ulink url="&xulrunner-download-http;"/></para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>Download (FTP): <ulink url="&xulrunner-download-ftp;"/></para>
|
---|
49 | <tip><para>When a new version of <application>Firefox</application> is
|
---|
50 | released, sometimes a corresponding new version of
|
---|
51 | <application>Xulrunner</application> appears at the same time. At other
|
---|
52 | times it appears several days later or not at all. So far in the
|
---|
53 | <application>Firefox-3.x</application> series, every new release has
|
---|
54 | created xulrunner libraries with a corresponding new version. Whenever
|
---|
55 | a separate Xulrunner tarball has been released, it has been bitwise
|
---|
56 | identical to the corresponding Firefox tarball. Use the
|
---|
57 | <application>Firefox</application> tarball to save downloading this
|
---|
58 | large package twice.</para></tip>
|
---|
59 | </listitem>
|
---|
60 | <listitem>
|
---|
61 | <para>Download MD5 sum: &xulrunner-md5sum;</para>
|
---|
62 | </listitem>
|
---|
63 | <listitem>
|
---|
64 | <para>Download size: &xulrunner-size;</para>
|
---|
65 | </listitem>
|
---|
66 | <listitem>
|
---|
67 | <para>Estimated disk space required: &xulrunner-buildsize; (using
|
---|
68 | recommended dependencies)</para>
|
---|
69 | </listitem>
|
---|
70 | <listitem>
|
---|
71 | <para>Estimated build time: &xulrunner-time; (using recommended
|
---|
72 | dependencies)</para>
|
---|
73 | </listitem>
|
---|
74 | </itemizedlist>
|
---|
75 |
|
---|
76 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
77 | <itemizedlist spacing="compact">
|
---|
78 | <listitem>
|
---|
79 | <para>Optional patch: <ulink
|
---|
80 | url="&patch-root;/firefox-&firefox-version;-provide_system_nspr_nss-1.patch"/>
|
---|
81 | (Required if using the included NSPR and NSS libs as system versions for
|
---|
82 | other packages)</para>
|
---|
83 | </listitem>
|
---|
84 | </itemizedlist>
|
---|
85 |
|
---|
86 | <bridgehead renderas="sect3">Xulrunner Dependencies</bridgehead>
|
---|
87 |
|
---|
88 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
89 | <para role="required"><xref linkend="alsa-lib"/>
|
---|
90 | <xref linkend="gtk2"/>,
|
---|
91 | <xref linkend="libidl"/>,
|
---|
92 | <xref linkend="pango"/>,
|
---|
93 | <xref linkend="python"/>, and
|
---|
94 | <xref linkend="zip"/></para>
|
---|
95 |
|
---|
96 | <para>Note: <application>libjpeg</application> should have been installed
|
---|
97 | before <application>GTK+</application> and should exist on your system. If
|
---|
98 | for some reason you haven't installed <application>libjpeg</application>,
|
---|
99 | you should remove the <option>--with-system-jpeg</option> option from the
|
---|
100 | <filename>.mozconfig</filename> file created below.</para>
|
---|
101 |
|
---|
102 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
103 | <para role="recommended"><xref linkend="sqlite"/> (internal sqlite is
|
---|
104 | incompatable with existing or future installations)</para>
|
---|
105 |
|
---|
106 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
107 | <para role="optional"><xref linkend="dbus-glib"/>,
|
---|
108 | <xref linkend="doxygen"/>,
|
---|
109 | <xref linkend="curl"/> (only for crash-reporter),
|
---|
110 | <xref linkend="gnome-vfs"/> and <xref linkend="libgnomeui"/>
|
---|
111 | (for gnome integration),
|
---|
112 | <xref linkend="libnotify"/>,
|
---|
113 | <xref linkend="libpng"/> (patched for apng support),
|
---|
114 | <!-- Redundant as NSS requires this
|
---|
115 | <xref linkend="nspr"/> (recommended if you build any other Mozilla.org
|
---|
116 | packages), -->
|
---|
117 | <xref linkend="nss"/> (recommended if you build any other Mozilla.org
|
---|
118 | packages),
|
---|
119 | <xref linkend="startup-notification"/>,
|
---|
120 | <xref linkend="unzip"/>,
|
---|
121 | <ulink url="http://www.valgrind.org/">Valgrind</ulink> (only for testing the
|
---|
122 | jemalloc code), and
|
---|
123 | <xref linkend="wget"/></para>
|
---|
124 |
|
---|
125 | <para condition="html" role="usernotes">User Notes:
|
---|
126 | <ulink url="&blfs-wiki;/xulrunner"/></para>
|
---|
127 |
|
---|
128 | </sect2>
|
---|
129 |
|
---|
130 | <sect2 role="installation">
|
---|
131 | <title>Installation of Xulrunner</title>
|
---|
132 |
|
---|
133 | <para>The configuration of <application>Xulrunner</application> is
|
---|
134 | accomplished by creating a <filename>.mozconfig</filename> file containing
|
---|
135 | the desired configuration options. A default <filename>.mozconfig</filename>
|
---|
136 | is created below. To see the entire list of available configuration options
|
---|
137 | (and an abbreviated description of each one), issue
|
---|
138 | <command>./configure --help</command>. You should review the entire file
|
---|
139 | and comment or uncomment options as necessary. If you would prefer to
|
---|
140 | download the file instead of creating it by typing or cut-and-pasting, you
|
---|
141 | can find it at
|
---|
142 | <ulink url="&files-anduin;/xulrunner-&xulrunner-version;-mozconfig"/>
|
---|
143 | (the file must be installed in the root of the source tree,
|
---|
144 | <!-- directory name changes depending on version of Xulrunner
|
---|
145 | <filename class='directory'>mozilla</filename> directory,--> and named
|
---|
146 | <filename>.mozconfig</filename> or <filename>mozconfig</filename>).</para>
|
---|
147 |
|
---|
148 | <screen><?dbfo keep-together="auto"?><userinput>cat > .mozconfig << "EOF"
|
---|
149 | <literal># This file contains the options used in the Xulrunner build. You may
|
---|
150 | # need to specify additional options for your specific build needs.
|
---|
151 | # Use the information provided by running './configure --help' to
|
---|
152 | # help you determine if you need to add any additional options.
|
---|
153 | # Some additional options can be added by uncommenting the examples
|
---|
154 | # in this file or adding options by inserting a line containing
|
---|
155 | # 'ac_add_options --some-option-you-need'. Be aware that some accepted
|
---|
156 | # options, such as '--with-system-bz2', do not affect the build.
|
---|
157 |
|
---|
158 | # specify that we want to build xulrunner
|
---|
159 | ac_add_options --enable-application=xulrunner
|
---|
160 |
|
---|
161 | # Create an object directory and specify to build the package in that
|
---|
162 | # directory. If desired, modify the location of the object directory
|
---|
163 | # to a directory inside the source tree by removing '../' from the
|
---|
164 | # line below.
|
---|
165 | mk_add_options MOZ_OBJDIR=@TOPSRCDIR@/../xulrunner-build
|
---|
166 |
|
---|
167 | # Specify the installation prefix. If you would prefer Xulrunner
|
---|
168 | # installed in a different prefix, modify the line below to fit
|
---|
169 | # your needs (the config will always be written to /etc/gre.d)
|
---|
170 | ac_add_options --prefix=/usr
|
---|
171 |
|
---|
172 | # apply a minimal level of optimization (-O)
|
---|
173 | ac_add_options --enable-optimize
|
---|
174 |
|
---|
175 | # These options are used so that the Xulrunner binaries are linked to
|
---|
176 | # the system-installed copies of the specified libraries instead of
|
---|
177 | # the source tree code which may not be the most recent versions.
|
---|
178 | # With the exception of libsqlite3, the libraries are statically linked.
|
---|
179 |
|
---|
180 | # (Options to use system installed libraries)
|
---|
181 | # Using the shipped version of libsqlite3 has been reported to cause
|
---|
182 | # problems with other applications which were using sqlite3.
|
---|
183 | # Only comment this line if you know exactly what you are doing!
|
---|
184 | ac_add_options --enable-system-sqlite
|
---|
185 |
|
---|
186 | # Comment this only if you want to use whatever patched version of cairo
|
---|
187 | # is in the shipped mozilla tree, together with the system headers.
|
---|
188 | ac_add_options --enable-system-cairo
|
---|
189 |
|
---|
190 | # Comment this if you did not build libjpeg before GTK+-2.
|
---|
191 | ac_add_options --with-system-jpeg
|
---|
192 |
|
---|
193 | # These two options enable support for building Xulrunner with
|
---|
194 | # system-installed versions of the Network Security Services (NSS)
|
---|
195 | # and Netscape Portable Runtime (NSPR) libraries. Comment them if
|
---|
196 | # you wish to use the included copies (not recommended).
|
---|
197 | ac_add_options --with-system-nspr
|
---|
198 | ac_add_options --with-system-nss
|
---|
199 |
|
---|
200 | # Comment this if you have not built png with the apng patch.
|
---|
201 | ac_add_options --with-system-png
|
---|
202 |
|
---|
203 | # The pthreads option is only used when building nspr
|
---|
204 | # Uncomment this if you build the included nspr.
|
---|
205 | #ac_add_options --with-pthreads
|
---|
206 |
|
---|
207 | # zlib is included in LFS. Do not comment this line.
|
---|
208 | ac_add_options --with-system-zlib
|
---|
209 |
|
---|
210 | # (Options to disable parts of the package)
|
---|
211 | # This option is used to disable the a11y support in the Xulrunner
|
---|
212 | # binaries. Comment out this option if you require a11y support.
|
---|
213 | ac_add_options --disable-accessibility
|
---|
214 |
|
---|
215 | # Uncomment this if you did not build curl.
|
---|
216 | #ac_add_options --disable-crashreporter
|
---|
217 |
|
---|
218 | # Comment this if you have built dbus-glib.
|
---|
219 | ac_add_options --disable-dbus
|
---|
220 |
|
---|
221 | # Comment this if you have gnome-vfs and libgnomeui, and wish to
|
---|
222 | # integrate xulrunner into your gnome desktop
|
---|
223 | ac_add_options --disable-gnomevfs
|
---|
224 |
|
---|
225 | # Comment this if you have wireless-tools installed and wish to use the new
|
---|
226 | # Necko WiFi scanning.
|
---|
227 | ac_add_options --disable-necko-wifi
|
---|
228 |
|
---|
229 | # Comment this if you have installed libnotify.
|
---|
230 | ac_add_options --disable-libnotify
|
---|
231 |
|
---|
232 | # This option is added so that the Mozilla Installer program is not
|
---|
233 | # built or installed. The program is not required for a BLFS
|
---|
234 | # installation of Xulrunner.
|
---|
235 | ac_add_options --disable-installer
|
---|
236 |
|
---|
237 | # If you enable javaxpcom, you must have a java compiler installed.
|
---|
238 | ac_add_options --disable-javaxpcom
|
---|
239 |
|
---|
240 | # This option is added so that test libraries and programs are not
|
---|
241 | # built. These would only be required for debugging purposes.
|
---|
242 | ac_add_options --disable-tests
|
---|
243 |
|
---|
244 | # Disable the updater, which is not appropriate if you build from source
|
---|
245 | ac_add_options --disable-updater
|
---|
246 |
|
---|
247 | # (options to add extra parts of the package)
|
---|
248 | # Use the anti-phishing measures (a blacklist of sites).
|
---|
249 | ac_add_options --enable-safe-browsing
|
---|
250 |
|
---|
251 | # This option is used so that the debugging symbols are removed from
|
---|
252 | # the installed binaries during the installation process. Comment out
|
---|
253 | # this option if you may have a need to retain the debugging symbols
|
---|
254 | # in the installed binaries (the resulting binaries will be about 7MB
|
---|
255 | # bigger).
|
---|
256 | ac_add_options --enable-strip
|
---|
257 |
|
---|
258 | # Uncomment this option if you desire support for dual-monitor
|
---|
259 | # display using the X-Window Xinerama libraries.
|
---|
260 | #ac_add_options --enable-xinerama
|
---|
261 |
|
---|
262 | # This option identifies the default binary directory of the Xulrunner
|
---|
263 | # installation and is used to locate Xulrunner's installed files. This
|
---|
264 | # option is is only used for development purposes.
|
---|
265 | #ac_add_options --with-default-mozilla-five-home=/usr/lib/xulrunner-&xulrunner-version;</literal>
|
---|
266 |
|
---|
267 |
|
---|
268 | EOF</userinput></screen>
|
---|
269 |
|
---|
270 | <para>If you did not install <xref linkend="nspr"/> and
|
---|
271 | <xref linkend="nss"/>, then apply the patch with the following
|
---|
272 | command:</para>
|
---|
273 |
|
---|
274 | <screen><userinput>patch -Np1 -i ../firefox-&firefox-version;-provide_system_nss_nspr-1.patch</userinput></screen>
|
---|
275 |
|
---|
276 | <para>Install <application>Xulrunner</application> by issuing the
|
---|
277 | following commands:</para>
|
---|
278 |
|
---|
279 | <screen><userinput>echo "Requires: nspr" >>xulrunner/installer/libxul-embedding.pc.in &&
|
---|
280 | make -f client.mk build</userinput></screen>
|
---|
281 |
|
---|
282 | <para>This package does not come with a test suite.</para>
|
---|
283 |
|
---|
284 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
285 |
|
---|
286 | <screen role="root"><userinput>make -f client.mk install &&
|
---|
287 | install -v -d -m644 /usr/lib/mozilla &&
|
---|
288 | ln -sv /usr/lib/xulrunner-&xulrunner-version;/plugins \
|
---|
289 | /usr/lib/mozilla &&
|
---|
290 | chown -Rv root:root /usr/lib/xulrunner-* \
|
---|
291 | /usr/bin/xulrunner &&
|
---|
292 | ln -sfv xulrunner-devel-&xulrunner-version;/lib/lib{xul,xpcom,mozjs}.so \
|
---|
293 | /usr/lib</userinput></screen>
|
---|
294 |
|
---|
295 | <para>If you've elected to use the included NSPR and NSS, while still the
|
---|
296 | <systemitem class="username">root</systemitem> user, complete the
|
---|
297 | installation with the following commands:</para>
|
---|
298 |
|
---|
299 | <screen role="root"><userinput>for DL in \
|
---|
300 | libnss3.so libnssutil3.so libsmime3.so libssl3.so libsoftokn3.so \
|
---|
301 | libplds4.so libplc4.so libnspr4.so
|
---|
302 | do
|
---|
303 | ln -sv xulrunner-&xulrunner-version;/$DL /usr/lib
|
---|
304 | done</userinput></screen>
|
---|
305 |
|
---|
306 | </sect2>
|
---|
307 |
|
---|
308 | <sect2 role="commands">
|
---|
309 | <title>Command Explanations</title>
|
---|
310 |
|
---|
311 | <para><command>echo "Requires: nspr"
|
---|
312 | >>xulrunner/installer/libxul-embedding.pc.in</command>: If you try to build
|
---|
313 | <application>Yelp</application> without this, the
|
---|
314 | prtypes header from NSPR will not be found. It is arguable whose error this
|
---|
315 | is (the code presumably works on earlier geckos), but this fix is unlikely
|
---|
316 | to cause any damage in other packages.</para>
|
---|
317 |
|
---|
318 | <para><command>make -f client.mk ...</command>: Mozilla products are
|
---|
319 | packaged to allow the use of a configuration file which can be used to
|
---|
320 | pass the configuration settings to the <command>configure</command>
|
---|
321 | command. <command>make</command> uses the <filename>client.mk</filename>
|
---|
322 | file to get initial configuration and setup parameters, then depending on
|
---|
323 | the target parameter (<parameter>build</parameter> or
|
---|
324 | <parameter>install</parameter>), either runs the
|
---|
325 | <command>configure</command> script and compiles the package or installs
|
---|
326 | the package.</para>
|
---|
327 |
|
---|
328 | <para><command>for DL in ...</command>: The NSPR and NSS libraries shipped
|
---|
329 | with this package are installed into
|
---|
330 | <filename class='directory'>/usr/lib/xulrunner-&xulrunner-version;</filename>
|
---|
331 | which means they will not be found at runtime. By using symbolic links from
|
---|
332 | <filename class="directory">/usr/lib</filename> the libraries will be found
|
---|
333 | and the links can be easily changed to point to a newer version during an
|
---|
334 | upgrade.</para>
|
---|
335 |
|
---|
336 | <para><command>ln -sv /usr/lib/xulrunner-&xulrunner-version;/plugins
|
---|
337 | /usr/lib/mozilla</command>: Some packages will install browser plugins
|
---|
338 | into <filename class='directory'>/usr/lib/mozilla/plugins</filename>.
|
---|
339 | Creating this as a symlink to the <application>Xulrunner</application>
|
---|
340 | plugins keeps additional plugins in a common directory.</para>
|
---|
341 |
|
---|
342 | <note>
|
---|
343 | <para>When you upgrade Xulrunner, remember to update the symlinks and to
|
---|
344 | copy any additional plugins compiled against this series of Xulrunner to the
|
---|
345 | new plugin directory.</para>
|
---|
346 | </note>
|
---|
347 |
|
---|
348 | </sect2>
|
---|
349 |
|
---|
350 | <sect2 role="content">
|
---|
351 | <title>Contents</title>
|
---|
352 |
|
---|
353 | <segmentedlist>
|
---|
354 | <segtitle>Installed Programs</segtitle>
|
---|
355 | <segtitle>Installed Libraries</segtitle>
|
---|
356 | <segtitle>Installed Directories</segtitle>
|
---|
357 |
|
---|
358 | <seglistitem>
|
---|
359 | <seg>xulrunner, and optionally nspr-config</seg>
|
---|
360 | <seg>Numerous libraries, browser components, plugins, extensions, and
|
---|
361 | helper modules installed in <filename
|
---|
362 | class='directory'>/usr/lib/xulrunner-&xulrunner-version;</filename></seg>
|
---|
363 | <seg>/etc/gre.d, /usr/include/xulrunner-&xulrunner-version;,
|
---|
364 | /usr/lib/xulrunner-&xulrunner-version;, and
|
---|
365 | /usr/lib/xulrunner-devel-&xulrunner-version;</seg>
|
---|
366 | </seglistitem>
|
---|
367 | </segmentedlist>
|
---|
368 |
|
---|
369 | <variablelist>
|
---|
370 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
371 | <?dbfo list-presentation="list"?>
|
---|
372 | <?dbhtml list-presentation="table"?>
|
---|
373 |
|
---|
374 | <varlistentry id="xulrunner-prog">
|
---|
375 | <term><command>xulrunner</command></term>
|
---|
376 | <listitem>
|
---|
377 | <para>is a shell script, useful for identifying the version
|
---|
378 | installed.</para>
|
---|
379 | <indexterm zone="xulrunner xulrunner-prog">
|
---|
380 | <primary sortas="b-xulrunner">xulrunner</primary>
|
---|
381 | </indexterm>
|
---|
382 | </listitem>
|
---|
383 | </varlistentry>
|
---|
384 |
|
---|
385 | </variablelist>
|
---|
386 |
|
---|
387 | </sect2>
|
---|
388 |
|
---|
389 | </sect1>
|
---|