[f939f05] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[f939f05] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[2eae5bc] | 7 | <!ENTITY firefox-download-http "&mozilla-http;/firefox/releases/&firefox-version;esr/source/firefox-&firefox-version;esr.source.tar.xz">
|
---|
[8dfc5c3] | 8 | <!ENTITY firefox-download-ftp " ">
|
---|
[569d3364] | 9 | <!ENTITY firefox-md5sum "61350e551a90d199ca4a1f93e69092ee">
|
---|
| 10 | <!ENTITY firefox-size "364 MB">
|
---|
[5c2b024] | 11 | <!-- NB with stylo, much of the build uses rust, and therefore cargo files.
|
---|
[9da4cc6f] | 12 | But the extra cached cargo files, if any, seem to be minimal -->
|
---|
[569d3364] | 13 | <!ENTITY firefox-buildsize "6.7 GB (195 MB installed) without tests">
|
---|
[9a469bc] | 14 | <!-- editors: with ff63 and rust-1.29, ./mach build -j4 is probably the
|
---|
[fe5f563d] | 15 | most practical way to get a timing on a machine with more cores, if taking
|
---|
| 16 | cores offline is not practical. If in doubt, round up -->
|
---|
[569d3364] | 17 | <!ENTITY firefox-time "29 SBU (on a typical 4-core machine) without tests">
|
---|
[f939f05] | 18 | ]>
|
---|
| 19 |
|
---|
[ffe47ca2] | 20 | <sect1 id="firefox" xreflabel="Firefox-&firefox-version;">
|
---|
[b81991e1] | 21 | <?dbhtml filename="firefox.html" ?>
|
---|
| 22 |
|
---|
| 23 | <sect1info>
|
---|
| 24 | <date>$Date$</date>
|
---|
| 25 | </sect1info>
|
---|
| 26 |
|
---|
| 27 | <title>Firefox-&firefox-version;</title>
|
---|
| 28 |
|
---|
| 29 | <indexterm zone="firefox">
|
---|
| 30 | <primary sortas="a-Firefox">Firefox</primary>
|
---|
| 31 | </indexterm>
|
---|
| 32 |
|
---|
| 33 | <sect2 role="package">
|
---|
| 34 | <title>Introduction to Firefox</title>
|
---|
| 35 |
|
---|
[c1ae13c] | 36 | <para>
|
---|
| 37 | <application>Firefox</application> is a stand-alone browser based on the
|
---|
| 38 | <application>Mozilla</application> codebase.
|
---|
| 39 | </para>
|
---|
[b81991e1] | 40 |
|
---|
[b5645ad] | 41 | &lfs110a_checked;
|
---|
[76ae9a2] | 42 |
|
---|
[b81991e1] | 43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 44 | <itemizedlist spacing="compact">
|
---|
| 45 | <listitem>
|
---|
[c1ae13c] | 46 | <para>
|
---|
| 47 | Download (HTTP): <ulink url="&firefox-download-http;"/>
|
---|
| 48 | </para>
|
---|
[b81991e1] | 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
[c1ae13c] | 51 | <para>
|
---|
| 52 | Download (FTP): <ulink url="&firefox-download-ftp;"/>
|
---|
| 53 | </para>
|
---|
[b81991e1] | 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
[c1ae13c] | 56 | <para>
|
---|
| 57 | Download MD5 sum: &firefox-md5sum;
|
---|
| 58 | </para>
|
---|
[b81991e1] | 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
[c1ae13c] | 61 | <para>
|
---|
| 62 | Download size: &firefox-size;
|
---|
| 63 | </para>
|
---|
[b81991e1] | 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
[c1ae13c] | 66 | <para>
|
---|
| 67 | Estimated disk space required: &firefox-buildsize;
|
---|
| 68 | </para>
|
---|
[b81991e1] | 69 | </listitem>
|
---|
| 70 | <listitem>
|
---|
[c1ae13c] | 71 | <para>
|
---|
| 72 | Estimated build time: &firefox-time;
|
---|
| 73 | </para>
|
---|
[b81991e1] | 74 | </listitem>
|
---|
| 75 | </itemizedlist>
|
---|
| 76 |
|
---|
[883e376] | 77 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
[bf5fb94] | 78 | <itemizedlist spacing="compact">
|
---|
[a05a69a4] | 79 | <listitem>
|
---|
| 80 | <para>
|
---|
| 81 | Recommended patch:
|
---|
| 82 | <ulink url="&patch-root;/firefox-&firefox-version;esr-disable_rust_test-1.patch"/>
|
---|
| 83 | </para>
|
---|
| 84 | </listitem>
|
---|
[883e376] | 85 | </itemizedlist>
|
---|
[bf5fb94] | 86 |
|
---|
[f06c692] | 87 | <note>
|
---|
[883e376] | 88 |
|
---|
[a05a69a4] | 89 | <!-- temporary note, remove with firefox-legacy -->
|
---|
[883e376] | 90 | <para>
|
---|
[a05a69a4] | 91 | With the 91 ESR series, firefox no-longer works on ftp: links.
|
---|
| 92 | If that is important to you, as a temporary measure (on non-glibc-2.34
|
---|
| 93 | systems) you can continue to use <xref linkend="firefox-legacy"/>
|
---|
| 94 | while you explore alternative approaches.
|
---|
[883e376] | 95 | </para>
|
---|
| 96 | <!-- end of temporary note -->
|
---|
| 97 |
|
---|
[2eae5bc] | 98 | <para>
|
---|
| 99 | The directory name is firefox-&firefox-version;
|
---|
| 100 | </para>
|
---|
| 101 |
|
---|
[f06c692] | 102 | <para>
|
---|
[8d0bc761] | 103 | Extracting the tarball
|
---|
| 104 | will reset the permissions of the current directory to 0755 if you
|
---|
[765c2a7] | 105 | have permission to do that. If you do this in a directory where
|
---|
[37bf7b1] | 106 | the sticky bit is set, such
|
---|
[dc9a18a] | 107 | as <filename class="directory">/tmp</filename> it will end with error
|
---|
| 108 | messages:
|
---|
| 109 | </para>
|
---|
| 110 |
|
---|
| 111 | <literallayout>tar: .: Cannot utime: Operation not permitted
|
---|
| 112 | tar: .: Cannot change mode to rwxr-xr-t: Operation not permitted
|
---|
| 113 | tar: Exiting with failure status due to previous errors
|
---|
| 114 | </literallayout>
|
---|
| 115 |
|
---|
| 116 | <para>
|
---|
| 117 | This does finish with non-zero status, but it does
|
---|
| 118 | <emphasis>NOT</emphasis> mean there is a real problem.
|
---|
| 119 | Do not untar as the <systemitem class="username">root</systemitem> user
|
---|
| 120 | in a directory where the sticky bit is set - that will unset it.
|
---|
[f06c692] | 121 | </para>
|
---|
[8d0bc761] | 122 |
|
---|
| 123 | <para>
|
---|
[406e5ffe] | 124 | As with other large packages which use C++ (or rust), the SBU times
|
---|
[d5d7cd6] | 125 | to build this vary more widely than you might expect. The build times
|
---|
| 126 | will increase significantly if your machine has to swap.
|
---|
[8d0bc761] | 127 | </para>
|
---|
| 128 |
|
---|
[d5d7cd6] | 129 | <!-- commented, by 78.0 it seems to work reliably
|
---|
[e628b536] | 130 | <para>
|
---|
| 131 | The mach build system (Python scripts) can be somewhat unreliable: if
|
---|
| 132 | the build fails and reports an Error, it can still return a status of
|
---|
| 133 | success, causing a scripted build to try to install (which does not rerun
|
---|
| 134 | the build), fail during the preparations for installing, but still exit
|
---|
| 135 | with a status of success. Also, on occasion it may limit itself to only
|
---|
| 136 | running one set of jobs - that will make the build take about 3 times as
|
---|
| 137 | long as running with four sets of jobs.
|
---|
[d5d7cd6] | 138 | </para>-->
|
---|
[e628b536] | 139 |
|
---|
[8d0bc761] | 140 | <para>
|
---|
| 141 | Although upstream prefer to use <application>PulseAudio</application>,
|
---|
| 142 | for the moment <application>Alsa</application> can still be used. Both
|
---|
| 143 | may need runtime configuration to get sound working.
|
---|
| 144 | </para>
|
---|
[f06c692] | 145 | </note>
|
---|
| 146 |
|
---|
[b81991e1] | 147 | <bridgehead renderas="sect3">Firefox Dependencies</bridgehead>
|
---|
| 148 |
|
---|
| 149 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[c1ae13c] | 150 | <para role="required">
|
---|
[14de4227] | 151 | <xref linkend="autoconf213"/>,
|
---|
[44cd41e] | 152 | <xref linkend="cbindgen"/>,
|
---|
[703f0ce] | 153 | <xref linkend="dbus-glib"/>,
|
---|
[ac105103] | 154 | both <xref linkend="gtk3"/> and
|
---|
[9da4cc6f] | 155 | <xref linkend="gtk2"/>,
|
---|
[326f830] | 156 | <xref linkend="libnotify"/>,
|
---|
[74762a5] | 157 | <xref linkend="llvm"/> (clang, used for bindgen even if using gcc),
|
---|
[fe5f563d] | 158 | <xref linkend="nodejs"/>,
|
---|
[be0bd12] | 159 | <xref linkend="pulseaudio"/>
|
---|
[81b3e7fd] | 160 | (or
|
---|
[9da4cc6f] | 161 | <xref linkend="alsa-lib"/> if you edit the mozconfig;
|
---|
[326f830] | 162 | now deprecated by mozilla), in either case please read the
|
---|
| 163 | Configuration Information,
|
---|
[d5d7cd6] | 164 | <!-- rustc is required by cbindgen so not needed here
|
---|
| 165 | <xref linkend="rust"/>,-->
|
---|
[693f28e1] | 166 | <xref linkend="python3"/> (rebuilt after installing <xref linkend="sqlite"/>),
|
---|
[d5d7cd6] | 167 | <xref linkend="startup-notification"/>,
|
---|
[59a6b63] | 168 | <xref linkend="unzip"/>,
|
---|
[479e03a] | 169 | <xref linkend="yasm"/>, and
|
---|
| 170 | <xref linkend="zip"/>
|
---|
[c1ae13c] | 171 | </para>
|
---|
| 172 |
|
---|
[1555d3d] | 173 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[c1ae13c] | 174 | <para role="recommended">
|
---|
[b84fe71] | 175 | <xref linkend="icu"/>,
|
---|
[0e37869] | 176 | <xref linkend="libevent"/>,
|
---|
[569d3364] | 177 | <xref linkend="libvpx"/>,
|
---|
[e399c12] | 178 | <xref linkend="libwebp"/>,
|
---|
[569d3364] | 179 | <xref linkend="nasm"/>,
|
---|
| 180 | <xref linkend="nss"/>
|
---|
[c1ae13c] | 181 | </para>
|
---|
[1555d3d] | 182 |
|
---|
[0e37869] | 183 | <note>
|
---|
| 184 | <para>
|
---|
[b9f61df] | 185 | If you don't install recommended dependencies, then internal copies of
|
---|
| 186 | those packages will be used. They might be tested to work, but they can
|
---|
| 187 | be out of date or contain security holes.
|
---|
[0e37869] | 188 | </para>
|
---|
| 189 | </note>
|
---|
[8d0bc761] | 190 |
|
---|
[b81991e1] | 191 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[c1ae13c] | 192 | <para role="optional">
|
---|
[6c64623f] | 193 | <xref linkend="curl"/>,
|
---|
[c1ae13c] | 194 | <xref linkend="doxygen"/>,
|
---|
[babf0a0] | 195 | <xref role="runtime" linkend="ffmpeg"/> (runtime, to play mov, mp3 or mp4 files),
|
---|
[c6b192c] | 196 | <!-- <phrase revision="sysv"><ulink url="https://sourceforge.net/projects/liboauth/files/">liboauth</ulink></phrase> -->
|
---|
[fe30eab] | 197 | <xref linkend="liboauth"/>,
|
---|
[26fa7d2] | 198 | <xref linkend="openjdk"/>,
|
---|
[566fcae] | 199 | <xref linkend="valgrind"/>,
|
---|
[6000a3e] | 200 | <xref linkend="wget"/>,
|
---|
[73b06df] | 201 | <xref linkend="wireless_tools"/>,
|
---|
[d5d7cd6] | 202 | <ulink url="https://github.com/libproxy/libproxy">libproxy</ulink>
|
---|
[c1ae13c] | 203 | </para>
|
---|
| 204 |
|
---|
| 205 | <para condition="html" role="usernotes">
|
---|
| 206 | User Notes: <ulink url="&blfs-wiki;/firefox"/>
|
---|
| 207 | </para>
|
---|
[b81991e1] | 208 | </sect2>
|
---|
| 209 |
|
---|
| 210 | <sect2 role="installation">
|
---|
| 211 | <title>Installation of Firefox</title>
|
---|
| 212 |
|
---|
[f72a04a] | 213 | <para>
|
---|
[b9f61df] | 214 | The configuration of <application>Firefox</application> is accomplished
|
---|
| 215 | by creating a <filename>mozconfig</filename> file containing the desired
|
---|
| 216 | configuration options. A default <filename>mozconfig</filename> is
|
---|
| 217 | created below. To see the entire list of available configuration options
|
---|
[888e303] | 218 | (and an abbreviated description of some of them), issue <command>./mach
|
---|
| 219 | configure && ./configure --help | less</command>. You may also
|
---|
| 220 | wish to review the entire file and uncomment any other desired options.
|
---|
| 221 | Create the file by issuing the following command:
|
---|
[c1ae13c] | 222 | </para>
|
---|
[5a13c45] | 223 |
|
---|
[0e37869] | 224 | <screen><userinput>cat > mozconfig << "EOF"
|
---|
[dcb0fe6] | 225 | <literal># If you have a multicore machine, all cores will be used by default.
|
---|
| 226 |
|
---|
[703f0ce] | 227 | # If you have installed (or will install) wireless-tools, and you wish
|
---|
| 228 | # to use geolocation web services, comment out this line
|
---|
[6d1bf0e] | 229 | ac_add_options --disable-necko-wifi
|
---|
| 230 |
|
---|
[ad5a97d] | 231 | # API Keys for geolocation APIs - necko-wifi (above) is required for MLS
|
---|
| 232 | # Uncomment the following line if you wish to use Mozilla Location Service
|
---|
| 233 | #ac_add_options --with-mozilla-api-keyfile=$PWD/mozilla-key
|
---|
| 234 |
|
---|
| 235 | # Uncomment the following line if you wish to use Google's geolocaton API
|
---|
| 236 | # (needed for use with saved maps with Google Maps)
|
---|
[9116137c] | 237 | #ac_add_options --with-google-location-service-api-keyfile=$PWD/google-key
|
---|
[ad5a97d] | 238 |
|
---|
[d5d7cd6] | 239 | # startup-notification is required since firefox-78
|
---|
[495ebe07] | 240 |
|
---|
[81b3e7fd] | 241 | # Uncomment the following option if you have not installed PulseAudio
|
---|
| 242 | #ac_add_options --disable-pulseaudio
|
---|
[3507f80] | 243 | # or uncomment this if you installed alsa-lib instead of PulseAudio
|
---|
[81b3e7fd] | 244 | #ac_add_options --enable-alsa
|
---|
[89cdb63d] | 245 |
|
---|
[0e37869] | 246 | # Comment out following options if you have not installed
|
---|
| 247 | # recommended dependencies:
|
---|
[569d3364] | 248 | ac_add_options --with-system-icu
|
---|
[0e37869] | 249 | ac_add_options --with-system-libevent
|
---|
[569d3364] | 250 | ac_add_options --with-system-libvpx
|
---|
[0e37869] | 251 | ac_add_options --with-system-nspr
|
---|
| 252 | ac_add_options --with-system-nss
|
---|
[569d3364] | 253 | ac_add_options --with-system-webp
|
---|
[9a469bc] | 254 |
|
---|
[e399c12] | 255 | # Do not specify the gold linker which is not the default. It will take
|
---|
| 256 | # longer and use more disk space when debug symbols are disabled.
|
---|
[9a469bc] | 257 |
|
---|
[e399c12] | 258 | # libdavid (av1 decoder) requires nasm. Uncomment this if nasm
|
---|
| 259 | # has not been installed.
|
---|
| 260 | #ac_add_options --disable-av1
|
---|
[0a561d8] | 261 |
|
---|
[9a469bc] | 262 | # You cannot distribute the binary if you do this
|
---|
| 263 | ac_add_options --enable-official-branding
|
---|
[0e37869] | 264 |
|
---|
[14de4227] | 265 | # Stripping is now enabled by default.
|
---|
| 266 | # Uncomment these lines if you need to run a debugger:
|
---|
| 267 | #ac_add_options --disable-strip
|
---|
| 268 | #ac_add_options --disable-install-strip
|
---|
| 269 |
|
---|
[e399c12] | 270 | # Disabling debug symbols makes the build much smaller and a little
|
---|
[ec54fa5b] | 271 | # faster. Comment this if you need to run a debugger. Note: This is
|
---|
| 272 | # required for compilation on i686.
|
---|
[e399c12] | 273 | ac_add_options --disable-debug-symbols
|
---|
| 274 |
|
---|
[c9677a35] | 275 | # The elf-hack is reported to cause failed installs (after successful builds)
|
---|
| 276 | # on some machines. It is supposed to improve startup time and it shrinks
|
---|
| 277 | # libxul.so by a few MB - comment this if you know your machine is not affected.
|
---|
| 278 | ac_add_options --disable-elf-hack
|
---|
| 279 |
|
---|
[d5d7cd6] | 280 | # The BLFS editors recommend not changing anything below this line:
|
---|
| 281 | ac_add_options --prefix=/usr
|
---|
| 282 | ac_add_options --enable-application=browser
|
---|
[5f5dcc2] | 283 | ac_add_options --disable-crashreporter
|
---|
| 284 | ac_add_options --disable-updater
|
---|
[57a8df2] | 285 | # enabling the tests will use a lot more space and significantly
|
---|
| 286 | # increase the build time, for no obvious benefit.
|
---|
[0e37869] | 287 | ac_add_options --disable-tests
|
---|
| 288 |
|
---|
[e399c12] | 289 | # The default level of optimization again produces a working build with gcc.
|
---|
[8df543f] | 290 | ac_add_options --enable-optimize
|
---|
[0e37869] | 291 |
|
---|
[41f2e90] | 292 | ac_add_options --enable-system-ffi
|
---|
[0e37869] | 293 | ac_add_options --enable-system-pixman
|
---|
| 294 |
|
---|
[a0ace670] | 295 | ac_add_options --with-system-jpeg
|
---|
| 296 | ac_add_options --with-system-png
|
---|
| 297 | ac_add_options --with-system-zlib
|
---|
[aed37975] | 298 |
|
---|
[1b0a207] | 299 | # The following option unsets Telemetry Reporting. With the Addons Fiasco,
|
---|
| 300 | # Mozilla was found to be collecting user's data, including saved passwords and
|
---|
| 301 | # web form data, without users consent. Mozilla was also found shipping updates
|
---|
| 302 | # to systems without the user's knowledge or permission.
|
---|
| 303 | # As a result of this, use the following command to permanently disable
|
---|
| 304 | # telemetry reporting in Firefox.
|
---|
| 305 | unset MOZ_TELEMETRY_REPORTING
|
---|
| 306 |
|
---|
[4def8b6] | 307 | mk_add_options MOZ_OBJDIR=@TOPSRCDIR@/firefox-build-dir</literal>
|
---|
[0e37869] | 308 | EOF</userinput></screen>
|
---|
[b9b7146] | 309 |
|
---|
[c1ae13c] | 310 | <para>
|
---|
| 311 | Compile <application>Firefox</application> by issuing the following
|
---|
| 312 | commands:
|
---|
| 313 | </para>
|
---|
[9572e88] | 314 |
|
---|
[2eb6c62] | 315 | <para>
|
---|
[569d3364] | 316 | First apply a patch which works around unexplained failures on some machines
|
---|
[a05a69a4] | 317 | (a message that a python check on libgkrust.a identified 1 networking
|
---|
| 318 | function, getsockname) in the rust static library.
|
---|
| 319 | </para>
|
---|
| 320 |
|
---|
| 321 | <screen><userinput>patch -Np1 -i ../firefox-&firefox-version;esr-disable_rust_test-1.patch</userinput></screen>
|
---|
| 322 |
|
---|
[ad5a97d] | 323 | <para>
|
---|
| 324 | If the geolocation APIs are needed:
|
---|
| 325 | </para>
|
---|
| 326 |
|
---|
[e5c8de01] | 327 | <note>
|
---|
| 328 | <para>
|
---|
| 329 | <!-- Taken from Arch Linux - an immensely helpful link - Thanks -->
|
---|
| 330 | The Google and Mozilla API Keys below are specific to LFS. If using
|
---|
| 331 | these instructions for another distro, or if you intend to distribute
|
---|
| 332 | binary copies of the software using these instructions, please obtain
|
---|
| 333 | your own keys following the instructions located at
|
---|
| 334 | <ulink url="http://www.chromium.org/developers/how-tos/api-keys"/> and
|
---|
| 335 | <ulink url="https://location.services.mozilla.com/api"/> respectively.
|
---|
| 336 | <!-- BLFS Devs, register an account at Google with your
|
---|
| 337 | @linuxfromscratch.org email address, and I'll make you an administrator
|
---|
| 338 | for the 'Google APIs for LFS' project (where the API and OAuth keys
|
---|
| 339 | were created for use in the book).-->
|
---|
| 340 | </para>
|
---|
| 341 | </note>
|
---|
| 342 |
|
---|
[ad5a97d] | 343 | <screen><userinput>echo "AIzaSyDxKL42zsPjbke5O8_rPVpVrLrJ8aeE9rQ" > google-key
|
---|
[5f18b7a8] | 344 | echo "613364a7-9418-4c86-bcee-57e32fd70c23" > mozilla-key</userinput></screen>
|
---|
[ad5a97d] | 345 |
|
---|
[5b0a978e] | 346 | <note>
|
---|
| 347 |
|
---|
| 348 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 349 | href="../../xincludes/mozshm.xml"/>
|
---|
| 350 |
|
---|
| 351 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 352 | href="../../xincludes/mozmach.xml"/>
|
---|
| 353 |
|
---|
| 354 | </note>
|
---|
[57feeb5] | 355 | <!--
|
---|
[ec54fa5b] | 356 | <para>
|
---|
| 357 | If you are building on i686, apply a fix to prevent Internal Compiler
|
---|
| 358 | Errors in GCC-7+:
|
---|
[e399c12] | 359 | </para>
|
---|
| 360 |
|
---|
[ec54fa5b] | 361 | <screen><userinput remap="pre">case $(uname -m) in
|
---|
| 362 | i?86) sed -i "562 s/mips64/i386/" gfx/skia/skia/third_party/skcms/src/Transform_inl.h ;;
|
---|
| 363 | esac</userinput></screen>
|
---|
[57feeb5] | 364 | -->
|
---|
[393517d3] | 365 | <!--<para>
|
---|
[bf5fb94] | 366 | Apply a patch to allow this to be compiled with <xref linkend="rust"/>:
|
---|
| 367 | </para>
|
---|
| 368 |
|
---|
[393517d3] | 369 | <screen><userinput remap="pre">patch -p1 -i ../firefox-&firefox-version;esr-rustc1470-1.patch</userinput></screen>-->
|
---|
[29b0395] | 370 |
|
---|
| 371 | <para>
|
---|
[8d70628] | 372 | Now invoke the Python <command>mach</command> script to compile the package.
|
---|
[29b0395] | 373 | </para>
|
---|
[e8d45427] | 374 |
|
---|
[29b0395] | 375 | <screen><userinput>export CC=gcc CXX=g++ &&
|
---|
[8d70628] | 376 | export MACH_USE_SYSTEM_PYTHON=1 &&
|
---|
[ec1d8ae] | 377 | export MOZBUILD_STATE_PATH=${PWD}/mozbuild &&
|
---|
[89d7ee1] | 378 | ./mach configure &&
|
---|
[f0b7ae67] | 379 | ./mach build</userinput></screen>
|
---|
[3bdfc9fd] | 380 |
|
---|
[0e37869] | 381 | <para>
|
---|
[57a8df2] | 382 | The <filename>mozconfig</filename> above disables the tests because
|
---|
| 383 | they use a lot more time and disk space for no obvious benefit. If
|
---|
[ecffcbbc] | 384 | you have nevertheless enabled them, you can run the tests by executing
|
---|
| 385 | <command>./mach gtest</command>. This will require a network connection,
|
---|
| 386 | and to be run from within an Xorg session - there is a popup dialog
|
---|
| 387 | when it fails to connect to ALSA (that does not create a failed test).
|
---|
| 388 | One or two tests will fail. To see the details of the failure(s) you
|
---|
| 389 | will need to log the output from that command so that you can review it.
|
---|
[0e37869] | 390 | </para>
|
---|
[01ce75f8] | 391 |
|
---|
[495ebe07] | 392 | <para>
|
---|
[b9f61df] | 393 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
[c1ae13c] | 394 | </para>
|
---|
[5a13c45] | 395 |
|
---|
[8d70628] | 396 | <screen role="root"><userinput>MACH_USE_SYSTEM_PYTHON=1 ./mach install</userinput></screen>
|
---|
[fe5f563d] | 397 |
|
---|
[a5708ba] | 398 | <para>
|
---|
[8d70628] | 399 | Empty the environment variables which were set above:
|
---|
[a5708ba] | 400 | </para>
|
---|
| 401 |
|
---|
[8d70628] | 402 | <screen><userinput>unset CC CXX MACH_USE_SYSTEM_PYTHON MOZBUILD_STATE_PATH</userinput></screen>
|
---|
[01ce75f8] | 403 |
|
---|
[b81991e1] | 404 | </sect2>
|
---|
| 405 |
|
---|
[361df3e] | 406 | <sect2 role="commands">
|
---|
| 407 | <title>Command Explanations</title>
|
---|
[7d09fcb9] | 408 |
|
---|
[29b0395] | 409 | <!--<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 410 | href="../../xincludes/SIOCGSTAMP.xml"/>-->
|
---|
[e8d45427] | 411 |
|
---|
[9a469bc] | 412 | <para>
|
---|
[e399c12] | 413 | <command>export CC=gcc CXX=g++ ...</command>: Upstream now prefer
|
---|
[d5d7cd6] | 414 | <application>clang</application> so that they can use one compiler
|
---|
| 415 | everywhere. On the X86 architectures <application>clang</application>
|
---|
[6629008] | 416 | now appears to support most of the same security-hardening options as
|
---|
[bf5fb94] | 417 | <application>GCC</application>.
|
---|
| 418 | <!-- supported in llvm-11
|
---|
| 419 | but the newer
|
---|
| 420 | <literal>-fstack-clash-protection</literal> is still not supported.-->
|
---|
[6629008] | 421 | With the current versions and the default flags,
|
---|
[d5d7cd6] | 422 | <application>GCC</application> creates a marginally bigger build but
|
---|
| 423 | takes typically 2 SBU less time on a 4-core machine using the mozconfig
|
---|
| 424 | above.
|
---|
[9a469bc] | 425 | </para>
|
---|
| 426 |
|
---|
[fe5f563d] | 427 | <para>
|
---|
| 428 | <command>export MOZBUILD_STATE_PATH=${PWD}/mozbuild</command>: The build
|
---|
| 429 | is now supposed to tell you that it intends to create <filename
|
---|
| 430 | class="directory">~/.mozbuild</filename>, and offer you an option to
|
---|
| 431 | press <ENTER> to accept this, or Ctrl-C to cancel and restart the
|
---|
| 432 | build after specifying the directory. In practice, the message may not
|
---|
| 433 | appear until after <ENTER> is keyed, i.e. the build stalls.
|
---|
| 434 | </para>
|
---|
| 435 |
|
---|
| 436 | <para>
|
---|
| 437 | That directory is used for a (probably random) telemetry identifier.
|
---|
| 438 | Creating this in the build directory, and deleting that after the
|
---|
| 439 | installation, prevents it being used. If you wish to participate in
|
---|
[883e376] | 440 | telemetry, export MOZBUILD_STATE_PATH to point to its default directory
|
---|
| 441 | and remove the entry from the <filename>mozconfig</filename>.
|
---|
| 442 | </para>
|
---|
| 443 |
|
---|
| 444 | <para>
|
---|
[8d70628] | 445 | <command>MACH_USE_SYSTEM_PYTHON=1</command>: Use the system python
|
---|
| 446 | to create a virtual environment for <command>mach</command> without
|
---|
| 447 | downloading any python wheels.
|
---|
[883e376] | 448 | </para>
|
---|
| 449 |
|
---|
| 450 | <para>
|
---|
| 451 | <command>./mach configure</command>: This validates the supplied
|
---|
| 452 | dependencies and the <filename>mozconfig</filename>.
|
---|
[fe5f563d] | 453 | </para>
|
---|
| 454 |
|
---|
[c1ae13c] | 455 | <para>
|
---|
[326f830] | 456 | <option>./mach build --verbose</option>: Use this alternative if you
|
---|
| 457 | need details of which files are being compiled, together with any C or
|
---|
[d5d7cd6] | 458 | C++ flags being used. But do not add '--verbose' to the install command,
|
---|
| 459 | it is not accepted there.
|
---|
[c1ae13c] | 460 | </para>
|
---|
| 461 |
|
---|
[9a469bc] | 462 | <para>
|
---|
[fe5f563d] | 463 | <option>./mach build -jN</option>: The build should, by default, use
|
---|
[d5d7cd6] | 464 | all the online CPU cores. If using all the cores causes the build to swap
|
---|
| 465 | because you have insufficient memory, using fewer cores can be faster.
|
---|
[9a469bc] | 466 | </para>
|
---|
| 467 |
|
---|
[95df066] | 468 | <!--
|
---|
[c1ae13c] | 469 | <para>
|
---|
[8d0bc761] | 470 | <command>mkdir -pv /usr/lib/mozilla/plugins</command>: This ensures
|
---|
| 471 | that <filename class="directory">/usr/lib/mozilla/plugins/</filename>
|
---|
[c1ae13c] | 472 | exists.
|
---|
| 473 | </para>
|
---|
| 474 |
|
---|
| 475 | <para>
|
---|
[8d0bc761] | 476 | <command>ln -sv ... /usr/lib/firefox/browser</command>:
|
---|
[24da103] | 477 | This command creates a symbolic link to <filename
|
---|
| 478 | class="directory">/usr/lib/mozilla/plugins</filename>. It's not really
|
---|
| 479 | needed, as <application>Firefox</application> checks <filename
|
---|
| 480 | class="directory">/usr/lib/mozilla/plugins</filename> by default, but the
|
---|
| 481 | symbolic link is made to keep all the plugins installed in one folder.
|
---|
[c1ae13c] | 482 | </para>
|
---|
[95df066] | 483 | -->
|
---|
[fa1bc3e] | 484 |
|
---|
[b81991e1] | 485 | </sect2>
|
---|
| 486 |
|
---|
[88cec02] | 487 | <sect2 role="configuration">
|
---|
| 488 | <title>Configuring Firefox</title>
|
---|
| 489 |
|
---|
[c1ae13c] | 490 | <para>
|
---|
| 491 | If you use a desktop environment like <application>Gnome</application> or
|
---|
| 492 | <application>KDE</application> you may like to create a
|
---|
| 493 | <filename>firefox.desktop</filename> file so that
|
---|
[3927e328] | 494 | <application>Firefox</application> appears in the panel's menus. <!--If you
|
---|
[c1ae13c] | 495 | didn't enable startup-notification in your mozconfig change the
|
---|
[3927e328] | 496 | StartupNotify line to false.--> As the
|
---|
[c1ae13c] | 497 | <systemitem class="username">root</systemitem> user:
|
---|
| 498 | </para>
|
---|
[31de6e7] | 499 |
|
---|
[eb5f847a] | 500 | <screen role="root"><userinput>mkdir -pv /usr/share/applications &&
|
---|
[28909b72] | 501 | mkdir -pv /usr/share/pixmaps &&
|
---|
[74f73ede] | 502 |
|
---|
[28909b72] | 503 | MIMETYPE="text/xml;text/mml;text/html;" &&
|
---|
| 504 | MIMETYPE="$MIMETYPE;application/xhtml+xml;application/vnd.mozilla.xul+xml" &&
|
---|
| 505 | MIMETYPE="$MIMETYPE;x-scheme-handler/http;x-scheme-handler/https; &&
|
---|
| 506 |
|
---|
| 507 | cat > /usr/share/applications/firefox.desktop << EOF &&
|
---|
[fcd66369] | 508 | <literal>[Desktop Entry]
|
---|
[31de6e7] | 509 | Encoding=UTF-8
|
---|
[0e37869] | 510 | Name=Firefox Web Browser
|
---|
| 511 | Comment=Browse the World Wide Web
|
---|
| 512 | GenericName=Web Browser
|
---|
| 513 | Exec=firefox %u
|
---|
| 514 | Terminal=false
|
---|
[31de6e7] | 515 | Type=Application
|
---|
| 516 | Icon=firefox
|
---|
[0e37869] | 517 | Categories=GNOME;GTK;Network;WebBrowser;
|
---|
[28909b72] | 518 | MimeType=$MIMETYPE
|
---|
[fcd66369] | 519 | StartupNotify=true</literal>
|
---|
[31de6e7] | 520 | EOF
|
---|
[74f73ede] | 521 |
|
---|
[28909b72] | 522 | unset MIMETYPE &&
|
---|
| 523 |
|
---|
[888e303] | 524 | ln -sfv /usr/lib/firefox/browser/chrome/icons/default/default128.png \
|
---|
[0e37869] | 525 | /usr/share/pixmaps/firefox.png</userinput></screen>
|
---|
| 526 |
|
---|
[326f830] | 527 | <sect3><title>Configuration Information</title>
|
---|
| 528 |
|
---|
| 529 | <para>
|
---|
| 530 | The application settings for firefox are accessible by keying
|
---|
| 531 | <command>about:config</command> in the address bar.
|
---|
| 532 | </para>
|
---|
| 533 |
|
---|
| 534 | <para>
|
---|
[d5d7cd6] | 535 | Occasionally, getting working sound in
|
---|
| 536 | <application>firefox</application> can be a problem. Although upstream
|
---|
| 537 | prefers pulseaudio,
|
---|
[326f830] | 538 | on balance using <application>Alsa</application> may be easier.
|
---|
| 539 | </para>
|
---|
| 540 |
|
---|
| 541 | <para>
|
---|
| 542 | If you enabled <application>Alsa</application> for sound, you may need
|
---|
| 543 | to alter one variable to get working sound. If you run
|
---|
| 544 | <command>firefox</command> from a term and try to play something with
|
---|
| 545 | sound you might encounter error messages like:
|
---|
| 546 | </para>
|
---|
| 547 |
|
---|
| 548 | <para>
|
---|
| 549 | <literal>Sandbox: seccomp sandbox violation: pid 3941, tid 4030,
|
---|
| 550 | syscall 16, args 48 2147767296 139909894784796 0 0 0.</literal>
|
---|
| 551 | </para>
|
---|
| 552 |
|
---|
| 553 | <para>
|
---|
| 554 | That was on x86_64, on i686 the syscall number is 54. To allow this
|
---|
| 555 | syscall, in <command>about:config</command> change
|
---|
| 556 | <command>security.sandbox.content.syscall_whitelist</command> to 16
|
---|
| 557 | (or 54 if using i686).
|
---|
| 558 | </para>
|
---|
| 559 |
|
---|
| 560 | <para>
|
---|
| 561 | If you use <command>pulseaudio</command> in a Desktop Environment, it
|
---|
| 562 | might already be started by that DE. But if it is not, although
|
---|
[7ebe22e] | 563 | firefox-57 managed to start it, firefox-58 did not. If you run
|
---|
| 564 | <command>firefox</command> from a term and this problem is present,
|
---|
| 565 | trying to play sound will
|
---|
[326f830] | 566 | encounter error messages warning <literal>Can't get cubeb
|
---|
| 567 | context!</literal>
|
---|
| 568 | </para>
|
---|
| 569 |
|
---|
| 570 | <para>
|
---|
| 571 | The fix for this is to close firefox, start pulseaudio to check it
|
---|
| 572 | does start (if not, read the information on Configuring in <xref
|
---|
| 573 | linkend="pulseaudio"/>) and restart firefox to check it is working.
|
---|
| 574 | If it now works, add the following to your <filename>~/.xinitrc</filename>:
|
---|
| 575 | <phrase revision="sysv">
|
---|
| 576 | <literal>pulseaudio --verbose --log-target=syslog&</literal></phrase>
|
---|
| 577 | <phrase revision="systemd">
|
---|
| 578 | <literal>pulseaudio --verbose --log-target=journald&</literal></phrase>
|
---|
| 579 | (unfortunately, on some systems this does not work).
|
---|
| 580 | </para>
|
---|
| 581 |
|
---|
| 582 | <para>
|
---|
| 583 | You may wish to use multiple profiles within firefox. To do that, invoke
|
---|
| 584 | firefox as <command>firefox --ProfileManager</command>. You can also
|
---|
| 585 | check which profile is currently in use from
|
---|
| 586 | <command>about:profiles</command>.
|
---|
| 587 | </para>
|
---|
| 588 |
|
---|
[d5d7cd6] | 589 | <para>
|
---|
| 590 | Although WebRender (using the GPU for compositing) is not used by
|
---|
| 591 | default, it now appears to work well on supported hardware (ATI, Nvidia
|
---|
| 592 | and Intel GPUs with Mesa-18 or later. For an explanation, please see
|
---|
| 593 | <ulink
|
---|
| 594 | url="https://hacks.mozilla.org/2017/10/the-whole-web-at-maximum-fps-how-webrender-gets-rid-of-jank/">hacks.mozilla.org</ulink>.
|
---|
| 595 | The only downside seems to be that on a machine with limited RAM it might
|
---|
| 596 | use more RAM.
|
---|
| 597 | </para>
|
---|
| 598 |
|
---|
| 599 | <para>
|
---|
| 600 | To check if WebRender is being used, look in about:support. In the Graphics
|
---|
| 601 | section Compositing will either show 'Basic' (i.e. not in use) or
|
---|
| 602 | 'WebRender'. To enable it, go to about:config and change gfx.webrender.all
|
---|
| 603 | to True. You will need to restart firefox.
|
---|
| 604 | </para>
|
---|
| 605 |
|
---|
| 606 | <para>
|
---|
| 607 | It may be useful to mention the processes from firefox which can appear in
|
---|
| 608 | <command>top</command> - as well as firefox itself, there may be multiple
|
---|
| 609 | Web Content processes, and now an RDD Process (Remote Data Decoder) which
|
---|
| 610 | appears when playing web videos encoded with av1 (libdav1d). If WebRender
|
---|
| 611 | has been enabled, a GPU Process will also appear when firefox has to
|
---|
| 612 | repaint (e.g. scrolling, opening a new tab, or playing a video).
|
---|
| 613 | </para>
|
---|
| 614 |
|
---|
[326f830] | 615 | </sect3>
|
---|
[88cec02] | 616 | </sect2>
|
---|
| 617 |
|
---|
[b81991e1] | 618 | <sect2 role="content">
|
---|
| 619 | <title>Contents</title>
|
---|
| 620 |
|
---|
| 621 | <segmentedlist>
|
---|
| 622 | <segtitle>Installed Programs</segtitle>
|
---|
| 623 | <segtitle>Installed Libraries</segtitle>
|
---|
[c5f005b] | 624 | <segtitle>Installed Directory</segtitle>
|
---|
[b81991e1] | 625 |
|
---|
| 626 | <seglistitem>
|
---|
[0e37869] | 627 | <seg>
|
---|
| 628 | firefox
|
---|
| 629 | </seg>
|
---|
[c1ae13c] | 630 | <seg>
|
---|
| 631 | Numerous libraries, browser components, plugins, extensions, and
|
---|
[8d0bc761] | 632 | helper modules installed in /usr/lib/firefox
|
---|
[c1ae13c] | 633 | </seg>
|
---|
[7498751] | 634 | <seg>
|
---|
[54814bdd] | 635 | /usr/lib/firefox and /usr/lib/mozilla
|
---|
[7498751] | 636 | </seg>
|
---|
[b81991e1] | 637 | </seglistitem>
|
---|
| 638 | </segmentedlist>
|
---|
| 639 |
|
---|
| 640 | <variablelist>
|
---|
| 641 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 642 | <?dbfo list-presentation="list"?>
|
---|
| 643 | <?dbhtml list-presentation="table"?>
|
---|
| 644 |
|
---|
| 645 | <varlistentry id="firefox-prog">
|
---|
| 646 | <term><command>firefox</command></term>
|
---|
| 647 | <listitem>
|
---|
[c1ae13c] | 648 | <para>
|
---|
[7e1afc9] | 649 | is a <application>GTK+-3</application> internet browser that uses
|
---|
[4c24eb0a] | 650 | the Mozilla Gecko rendering engine
|
---|
[c1ae13c] | 651 | </para>
|
---|
[b81991e1] | 652 | <indexterm zone="firefox firefox-prog">
|
---|
| 653 | <primary sortas="b-firefox">firefox</primary>
|
---|
| 654 | </indexterm>
|
---|
| 655 | </listitem>
|
---|
| 656 | </varlistentry>
|
---|
[0e37869] | 657 |
|
---|
[b81991e1] | 658 | </variablelist>
|
---|
[0e37869] | 659 |
|
---|
[b81991e1] | 660 | </sect2>
|
---|
[0e37869] | 661 |
|
---|
[4d37129] | 662 | </sect1>
|
---|