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