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