source: xsoft/graphweb/firefox.xml@ af32bfa2

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

firefox-68.4.0.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@22552 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 23.7 KB
Line 
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 "1e986d29cb501e870308f59b45b31422">
10 <!ENTITY firefox-size "307 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.3 GB (166 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 "24 SBU (with parallelism=4) without tests">
18]>
19
20<sect1 id="firefox" xreflabel="Firefox-&firefox-version;">
21 <?dbhtml filename="firefox.html" ?>
22
23 <sect1info>
24 <othername>$LastChangedBy$</othername>
25 <date>$Date$</date>
26 </sect1info>
27
28 <title>Firefox-&firefox-version;</title>
29
30 <indexterm zone="firefox">
31 <primary sortas="a-Firefox">Firefox</primary>
32 </indexterm>
33
34 <sect2 role="package">
35 <title>Introduction to Firefox</title>
36
37 <para>
38 <application>Firefox</application> is a stand-alone browser based on the
39 <application>Mozilla</application> codebase.
40 </para>
41
42 &lfs90_checked;
43
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>
77
78 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
79 <itemizedlist spacing="compact">
80 <listitem>
81 <para>
82 Optional patch to allow system versions of <xref linkend="graphite2"/>
83 and <xref linkend="harfbuzz"/>:
84 <ulink url="&patch-root;/firefox-&firefox-version;esr-system_graphite2_harfbuzz-1.patch"/>
85 </para>
86 </listitem>
87 </itemizedlist>
88
89 <note>
90 <para>
91 The directory name is firefox-&firefox-version;
92 </para>
93
94 <para>
95 Extracting the tarball
96 will reset the permissions of the current directory to 0755 if you
97 have permission to do that. If you do this in a directory where
98 the sticky bit is set, such
99 as <filename class="directory">/tmp</filename> it will end with error
100 messages:
101 </para>
102
103<literallayout>tar: .: Cannot utime: Operation not permitted
104tar: .: Cannot change mode to rwxr-xr-t: Operation not permitted
105tar: Exiting with failure status due to previous errors
106</literallayout>
107
108 <para>
109 This does finish with non-zero status, but it does
110 <emphasis>NOT</emphasis> mean there is a real problem.
111 Do not untar as the <systemitem class="username">root</systemitem> user
112 in a directory where the sticky bit is set - that will unset it.
113 </para>
114
115 <para>
116 As with other large packages which use C++ (or rust), the SBU times
117 to build this vary more widely than you might expect. Also, 6GB
118 of real memory is used during the final link and the SBUs can increase
119 significantly if the machine has to swap.
120 </para>
121
122 <para>
123 The mach build system (Python scripts) can be somewhat unreliable: if
124 the build fails and reports an Error, it can still return a status of
125 success, causing a scripted build to try to install (which does not rerun
126 the build), fail during the preparations for installing, but still exit
127 with a status of success. Also, on occasion it may limit itself to only
128 running one set of jobs - that will make the build take about 3 times as
129 long as running with four sets of jobs.
130 </para>
131
132 <para>
133 Although upstream prefer to use <application>PulseAudio</application>,
134 for the moment <application>Alsa</application> can still be used. Both
135 may need runtime configuration to get sound working.
136 </para>
137 </note>
138
139 <bridgehead renderas="sect3">Firefox Dependencies</bridgehead>
140
141 <bridgehead renderas="sect4">Required</bridgehead>
142 <para role="required">
143 <xref linkend="autoconf213"/>,
144 <xref linkend="cbindgen"/>,
145 <!-- with ff-69.0 the configure system was happy to continue to disable
146 dbus-glib, but linking libxul.so failed because rust code uses it, so
147 make it required and remove from mozconfig : ken -->
148 <xref linkend="dbus-glib"/>,
149 both <xref linkend="gtk3"/> and
150 <xref linkend="gtk2"/>,
151 <xref linkend="libnotify"/>,
152 <xref linkend="nodejs"/>,
153 <xref linkend="nss"/>,
154 <xref linkend="pulseaudio"/>
155 (or
156 <xref linkend="alsa-lib"/> if you edit the mozconfig;
157 now deprecated by mozilla), in either case please read the
158 Configuration Information,
159 <xref linkend="rust"/>,
160 <xref linkend="unzip"/>,
161 <xref linkend="yasm"/>, and
162 <xref linkend="zip"/>
163 </para>
164
165 <bridgehead renderas="sect4">Recommended</bridgehead>
166 <para role="recommended">
167 <xref linkend="icu"/>,
168 <xref linkend="libevent"/>,
169<!-- fails to build in 65.0 (headers changed)
170 <xref linkend="libvpx"/>, -->
171 <xref linkend="libwebp"/>,
172 <xref linkend="nasm"/>, and
173 <xref linkend="sqlite"/>
174 </para>
175
176 <note>
177 <para>
178 If you don't install recommended dependencies, then internal copies of
179 those packages will be used. They might be tested to work, but they can
180 be out of date or contain security holes.
181 </para>
182 </note>
183
184 <bridgehead renderas="sect4">Optional</bridgehead>
185 <para role="optional">
186 <xref linkend="curl"/>,
187 <xref linkend="doxygen"/>,
188 <xref role="runtime" linkend="ffmpeg"/> (runtime, to play mov, mp3 or mp4 files),
189 <!-- <phrase revision="sysv"><ulink url="http://sourceforge.net/projects/liboauth/files/">liboauth</ulink></phrase> -->
190 <xref linkend="liboauth"/>,
191 <xref linkend="openjdk"/>,
192 <xref linkend="startup-notification"/>,
193 <xref linkend="valgrind"/>,
194 <xref linkend="wget"/>,
195 <xref linkend="wireless_tools"/>,
196 <ulink url="https://github.com/libproxy/libproxy">libproxy</ulink>,
197 and (with the patch)
198 <xref linkend="graphite2"/> and
199 <xref linkend="harfbuzz"/>
200 </para>
201
202 <para condition="html" role="usernotes">
203 User Notes: <ulink url="&blfs-wiki;/firefox"/>
204 </para>
205 </sect2>
206
207 <sect2 role="installation">
208 <title>Installation of Firefox</title>
209
210 <para>
211 The configuration of <application>Firefox</application> is accomplished
212 by creating a <filename>mozconfig</filename> file containing the desired
213 configuration options. A default <filename>mozconfig</filename> is
214 created below. To see the entire list of available configuration options
215 (and an abbreviated description of some of them), issue <command>./mach
216 configure &amp;&amp; ./configure --help | less</command>. You may also
217 wish to review the entire file and uncomment any other desired options.
218 Create the file by issuing the following command:
219 </para>
220
221<screen><userinput>cat &gt; mozconfig &lt;&lt; "EOF"
222<literal># If you have a multicore machine, all cores will be used by default.
223
224# If you have installed (or will install) wireless-tools, and you wish
225# to use geolocation web services, comment out this line
226ac_add_options --disable-necko-wifi
227
228# API Keys for geolocation APIs - necko-wifi (above) is required for MLS
229# Uncomment the following line if you wish to use Mozilla Location Service
230#ac_add_options --with-mozilla-api-keyfile=$PWD/mozilla-key
231
232# Uncomment the following line if you wish to use Google's geolocaton API
233# (needed for use with saved maps with Google Maps)
234#ac_add_options --with-google-location-service-api-keyfile=$PWD/google-key
235
236# Uncomment this line if you have installed startup-notification:
237#ac_add_options --enable-startup-notification
238
239# Uncomment the following option if you have not installed PulseAudio
240#ac_add_options --disable-pulseaudio
241# or uncomment this if you installed alsa-lib instead of PulseAudio
242#ac_add_options --enable-alsa
243
244# Comment out following options if you have not installed
245# recommended dependencies:
246ac_add_options --enable-system-sqlite
247ac_add_options --with-system-libevent
248# firefox-65 understands webp and ships with an included copy
249ac_add_options --with-system-webp
250ac_add_options --with-system-nspr
251ac_add_options --with-system-nss
252ac_add_options --with-system-icu
253
254# Do not specify the gold linker which is not the default. It will take
255# longer and use more disk space when debug symbols are disabled.
256
257# libdavid (av1 decoder) requires nasm. Uncomment this if nasm
258# has not been installed.
259#ac_add_options --disable-av1
260
261# You cannot distribute the binary if you do this
262ac_add_options --enable-official-branding
263
264# If you are going to apply the patch for system graphite
265# and system harfbuzz, uncomment these lines:
266#ac_add_options --with-system-graphite2
267#ac_add_options --with-system-harfbuzz
268
269# Stripping is now enabled by default.
270# Uncomment these lines if you need to run a debugger:
271#ac_add_options --disable-strip
272#ac_add_options --disable-install-strip
273
274# Disabling debug symbols makes the build much smaller and a little
275# faster. Comment this if you need to run a debugger. Note: This is
276# required for compilation on i686.
277ac_add_options --disable-debug-symbols
278
279# The BLFS editors recommend not changing anything below this line:
280ac_add_options --prefix=/usr
281ac_add_options --enable-application=browser
282
283# The elf-hack is reported to cause failed installs (after successful builds)
284# on some machines. It is supposed to improve startup time and it shrinks
285# libxul.so by a few MB - comment this if you know your machine is not affected.
286ac_add_options --disable-elf-hack
287
288ac_add_options --disable-crashreporter
289ac_add_options --disable-updater
290# enabling the tests will use a lot more space and significantly
291# increase the build time, for no obvious benefit.
292ac_add_options --disable-tests
293
294# The default level of optimization again produces a working build with gcc.
295ac_add_options --enable-optimize
296
297# From firefox-61 system cairo is not supported
298
299ac_add_options --enable-system-ffi
300ac_add_options --enable-system-pixman
301
302# From firefox-62 --with-pthreads is not recognized
303
304ac_add_options --with-system-bz2
305ac_add_options --with-system-jpeg
306ac_add_options --with-system-png
307ac_add_options --with-system-zlib
308
309# The following option unsets Telemetry Reporting. With the Addons Fiasco,
310# Mozilla was found to be collecting user's data, including saved passwords and
311# web form data, without users consent. Mozilla was also found shipping updates
312# to systems without the user's knowledge or permission.
313# As a result of this, use the following command to permanently disable
314# telemetry reporting in Firefox.
315unset MOZ_TELEMETRY_REPORTING
316
317mk_add_options MOZ_OBJDIR=@TOPSRCDIR@/firefox-build-dir</literal>
318EOF</userinput></screen>
319
320 <para>
321 Compile <application>Firefox</application> by issuing the following
322 commands:
323 </para>
324
325 <para>
326 If you have installed system versions of graphite2 and harfbuzz and wish
327 firefox to use those instead of its shipped versions, apply the patch and
328 uncomment the appropriate entries in the <filename>mozconfig</filename>
329 file.
330 </para>
331
332<screen><userinput>patch -Np1 -i ../firefox-&firefox-version;esr-system_graphite2_harfbuzz-1.patch</userinput></screen>
333
334 <para>
335 If the geolocation APIs are needed:
336 </para>
337
338 <note>
339 <para>
340 <!-- Taken from Arch Linux - an immensely helpful link - Thanks -->
341 The Google and Mozilla API Keys below are specific to LFS. If using
342 these instructions for another distro, or if you intend to distribute
343 binary copies of the software using these instructions, please obtain
344 your own keys following the instructions located at
345 <ulink url="http://www.chromium.org/developers/how-tos/api-keys"/> and
346 <ulink url="https://location.services.mozilla.com/api"/> respectively.
347 <!-- BLFS Devs, register an account at Google with your
348 @linuxfromscratch.org email address, and I'll make you an administrator
349 for the 'Google APIs for LFS' project (where the API and OAuth keys
350 were created for use in the book).-->
351 </para>
352 </note>
353
354<screen><userinput>echo "AIzaSyDxKL42zsPjbke5O8_rPVpVrLrJ8aeE9rQ" > google-key
355echo "d2284a20-0505-4927-a809-7ffaf4d91e55" > mozilla-key</userinput></screen>
356
357 <note><para>
358 If you are compiling <application>Firefox</application> in chroot, make
359 sure you have <envar>$SHELL</envar> environment variable set or prepend
360 <envar>SHELL=/bin/sh</envar>. Also ensure that <filename>/dev/shm</filename>
361 is mounted.
362 </para></note>
363 <!--
364 <para>
365 If you are building on i686, apply a fix to prevent Internal Compiler
366 Errors in GCC-7+:
367 </para>
368
369<screen><userinput remap="pre">case $(uname -m) in
370 i?86) sed -i "562 s/mips64/i386/" gfx/skia/skia/third_party/skcms/src/Transform_inl.h ;;
371esac</userinput></screen>
372 -->
373
374 <para>
375 Now invoke the Python2 script to compile the package.
376 </para>
377
378<screen><userinput>export CC=gcc CXX=g++ &amp;&amp;
379export MOZBUILD_STATE_PATH=${PWD}/mozbuild &amp;&amp;
380./mach build</userinput></screen>
381
382 <para>
383 The <filename>mozconfig</filename> above disables the tests because
384 they use a lot more time and disk space for no obvious benefit. If
385 you have nevertheless enabled them, you can run the tests by executing
386 <command>./mach gtest</command>. This will require a network connection,
387 and to be run from within an Xorg session - there is a popup dialog
388 when it fails to connect to ALSA (that does not create a failed test).
389 One or two tests will fail. To see the details of the failure(s) you
390 will need to log the output from that command so that you can review it.
391 </para>
392
393 <para>
394 Now, as the <systemitem class="username">root</systemitem> user:
395 </para>
396
397<screen role="root"><userinput>./mach install &amp;&amp;
398
399mkdir -pv /usr/lib/mozilla/plugins &amp;&amp;
400ln -sfv ../../mozilla/plugins /usr/lib/firefox/browser/</userinput></screen>
401
402 <para>
403 Set environment variables back to their values:
404 </para>
405
406<screen><userinput>unset CC CXX MOZBUILD_STATE_PATH</userinput></screen>
407
408 </sect2>
409
410 <sect2 role="commands">
411 <title>Command Explanations</title>
412
413<!--<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
414 href="../../xincludes/SIOCGSTAMP.xml"/>-->
415
416 <para>
417 <command>sed -e 's/checkImpl/checkFFImpl/g' ...</command>: Although the
418 package ships with a modified version of <application>ICU-63</application>
419 and only tests that the system version, if used, is at least 63, changes
420 from upstream 63 cause builds with the system version to fail with an error
421 message <literal>no void JSContext::checkImpl_63 member function</literal>.
422 The sed renames the local function. Upstream ICU-64 works around this.
423 </para>
424
425 <para>
426 <command>export CC=gcc CXX=g++ ...</command>: Upstream now prefer
427 <application>clang</application>, but gcc is a more secure compiler and
428 now produces reasonably-sized builds.
429 </para>
430
431 <para>
432 <command>export MOZBUILD_STATE_PATH=${PWD}/mozbuild</command>: The build
433 is now supposed to tell you that it intends to create <filename
434 class="directory">~/.mozbuild</filename>, and offer you an option to
435 press &lt;ENTER&gt; to accept this, or Ctrl-C to cancel and restart the
436 build after specifying the directory. In practice, the message may not
437 appear until after &lt;ENTER&gt; is keyed, i.e. the build stalls.
438 </para>
439
440 <para>
441 That directory is used for a (probably random) telemetry identifier.
442 Creating this in the build directory, and deleting that after the
443 installation, prevents it being used. If you wish to participate in
444 telemetry, export MOZBUILD_STATE_PATH to point to its default directory.
445 </para>
446
447 <para>
448 <command>./mach build</command>: <application>Firefox</application>
449 now uses this <application>python2</application> script to run the
450 build and install.
451 </para>
452
453 <para>
454 <option>./mach build --verbose</option>: Use this alternative if you
455 need details of which files are being compiled, together with any C or
456 C++ flags being used.
457 </para>
458
459 <para>
460 <option>./mach build -jN</option>: The build should, by default, use
461 all the online CPU cores. There are two reasons to specify the number
462 of cores, e.g. -j4 for 4 cores: First, if using all the cores causes
463 the build to swap because you have insufficient memory (e.g. for 4 cores
464 a build without system graphite2 and harfbuzz now uses towards 8GB
465 of RAM). In such cases, using fewer cores can be faster. Second, on some
466 machines the middle part of the build can drag on as if only one core is
467 present. In those cases, specifying the number of cores may speed up the
468 build.
469 </para>
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 <para>
487 <option>export CC=clang CXX=clang++ AR=llvm-ar NM=llvm-nm RANLIB=llvm-ranlib</option>:
488 Use this as an alternative to building with gcc and g++ if you wish to use
489 the clang toolchain. Remember to unset these variables after the build.
490 </para>
491
492 </sect2>
493
494 <sect2 role="configuration">
495 <title>Configuring Firefox</title>
496
497 <para>
498 If you use a desktop environment like <application>Gnome</application> or
499 <application>KDE</application> you may like to create a
500 <filename>firefox.desktop</filename> file so that
501 <application>Firefox</application> appears in the panel's menus. If you
502 didn't enable startup-notification in your mozconfig change the
503 StartupNotify line to false. As the
504 <systemitem class="username">root</systemitem> user:
505 </para>
506
507<screen role="root"><userinput>mkdir -pv /usr/share/applications &amp;&amp;
508mkdir -pv /usr/share/pixmaps &amp;&amp;
509
510cat &gt; /usr/share/applications/firefox.desktop &lt;&lt; "EOF" &amp;&amp;
511<literal>[Desktop Entry]
512Encoding=UTF-8
513Name=Firefox Web Browser
514Comment=Browse the World Wide Web
515GenericName=Web Browser
516Exec=firefox %u
517Terminal=false
518Type=Application
519Icon=firefox
520Categories=GNOME;GTK;Network;WebBrowser;
521MimeType=text/html;text/xml;application/xhtml+xml;application/vnd.mozilla.xul+xml;text/mml;x-scheme-handler/http;x-scheme-handler/https;
522StartupNotify=true</literal>
523EOF
524
525ln -sfv /usr/lib/firefox/browser/chrome/icons/default/default128.png \
526 /usr/share/pixmaps/firefox.png</userinput></screen>
527
528 <sect3><title>Configuration Information</title>
529
530 <para>
531 The application settings for firefox are accessible by keying
532 <command>about:config</command> in the address bar.
533 </para>
534
535 <para>
536 With this version of <application>firefox</application>, getting
537 working sound can be a problem. Although upstream prefers pulseaudio,
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
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
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&amp;</literal></phrase>
577<phrase revision="systemd">
578<literal>pulseaudio --verbose --log-target=journald&amp;</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
589 </sect3>
590 </sect2>
591
592 <sect2 role="content">
593 <title>Contents</title>
594
595 <segmentedlist>
596 <segtitle>Installed Programs</segtitle>
597 <segtitle>Installed Libraries</segtitle>
598 <segtitle>Installed Directory</segtitle>
599
600 <seglistitem>
601 <seg>
602 firefox
603 </seg>
604 <seg>
605 Numerous libraries, browser components, plugins, extensions, and
606 helper modules installed in /usr/lib/firefox
607 </seg>
608 <seg>
609 /usr/lib/firefox and /usr/lib/mozilla
610 </seg>
611 </seglistitem>
612 </segmentedlist>
613
614 <variablelist>
615 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
616 <?dbfo list-presentation="list"?>
617 <?dbhtml list-presentation="table"?>
618
619 <varlistentry id="firefox-prog">
620 <term><command>firefox</command></term>
621 <listitem>
622 <para>
623 is a <application>GTK+-3</application> internet browser that uses
624 the Mozilla Gecko rendering engine.
625 </para>
626 <indexterm zone="firefox firefox-prog">
627 <primary sortas="b-firefox">firefox</primary>
628 </indexterm>
629 </listitem>
630 </varlistentry>
631
632 </variablelist>
633
634 </sect2>
635
636</sect1>
Note: See TracBrowser for help on using the repository browser.