source: xsoft/graphweb/firefox.xml@ 1b0a207

10.0 10.1 11.0 9.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 1b0a207 was 1b0a207, checked in by Douglas R. Reno <renodr@…>, 3 years ago

Update to Firefox-66.0.5. This is a recommended update for all users of BLFS who have any previous versions installed, due to the Addons fiasco and forced telemetry which has been disabled with this version.

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

  • Property mode set to 100644
File size: 23.3 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;/source/firefox-&firefox-version;.source.tar.xz">
8 <!ENTITY firefox-download-ftp " ">
9 <!ENTITY firefox-md5sum "a3d00fb4e950558135f08a5155745d4e">
10 <!ENTITY firefox-size "269 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 "11.8 GB (156 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 (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 &lfs84_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;-system_graphite2_harfbuzz-1.patch"/>
85 </para>
86 </listitem>
87 </itemizedlist>
88
89 <note>
90 <para>
91 Extracting the tarball
92 will reset the permissions of the current directory to 0755 if you
93 have permission to do that. If you do this in a directory where
94 the sticky bit is set, such
95 as <filename class="directory">/tmp</filename> it will end with error
96 messages:
97 </para>
98
99<literallayout>tar: .: Cannot utime: Operation not permitted
100tar: .: Cannot change mode to rwxr-xr-t: Operation not permitted
101tar: Exiting with failure status due to previous errors
102</literallayout>
103
104 <para>
105 This does finish with non-zero status, but it does
106 <emphasis>NOT</emphasis> mean there is a real problem.
107 Do not untar as the <systemitem class="username">root</systemitem> user
108 in a directory where the sticky bit is set - that will unset it.
109 </para>
110
111 <para>
112 As with other large packages which use C++ (or rust), the SBU times
113 to build this vary more widely than you might expect. Also, 6GB
114 of real memory is used during the final link and the SBUs can increase
115 significantly if the machine has to swap.
116 </para>
117
118 <para>
119 The mach build system (Python scripts) can be somewhat unreliable: if
120 the build fails and reports an Error, it can still return a status of
121 success, causing a scripted build to try to install (which does not rerun
122 the build), fail during the preparations for installing, but still exit
123 with a status of success. Also, on occasion it may limit itself to only
124 running one set of jobs - that will make the build take about 3 times as
125 long as running with four sets of jobs.
126 </para>
127
128 <para>
129 Although upstream prefer to use <application>PulseAudio</application>,
130 for the moment <application>Alsa</application> can still be used. Both
131 may need runtime configuration to get sound working.
132 </para>
133 </note>
134
135 <bridgehead renderas="sect3">Firefox Dependencies</bridgehead>
136
137 <bridgehead renderas="sect4">Required</bridgehead>
138 <para role="required">
139 <xref linkend="autoconf213"/>,
140 <xref linkend="cbindgen"/>,
141 <application>Clang</application> (from <xref linkend="llvm"/>),
142 both <xref linkend="gtk3"/> and
143 <xref linkend="gtk2"/>,
144 <xref linkend="libnotify"/>,
145 <xref linkend="nodejs"/>,
146 <xref linkend="nss"/>,
147 <xref linkend="pulseaudio"/>
148 (or
149 <xref linkend="alsa-lib"/> if you edit the mozconfig;
150 now deprecated by mozilla), in either case please read the
151 Configuration Information,
152 <xref linkend="rust"/>,
153 <xref linkend="unzip"/>,
154 <xref linkend="yasm"/>, and
155 <xref linkend="zip"/>
156 </para>
157
158 <bridgehead renderas="sect4">Recommended</bridgehead>
159 <para role="recommended">
160 <xref linkend="icu"/>,
161 <xref linkend="libevent"/>,
162<!-- fails to build in 65.0 (headers changed)
163 <xref linkend="libvpx"/>, -->
164 <xref linkend="libwebp"/>, and
165 <xref linkend="sqlite"/>
166 </para>
167
168 <note>
169 <para>
170 If you don't install recommended dependencies, then internal copies of
171 those packages will be used. They might be tested to work, but they can
172 be out of date or contain security holes.
173 </para>
174 </note>
175
176 <bridgehead renderas="sect4">Optional</bridgehead>
177 <para role="optional">
178 <xref linkend="curl"/>,
179 <xref linkend="dbus-glib"/>,
180 <xref linkend="doxygen"/>,
181 <xref linkend="GConf"/>,
182 <xref role="runtime" linkend="ffmpeg"/> (runtime, to play mov, mp3 or mp4 files),
183 <!-- <phrase revision="sysv"><ulink url="http://sourceforge.net/projects/liboauth/files/">liboauth</ulink></phrase> -->
184 <xref linkend="liboauth"/>,
185 <xref linkend="openjdk"/>,
186 <xref linkend="startup-notification"/>,
187 <xref linkend="valgrind"/>,
188 <xref linkend="wget"/>,
189 <xref linkend="wireless_tools"/>,
190 <ulink url="https://github.com/libproxy/libproxy">libproxy</ulink>,
191 and (with the patch)
192 <xref linkend="graphite2"/> and
193 <xref linkend="harfbuzz"/>
194 </para>
195
196 <para condition="html" role="usernotes">
197 User Notes: <ulink url="&blfs-wiki;/firefox"/>
198 </para>
199 </sect2>
200
201 <sect2 role="installation">
202 <title>Installation of Firefox</title>
203
204 <para>
205 The configuration of <application>Firefox</application> is accomplished
206 by creating a <filename>mozconfig</filename> file containing the desired
207 configuration options. A default <filename>mozconfig</filename> is
208 created below. To see the entire list of available configuration options
209 (and an abbreviated description of some of them), issue <command>./mach
210 configure &amp;&amp; ./configure --help | less</command>. You may also
211 wish to review the entire file and uncomment any other desired options.
212 Create the file by issuing the following command:
213 </para>
214
215<screen><userinput>cat &gt; mozconfig &lt;&lt; "EOF"
216<literal># If you have a multicore machine, all cores will be used by default.
217
218# If you have installed dbus-glib, comment out this line:
219ac_add_options --disable-dbus
220
221# If you have installed dbus-glib, and you have installed (or will install)
222# wireless-tools, and you wish to use geolocation web services, comment out
223# this line
224ac_add_options --disable-necko-wifi
225
226# API Keys for geolocation APIs - necko-wifi (above) is required for MLS
227# Uncomment the following line if you wish to use Mozilla Location Service
228#ac_add_options --with-mozilla-api-keyfile=$PWD/mozilla-key
229
230# Uncomment the following line if you wish to use Google's geolocaton API
231# (needed for use with saved maps with Google Maps)
232#ac_add_options --with-google-location-service-api-keyfile=$PWD/google-key
233
234# Uncomment this line if you have installed startup-notification:
235#ac_add_options --enable-startup-notification
236
237# Uncomment the following option if you have not installed PulseAudio
238#ac_add_options --disable-pulseaudio
239# and uncomment this if you installed alsa-lib instead of PulseAudio
240#ac_add_options --enable-alsa
241
242# If you have installed GConf, comment out this line
243ac_add_options --disable-gconf
244
245# From firefox-61, the stylo CSS code can no-longer be disabled
246
247# Comment out following options if you have not installed
248# recommended dependencies:
249ac_add_options --enable-system-sqlite
250ac_add_options --with-system-libevent
251# current firefox fails to build against libvpx-1.8.0
252#ac_add_options --with-system-libvpx
253# firefox-65 understands webp and ships with an included copy
254ac_add_options --with-system-webp
255ac_add_options --with-system-nspr
256ac_add_options --with-system-nss
257ac_add_options --with-system-icu
258
259# The gold linker is no-longer the default
260ac_add_options --enable-linker=gold
261
262# The shipped libdavid (av1 decoder) is not built by default,
263# at least on linux, but if nasm is not present libxul tries to
264# link to one of libdavid's objects and fails. It is thought
265# libdavid will be enabled in firefox-67, at which point nasm
266# might be required.
267ac_add_options --disable-av1
268
269# You cannot distribute the binary if you do this
270ac_add_options --enable-official-branding
271
272# If you are going to apply the patch for system graphite
273# and system harfbuzz, uncomment these lines:
274#ac_add_options --with-system-graphite2
275#ac_add_options --with-system-harfbuzz
276
277# Stripping is now enabled by default.
278# Uncomment these lines if you need to run a debugger:
279#ac_add_options --disable-strip
280#ac_add_options --disable-install-strip
281
282# The BLFS editors recommend not changing anything below this line:
283ac_add_options --prefix=/usr
284ac_add_options --enable-application=browser
285
286ac_add_options --disable-crashreporter
287ac_add_options --disable-updater
288# enabling the tests will use a lot more space and significantly
289# increase the build time, for no obvious benefit.
290ac_add_options --disable-tests
291
292# With clang, unlike gcc-7 and later, the default level
293# of optimization produces a working build.
294ac_add_options --enable-optimize
295
296# From firefox-61 system cairo is not supported
297
298ac_add_options --enable-system-ffi
299ac_add_options --enable-system-pixman
300
301# From firefox-62 --with-pthreads is not recognized
302
303ac_add_options --with-system-bz2
304ac_add_options --with-system-jpeg
305ac_add_options --with-system-png
306ac_add_options --with-system-zlib
307
308# The following option unsets Telemetry Reporting. With the Addons Fiasco,
309# Mozilla was found to be collecting user's data, including saved passwords and
310# web form data, without users consent. Mozilla was also found shipping updates
311# to systems without the user's knowledge or permission.
312# As a result of this, use the following command to permanently disable
313# telemetry reporting in Firefox.
314unset MOZ_TELEMETRY_REPORTING
315
316mk_add_options MOZ_OBJDIR=@TOPSRCDIR@/firefox-build-dir</literal>
317EOF</userinput></screen>
318
319 <para>
320 Compile <application>Firefox</application> by issuing the following
321 commands:
322 </para>
323
324 <para>
325 If you have installed system versions of graphite2 and harfbuzz and wish
326 firefox to use those instead of its shipped versions, apply the patch and
327 uncomment the appropriate entries in the <filename>mozconfig</filename>
328 file.
329 </para>
330
331<screen><userinput>patch -Np1 -i ../firefox-&firefox-version;-system_graphite2_harfbuzz-1.patch</userinput></screen>
332
333 <para>
334 If the geolocation APIs are needed:
335 </para>
336
337 <note>
338 <para>
339 <!-- Taken from Arch Linux - an immensely helpful link - Thanks -->
340 The Google and Mozilla API Keys below are specific to LFS. If using
341 these instructions for another distro, or if you intend to distribute
342 binary copies of the software using these instructions, please obtain
343 your own keys following the instructions located at
344 <ulink url="http://www.chromium.org/developers/how-tos/api-keys"/> and
345 <ulink url="https://location.services.mozilla.com/api"/> respectively.
346 <!-- BLFS Devs, register an account at Google with your
347 @linuxfromscratch.org email address, and I'll make you an administrator
348 for the 'Google APIs for LFS' project (where the API and OAuth keys
349 were created for use in the book).-->
350 </para>
351 </note>
352
353<screen><userinput>echo "AIzaSyDxKL42zsPjbke5O8_rPVpVrLrJ8aeE9rQ" > google-key
354echo "d2284a20-0505-4927-a809-7ffaf4d91e55" > mozilla-key</userinput></screen>
355
356 <note><para>
357 If you are compiling <application>Firefox</application> in chroot, make
358 sure you have <envar>$SHELL</envar> environment variable set or prepend
359 <envar>SHELL=/bin/sh</envar>. Also ensure that <filename>/dev/shm</filename>
360 is mounted.
361 </para></note>
362
363 <para>
364<!-- Invoke the Python script to compile the package: -->
365 To use the system version of ICU, run a sed to avoid a conflict between
366 upstream ICU's use of <literal>CheckImpl()</literal> in their public headers
367 and firefox's internal use of a different <literal>CheckImpl()</literal>.
368 Then invoke the Python2 script to compile the package.
369 </para>
370
371<screen><userinput>sed -e 's/checkImpl/checkFFImpl/g' -i js/src/vm/JSContext*.h &amp;&amp;
372export CC=clang CXX=clang++ AR=llvm-ar NM=llvm-nm RANLIB=llvm-ranlib &amp;&amp;
373export MOZBUILD_STATE_PATH=${PWD}/mozbuild &amp;&amp;
374./mach build</userinput></screen>
375
376 <para>
377 The <filename>mozconfig</filename> above disables the tests because
378 they use a lot more time and disk space for no obvious benefit. If
379 you have nevertheless enabled them, you can run the tests by executing
380 <command>./mach gtest</command>. This will require a network connection,
381 and to be run from within an Xorg session - there is a popup dialog
382 when it fails to connect to ALSA (that does not create a failed test).
383 One or two tests will fail. To see the details of the failure(s) you
384 will need to log the output from that command so that you can review it.
385 </para>
386
387 <para>
388 Now, as the <systemitem class="username">root</systemitem> user:
389 </para>
390
391<screen role="root"><userinput>./mach install &amp;&amp;
392
393mkdir -pv /usr/lib/mozilla/plugins &amp;&amp;
394ln -sfv ../../mozilla/plugins /usr/lib/firefox/browser/</userinput></screen>
395
396 <para>
397 Set environment variables back to their values:
398 </para>
399
400<screen><userinput>unset CC CXX AR NM RANLIB MOZBUILD_STATE_PATH</userinput></screen>
401
402 </sect2>
403
404 <sect2 role="commands">
405 <title>Command Explanations</title>
406
407 <para>
408 <command>sed -e 's/checkImpl/checkFFImpl/g' ...</command>: Although the
409 package ships with a modified version of <application>ICU-59</application>
410 and only tests that the system version, if requested, is at least 59,
411 changes in <emphasis>some</emphasis> versions cause builds with the system
412 version to fail with error messages of the form <literal>no void
413 JSContext::checkImpl_NN member function</literal> where NN is the system
414 <application>ICU</application> version. The sed renames the local function.
415 </para>
416
417 <para>
418 <command>export CC=clang CXX=clang++ ...</command>: Upstream now use
419 <application>clang</application> and building with any recent version
420 saves a lot of space.
421 </para>
422
423 <para>
424 <command>export MOZBUILD_STATE_PATH=${PWD}/mozbuild</command>: The build
425 is now supposed to tell you that it intends to create <filename
426 class="directory">~/.mozbuild</filename>, and offer you an option to
427 press &lt;ENTER&gt; to accept this, or Ctrl-C to cancel and restart the
428 build after specifying the directory. In practice, the message may not
429 appear until after &lt;ENTER&gt; is keyed, i.e. the build stalls.
430 </para>
431
432 <para>
433 That directory is used for a (probably random) telemetry identifier.
434 Creating this in the build directory, and deleting that after the
435 installation, prevents it being used. If you wish to participate in
436 telemetry, export MOZBUILD_STATE_PATH to point to its default directory.
437 </para>
438
439 <para>
440 <command>./mach build</command>: <application>Firefox</application>
441 now uses this <application>python2</application> script to run the
442 build and install.
443 </para>
444
445 <para>
446 <option>./mach build --verbose</option>: Use this alternative if you
447 need details of which files are being compiled, together with any C or
448 C++ flags being used.
449 </para>
450
451 <para>
452 <option>./mach build -jN</option>: The build should, by default, use
453 all the online CPU cores. There are two reasons to specify the number
454 of cores, e.g. -j4 for 4 cores: First, if using all the cores causes
455 the build to swap because you have insufficient memory (e.g. for 4 cores
456 a build without system graphite2 and harfbuzz now uses slightly over 8GB
457 of RAM). In such cases, using fewer cores can be faster. Second, on some
458 machines the middle part of the build can drag on as if only one core is
459 present. In those cases, specifying the number of cores may speed up the
460 build.
461 </para>
462
463 <para>
464 <command>mkdir -pv /usr/lib/mozilla/plugins</command>: This ensures
465 that <filename class="directory">/usr/lib/mozilla/plugins/</filename>
466 exists.
467 </para>
468
469 <para>
470 <command>ln -sv ... /usr/lib/firefox/browser</command>:
471 This command creates a symbolic link to <filename
472 class="directory">/usr/lib/mozilla/plugins</filename>. It's not really
473 needed, as <application>Firefox</application> checks <filename
474 class="directory">/usr/lib/mozilla/plugins</filename> by default, but the
475 symbolic link is made to keep all the plugins installed in one folder.
476 </para>
477
478 </sect2>
479
480 <sect2 role="configuration">
481 <title>Configuring Firefox</title>
482
483 <para>
484 If you use a desktop environment like <application>Gnome</application> or
485 <application>KDE</application> you may like to create a
486 <filename>firefox.desktop</filename> file so that
487 <application>Firefox</application> appears in the panel's menus. If you
488 didn't enable startup-notification in your mozconfig change the
489 StartupNotify line to false. As the
490 <systemitem class="username">root</systemitem> user:
491 </para>
492
493<screen role="root"><userinput>mkdir -pv /usr/share/applications &amp;&amp;
494mkdir -pv /usr/share/pixmaps &amp;&amp;
495
496cat &gt; /usr/share/applications/firefox.desktop &lt;&lt; "EOF" &amp;&amp;
497<literal>[Desktop Entry]
498Encoding=UTF-8
499Name=Firefox Web Browser
500Comment=Browse the World Wide Web
501GenericName=Web Browser
502Exec=firefox %u
503Terminal=false
504Type=Application
505Icon=firefox
506Categories=GNOME;GTK;Network;WebBrowser;
507MimeType=text/html;text/xml;application/xhtml+xml;application/vnd.mozilla.xul+xml;text/mml;x-scheme-handler/http;x-scheme-handler/https;
508StartupNotify=true</literal>
509EOF
510
511ln -sfv /usr/lib/firefox/browser/chrome/icons/default/default128.png \
512 /usr/share/pixmaps/firefox.png</userinput></screen>
513
514 <sect3><title>Configuration Information</title>
515
516 <para>
517 The application settings for firefox are accessible by keying
518 <command>about:config</command> in the address bar.
519 </para>
520
521 <para>
522 With this version of <application>firefox</application>, getting
523 working sound can be a problem. Although upstream prefers pulseaudio,
524 on balance using <application>Alsa</application> may be easier.
525 </para>
526
527 <para>
528 If you enabled <application>Alsa</application> for sound, you may need
529 to alter one variable to get working sound. If you run
530 <command>firefox</command> from a term and try to play something with
531 sound you might encounter error messages like:
532 </para>
533
534 <para>
535 <literal>Sandbox: seccomp sandbox violation: pid 3941, tid 4030,
536 syscall 16, args 48 2147767296 139909894784796 0 0 0.</literal>
537 </para>
538
539 <para>
540 That was on x86_64, on i686 the syscall number is 54. To allow this
541 syscall, in <command>about:config</command> change
542 <command>security.sandbox.content.syscall_whitelist</command> to 16
543 (or 54 if using i686).
544 </para>
545
546 <para>
547 If you use <command>pulseaudio</command> in a Desktop Environment, it
548 might already be started by that DE. But if it is not, although
549 firefox-57 managed to start it, firefox-58 did not. If you run
550 <command>firefox</command> from a term and this problem is present,
551 trying to play sound will
552 encounter error messages warning <literal>Can't get cubeb
553 context!</literal>
554 </para>
555
556 <para>
557 The fix for this is to close firefox, start pulseaudio to check it
558 does start (if not, read the information on Configuring in <xref
559 linkend="pulseaudio"/>) and restart firefox to check it is working.
560 If it now works, add the following to your <filename>~/.xinitrc</filename>:
561<phrase revision="sysv">
562<literal>pulseaudio --verbose --log-target=syslog&amp;</literal></phrase>
563<phrase revision="systemd">
564<literal>pulseaudio --verbose --log-target=journald&amp;</literal></phrase>
565 (unfortunately, on some systems this does not work).
566 </para>
567
568 <para>
569 You may wish to use multiple profiles within firefox. To do that, invoke
570 firefox as <command>firefox --ProfileManager</command>. You can also
571 check which profile is currently in use from
572 <command>about:profiles</command>.
573 </para>
574
575 </sect3>
576 </sect2>
577
578 <sect2 role="content">
579 <title>Contents</title>
580
581 <segmentedlist>
582 <segtitle>Installed Programs</segtitle>
583 <segtitle>Installed Libraries</segtitle>
584 <segtitle>Installed Directory</segtitle>
585
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>
599
600 <variablelist>
601 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
602 <?dbfo list-presentation="list"?>
603 <?dbhtml list-presentation="table"?>
604
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>
617
618 </variablelist>
619
620 </sect2>
621
622</sect1>
Note: See TracBrowser for help on using the repository browser.