source: xsoft/graphweb/firefox.xml@ 44cf4d8

10.0 10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 44cf4d8 was 44cf4d8, checked in by Ken Moffat <ken@…>, 15 months ago


git-svn-id: svn:// af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 23.1 KB
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
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 "4dc7a90a92f9a82ff149bc5581d327b9">
10 <!ENTITY firefox-size "318 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 "4.9 GB (184 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 "32 SBU (on a 4-core machine) without tests">
20<sect1 id="firefox" xreflabel="Firefox-&firefox-version;">
21 <?dbhtml filename="firefox.html" ?>
23 <sect1info>
24 <othername>$LastChangedBy$</othername>
25 <date>$Date$</date>
26 </sect1info>
28 <title>Firefox-&firefox-version;</title>
30 <indexterm zone="firefox">
31 <primary sortas="a-Firefox">Firefox</primary>
32 </indexterm>
34 <sect2 role="package">
35 <title>Introduction to Firefox</title>
37 <para>
38 <application>Firefox</application> is a stand-alone browser based on the
39 <application>Mozilla</application> codebase.
40 </para>
42 &lfs91_checked;
44 <bridgehead renderas="sect3">Package Information</bridgehead>
45 <itemizedlist spacing="compact">
46 <listitem>
47 <para>
48 Download (HTTP): <ulink url="&firefox-download-http;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download (FTP): <ulink url="&firefox-download-ftp;"/>
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download MD5 sum: &firefox-md5sum;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Download size: &firefox-size;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated disk space required: &firefox-buildsize;
69 </para>
70 </listitem>
71 <listitem>
72 <para>
73 Estimated build time: &firefox-time;
74 </para>
75 </listitem>
76 </itemizedlist>
78 <note>
79 <para>
80 The directory name is firefox-&firefox-version;
81 </para>
83 <para>
84 Extracting the tarball
85 will reset the permissions of the current directory to 0755 if you
86 have permission to do that. If you do this in a directory where
87 the sticky bit is set, such
88 as <filename class="directory">/tmp</filename> it will end with error
89 messages:
90 </para>
92<literallayout>tar: .: Cannot utime: Operation not permitted
93tar: .: Cannot change mode to rwxr-xr-t: Operation not permitted
94tar: Exiting with failure status due to previous errors
97 <para>
98 This does finish with non-zero status, but it does
99 <emphasis>NOT</emphasis> mean there is a real problem.
100 Do not untar as the <systemitem class="username">root</systemitem> user
101 in a directory where the sticky bit is set - that will unset it.
102 </para>
104 <para>
105 As with other large packages which use C++ (or rust), the SBU times
106 to build this vary more widely than you might expect. The build times
107 will increase significantly if your machine has to swap.
108 </para>
110 <!-- commented, by 78.0 it seems to work reliably
111 <para>
112 The mach build system (Python scripts) can be somewhat unreliable: if
113 the build fails and reports an Error, it can still return a status of
114 success, causing a scripted build to try to install (which does not rerun
115 the build), fail during the preparations for installing, but still exit
116 with a status of success. Also, on occasion it may limit itself to only
117 running one set of jobs - that will make the build take about 3 times as
118 long as running with four sets of jobs.
119 </para>-->
121 <para>
122 Although upstream prefer to use <application>PulseAudio</application>,
123 for the moment <application>Alsa</application> can still be used. Both
124 may need runtime configuration to get sound working.
125 </para>
126 </note>
128 <bridgehead renderas="sect3">Firefox Dependencies</bridgehead>
130 <bridgehead renderas="sect4">Required</bridgehead>
131 <para role="required">
132 <xref linkend="autoconf213"/>,
133 <xref linkend="cbindgen"/>,
134 <xref linkend="dbus-glib"/>,
135 both <xref linkend="gtk3"/> and
136 <xref linkend="gtk2"/>,
137 <xref linkend="libnotify"/>,
138 <xref linkend="nodejs"/>,
139 <xref linkend="nss"/>,
140 <xref linkend="pulseaudio"/>
141 (or
142 <xref linkend="alsa-lib"/> if you edit the mozconfig;
143 now deprecated by mozilla), in either case please read the
144 Configuration Information,
145 <!-- rustc is required by cbindgen so not needed here
146 <xref linkend="rust"/>,-->
147 <xref linkend="python3"/> (rebuilt after installing <xref linkend="sqlite"/>),
148 <xref linkend="startup-notification"/>,
149 <xref linkend="unzip"/>,
150 <xref linkend="yasm"/>, and
151 <xref linkend="zip"/>
152 </para>
154 <bridgehead renderas="sect4">Recommended</bridgehead>
155 <para role="recommended">
156 <xref linkend="icu"/>,
157 <xref linkend="libevent"/>,
158 <xref linkend="libwebp"/>,
159 <xref linkend="nasm"/>
160 </para>
162 <note>
163 <para>
164 If you don't install recommended dependencies, then internal copies of
165 those packages will be used. They might be tested to work, but they can
166 be out of date or contain security holes.
167 </para>
168 </note>
170 <bridgehead renderas="sect4">Optional</bridgehead>
171 <para role="optional">
172 <xref linkend="curl"/>,
173 <xref linkend="doxygen"/>,
174 <xref role="runtime" linkend="ffmpeg"/> (runtime, to play mov, mp3 or mp4 files),
175 <!-- <phrase revision="sysv"><ulink url="">liboauth</ulink></phrase> -->
176 <xref linkend="liboauth"/>,
177 <xref linkend="openjdk"/>,
178 <xref linkend="valgrind"/>,
179 <xref linkend="wget"/>,
180 <xref linkend="wireless_tools"/>,
181 <ulink url="">libproxy</ulink>
182 </para>
184 <para condition="html" role="usernotes">
185 User Notes: <ulink url="&blfs-wiki;/firefox"/>
186 </para>
187 </sect2>
189 <sect2 role="installation">
190 <title>Installation of Firefox</title>
192 <para>
193 The configuration of <application>Firefox</application> is accomplished
194 by creating a <filename>mozconfig</filename> file containing the desired
195 configuration options. A default <filename>mozconfig</filename> is
196 created below. To see the entire list of available configuration options
197 (and an abbreviated description of some of them), issue <command>./mach
198 configure &amp;&amp; ./configure --help | less</command>. You may also
199 wish to review the entire file and uncomment any other desired options.
200 Create the file by issuing the following command:
201 </para>
203<screen><userinput>cat &gt; mozconfig &lt;&lt; "EOF"
204<literal># If you have a multicore machine, all cores will be used by default.
206# If you have installed (or will install) wireless-tools, and you wish
207# to use geolocation web services, comment out this line
208ac_add_options --disable-necko-wifi
210# API Keys for geolocation APIs - necko-wifi (above) is required for MLS
211# Uncomment the following line if you wish to use Mozilla Location Service
212#ac_add_options --with-mozilla-api-keyfile=$PWD/mozilla-key
214# Uncomment the following line if you wish to use Google's geolocaton API
215# (needed for use with saved maps with Google Maps)
216#ac_add_options --with-google-location-service-api-keyfile=$PWD/google-key
218# startup-notification is required since firefox-78
220# Uncomment the following option if you have not installed PulseAudio
221#ac_add_options --disable-pulseaudio
222# or uncomment this if you installed alsa-lib instead of PulseAudio
223#ac_add_options --enable-alsa
225# Comment out following options if you have not installed
226# recommended dependencies:
227ac_add_options --with-system-libevent
228ac_add_options --with-system-webp
229ac_add_options --with-system-nspr
230ac_add_options --with-system-nss
231ac_add_options --with-system-icu
233# Do not specify the gold linker which is not the default. It will take
234# longer and use more disk space when debug symbols are disabled.
236# libdavid (av1 decoder) requires nasm. Uncomment this if nasm
237# has not been installed.
238#ac_add_options --disable-av1
240# You cannot distribute the binary if you do this
241ac_add_options --enable-official-branding
243# Stripping is now enabled by default.
244# Uncomment these lines if you need to run a debugger:
245#ac_add_options --disable-strip
246#ac_add_options --disable-install-strip
248# Disabling debug symbols makes the build much smaller and a little
249# faster. Comment this if you need to run a debugger. Note: This is
250# required for compilation on i686.
251ac_add_options --disable-debug-symbols
253# The elf-hack is reported to cause failed installs (after successful builds)
254# on some machines. It is supposed to improve startup time and it shrinks
255# by a few MB - comment this if you know your machine is not affected.
256ac_add_options --disable-elf-hack
258# The BLFS editors recommend not changing anything below this line:
259ac_add_options --prefix=/usr
260ac_add_options --enable-application=browser
261ac_add_options --disable-crashreporter
262ac_add_options --disable-updater
263# enabling the tests will use a lot more space and significantly
264# increase the build time, for no obvious benefit.
265ac_add_options --disable-tests
267# The default level of optimization again produces a working build with gcc.
268ac_add_options --enable-optimize
270ac_add_options --enable-system-ffi
271ac_add_options --enable-system-pixman
273# --with-system-bz2 was removed in firefox-78
274ac_add_options --with-system-jpeg
275ac_add_options --with-system-png
276ac_add_options --with-system-zlib
278# The following option unsets Telemetry Reporting. With the Addons Fiasco,
279# Mozilla was found to be collecting user's data, including saved passwords and
280# web form data, without users consent. Mozilla was also found shipping updates
281# to systems without the user's knowledge or permission.
282# As a result of this, use the following command to permanently disable
283# telemetry reporting in Firefox.
286mk_add_options MOZ_OBJDIR=@TOPSRCDIR@/firefox-build-dir</literal>
289 <para>
290 Compile <application>Firefox</application> by issuing the following
291 commands:
292 </para>
294 <para>
295 In the esr version of firefox-78, the code to ensure that add-ons
296 are signed by the trused root has been disabled, presumably for
297 organizations which require their own add-ons. To enable it as an
298 added security measure issue the following command:
299 </para>
301<screen><userinput>sed -i -e 's/Disable/Enable/' \
302 -e '/^MOZ_REQUIRE_SIGNING/s/0/1/' \
303 build/mozconfig.common</userinput></screen>
305 <para>
306 If the geolocation APIs are needed:
307 </para>
309 <note>
310 <para>
311 <!-- Taken from Arch Linux - an immensely helpful link - Thanks -->
312 The Google and Mozilla API Keys below are specific to LFS. If using
313 these instructions for another distro, or if you intend to distribute
314 binary copies of the software using these instructions, please obtain
315 your own keys following the instructions located at
316 <ulink url=""/> and
317 <ulink url=""/> respectively.
318 <!-- BLFS Devs, register an account at Google with your
319 email address, and I'll make you an administrator
320 for the 'Google APIs for LFS' project (where the API and OAuth keys
321 were created for use in the book).-->
322 </para>
323 </note>
325<screen><userinput>echo "AIzaSyDxKL42zsPjbke5O8_rPVpVrLrJ8aeE9rQ" > google-key
326echo "613364a7-9418-4c86-bcee-57e32fd70c23" > mozilla-key</userinput></screen>
328 <note>
330 <xi:include xmlns:xi=""
331 href="../../xincludes/mozshm.xml"/>
333 <xi:include xmlns:xi=""
334 href="../../xincludes/mozmach.xml"/>
336 </note>
337 <!--
338 <para>
339 If you are building on i686, apply a fix to prevent Internal Compiler
340 Errors in GCC-7+:
341 </para>
343<screen><userinput remap="pre">case $(uname -m) in
344 i?86) sed -i "562 s/mips64/i386/" gfx/skia/skia/third_party/skcms/src/Transform_inl.h ;;
346 -->
348 <para>
349 Now invoke the Python script to compile the package.
350 </para>
352<screen><userinput>export CC=gcc CXX=g++ &amp;&amp;
353export MOZBUILD_STATE_PATH=${PWD}/mozbuild &amp;&amp;
354./mach build</userinput></screen>
356 <para>
357 The <filename>mozconfig</filename> above disables the tests because
358 they use a lot more time and disk space for no obvious benefit. If
359 you have nevertheless enabled them, you can run the tests by executing
360 <command>./mach gtest</command>. This will require a network connection,
361 and to be run from within an Xorg session - there is a popup dialog
362 when it fails to connect to ALSA (that does not create a failed test).
363 One or two tests will fail. To see the details of the failure(s) you
364 will need to log the output from that command so that you can review it.
365 </para>
367 <para>
368 Now, as the <systemitem class="username">root</systemitem> user:
369 </para>
371<screen role="root"><userinput>./mach install &amp;&amp;
373mkdir -pv /usr/lib/mozilla/plugins &amp;&amp;
374ln -sfv ../../mozilla/plugins /usr/lib/firefox/browser/</userinput></screen>
376 <para>
377 Set environment variables back to their values:
378 </para>
380<screen><userinput>unset CC CXX MOZBUILD_STATE_PATH</userinput></screen>
382 </sect2>
384 <sect2 role="commands">
385 <title>Command Explanations</title>
387<!--<xi:include xmlns:xi=""
388 href="../../xincludes/SIOCGSTAMP.xml"/>-->
390 <para>
391 <command>export CC=gcc CXX=g++ ...</command>: Upstream now prefer
392 <application>clang</application> so that they can use one compiler
393 everywhere. On the X86 architectures <application>clang</application>
394 now appears to support the same security-hardening options as
395 <application>GCC</application>. With the current versions,
396 <application>GCC</application> creates a marginally bigger build but
397 takes typically 2 SBU less time on a 4-core machine using the mozconfig
398 above.
399 </para>
401 <para>
402 <command>export MOZBUILD_STATE_PATH=${PWD}/mozbuild</command>: The build
403 is now supposed to tell you that it intends to create <filename
404 class="directory">~/.mozbuild</filename>, and offer you an option to
405 press &lt;ENTER&gt; to accept this, or Ctrl-C to cancel and restart the
406 build after specifying the directory. In practice, the message may not
407 appear until after &lt;ENTER&gt; is keyed, i.e. the build stalls.
408 </para>
410 <para>
411 That directory is used for a (probably random) telemetry identifier.
412 Creating this in the build directory, and deleting that after the
413 installation, prevents it being used. If you wish to participate in
414 telemetry, export MOZBUILD_STATE_PATH to point to its default directory.
415 </para>
417 <para>
418 <command>./mach build</command>: <application>Firefox</application>
419 now uses this <application>python</application> script to run the
420 build and install.
421 </para>
423 <para>
424 <option>./mach build --verbose</option>: Use this alternative if you
425 need details of which files are being compiled, together with any C or
426 C++ flags being used. But do not add '--verbose' to the install command,
427 it is not accepted there.
428 </para>
430 <para>
431 <option>./mach build -jN</option>: The build should, by default, use
432 all the online CPU cores. If using all the cores causes the build to swap
433 because you have insufficient memory, using fewer cores can be faster.
434 </para>
436 <para>
437 <command>mkdir -pv /usr/lib/mozilla/plugins</command>: This ensures
438 that <filename class="directory">/usr/lib/mozilla/plugins/</filename>
439 exists.
440 </para>
442 <para>
443 <command>ln -sv ... /usr/lib/firefox/browser</command>:
444 This command creates a symbolic link to <filename
445 class="directory">/usr/lib/mozilla/plugins</filename>. It's not really
446 needed, as <application>Firefox</application> checks <filename
447 class="directory">/usr/lib/mozilla/plugins</filename> by default, but the
448 symbolic link is made to keep all the plugins installed in one folder.
449 </para>
451 </sect2>
453 <sect2 role="configuration">
454 <title>Configuring Firefox</title>
456 <para>
457 If you use a desktop environment like <application>Gnome</application> or
458 <application>KDE</application> you may like to create a
459 <filename>firefox.desktop</filename> file so that
460 <application>Firefox</application> appears in the panel's menus. If you
461 didn't enable startup-notification in your mozconfig change the
462 StartupNotify line to false. As the
463 <systemitem class="username">root</systemitem> user:
464 </para>
466<screen role="root"><userinput>mkdir -pv /usr/share/applications &amp;&amp;
467mkdir -pv /usr/share/pixmaps &amp;&amp;
469cat &gt; /usr/share/applications/firefox.desktop &lt;&lt; "EOF" &amp;&amp;
470<literal>[Desktop Entry]
472Name=Firefox Web Browser
473Comment=Browse the World Wide Web
474GenericName=Web Browser
475Exec=firefox %u
484ln -sfv /usr/lib/firefox/browser/chrome/icons/default/default128.png \
485 /usr/share/pixmaps/firefox.png</userinput></screen>
487 <sect3><title>Configuration Information</title>
489 <para>
490 The application settings for firefox are accessible by keying
491 <command>about:config</command> in the address bar.
492 </para>
494 <para>
495 Occasionally, getting working sound in
496 <application>firefox</application> can be a problem. Although upstream
497 prefers pulseaudio,
498 on balance using <application>Alsa</application> may be easier.
499 </para>
501 <para>
502 If you enabled <application>Alsa</application> for sound, you may need
503 to alter one variable to get working sound. If you run
504 <command>firefox</command> from a term and try to play something with
505 sound you might encounter error messages like:
506 </para>
508 <para>
509 <literal>Sandbox: seccomp sandbox violation: pid 3941, tid 4030,
510 syscall 16, args 48 2147767296 139909894784796 0 0 0.</literal>
511 </para>
513 <para>
514 That was on x86_64, on i686 the syscall number is 54. To allow this
515 syscall, in <command>about:config</command> change
516 <command>security.sandbox.content.syscall_whitelist</command> to 16
517 (or 54 if using i686).
518 </para>
520 <para>
521 If you use <command>pulseaudio</command> in a Desktop Environment, it
522 might already be started by that DE. But if it is not, although
523 firefox-57 managed to start it, firefox-58 did not. If you run
524 <command>firefox</command> from a term and this problem is present,
525 trying to play sound will
526 encounter error messages warning <literal>Can't get cubeb
527 context!</literal>
528 </para>
530 <para>
531 The fix for this is to close firefox, start pulseaudio to check it
532 does start (if not, read the information on Configuring in <xref
533 linkend="pulseaudio"/>) and restart firefox to check it is working.
534 If it now works, add the following to your <filename>~/.xinitrc</filename>:
535<phrase revision="sysv">
536<literal>pulseaudio --verbose --log-target=syslog&amp;</literal></phrase>
537<phrase revision="systemd">
538<literal>pulseaudio --verbose --log-target=journald&amp;</literal></phrase>
539 (unfortunately, on some systems this does not work).
540 </para>
542 <para>
543 You may wish to use multiple profiles within firefox. To do that, invoke
544 firefox as <command>firefox --ProfileManager</command>. You can also
545 check which profile is currently in use from
546 <command>about:profiles</command>.
547 </para>
549 <para>
550 Although WebRender (using the GPU for compositing) is not used by
551 default, it now appears to work well on supported hardware (ATI, Nvidia
552 and Intel GPUs with Mesa-18 or later. For an explanation, please see
553 <ulink
554 url=""></ulink>.
555 The only downside seems to be that on a machine with limited RAM it might
556 use more RAM.
557 </para>
559 <para>
560 To check if WebRender is being used, look in about:support. In the Graphics
561 section Compositing will either show 'Basic' (i.e. not in use) or
562 'WebRender'. To enable it, go to about:config and change gfx.webrender.all
563 to True. You will need to restart firefox.
564 </para>
566 <para>
567 It may be useful to mention the processes from firefox which can appear in
568 <command>top</command> - as well as firefox itself, there may be multiple
569 Web Content processes, and now an RDD Process (Remote Data Decoder) which
570 appears when playing web videos encoded with av1 (libdav1d). If WebRender
571 has been enabled, a GPU Process will also appear when firefox has to
572 repaint (e.g. scrolling, opening a new tab, or playing a video).
573 </para>
575 </sect3>
576 </sect2>
578 <sect2 role="content">
579 <title>Contents</title>
581 <segmentedlist>
582 <segtitle>Installed Programs</segtitle>
583 <segtitle>Installed Libraries</segtitle>
584 <segtitle>Installed Directory</segtitle>
586 <seglistitem>
587 <seg>
588 firefox
589 </seg>
590 <seg>
591 Numerous libraries, browser components, plugins, extensions, and
592 helper modules installed in /usr/lib/firefox
593 </seg>
594 <seg>
595 /usr/lib/firefox and /usr/lib/mozilla
596 </seg>
597 </seglistitem>
598 </segmentedlist>
600 <variablelist>
601 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
602 <?dbfo list-presentation="list"?>
603 <?dbhtml list-presentation="table"?>
605 <varlistentry id="firefox-prog">
606 <term><command>firefox</command></term>
607 <listitem>
608 <para>
609 is a <application>GTK+-3</application> internet browser that uses
610 the Mozilla Gecko rendering engine.
611 </para>
612 <indexterm zone="firefox firefox-prog">
613 <primary sortas="b-firefox">firefox</primary>
614 </indexterm>
615 </listitem>
616 </varlistentry>
618 </variablelist>
620 </sect2>
Note: See TracBrowser for help on using the repository browser.