source: xsoft/graphweb/firefox.xml@ e399c12

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 e399c12 was e399c12, checked in by Ken Moffat <ken@…>, 3 years ago

Firefox-67.0

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

  • Property mode set to 100644
File size: 23.4 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 "41a5d504deaed12ebf0e25bb1420f08">
10 <!ENTITY firefox-size "270 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 "3.8 GB (154 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 "28 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 both <xref linkend="gtk3"/> and
142 <xref linkend="gtk2"/>,
143 <xref linkend="libnotify"/>,
144 <xref linkend="nodejs"/>,
145 <xref linkend="nss"/>,
146 <xref linkend="pulseaudio"/>
147 (or
148 <xref linkend="alsa-lib"/> if you edit the mozconfig;
149 now deprecated by mozilla), in either case please read the
150 Configuration Information,
151 <xref linkend="rust"/>,
152 <xref linkend="unzip"/>,
153 <xref linkend="yasm"/>, and
154 <xref linkend="zip"/>
155 </para>
156
157 <bridgehead renderas="sect4">Recommended</bridgehead>
158 <para role="recommended">
159 <xref linkend="icu"/>,
160 <xref linkend="libevent"/>,
161<!-- fails to build in 65.0 (headers changed)
162 <xref linkend="libvpx"/>, -->
163 <xref linkend="libwebp"/>,
164 <xref linkend="nasm"/>, 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# Do not specify the gold linker which is not the default. It will take
260# longer and use more disk space when debug symbols are disabled.
261
262# libdavid (av1 decoder) requires nasm. Uncomment this if nasm
263# has not been installed.
264#ac_add_options --disable-av1
265
266# You cannot distribute the binary if you do this
267ac_add_options --enable-official-branding
268
269# If you are going to apply the patch for system graphite
270# and system harfbuzz, uncomment these lines:
271#ac_add_options --with-system-graphite2
272#ac_add_options --with-system-harfbuzz
273
274# Stripping is now enabled by default.
275# Uncomment these lines if you need to run a debugger:
276#ac_add_options --disable-strip
277#ac_add_options --disable-install-strip
278
279# Disabling debug symbols makes the build much smaller and a little
280# faster. Comment this if you need to run a debugger.
281ac_add_options --disable-debug-symbols
282
283# The BLFS editors recommend not changing anything below this line:
284ac_add_options --prefix=/usr
285ac_add_options --enable-application=browser
286
287ac_add_options --disable-crashreporter
288ac_add_options --disable-updater
289# enabling the tests will use a lot more space and significantly
290# increase the build time, for no obvious benefit.
291ac_add_options --disable-tests
292
293# The default level of optimization again produces a working build with gcc.
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 If you are still using ICU-63, run a sed to avoid a conflict between
365 upstream ICU's use of <literal>CheckImpl()</literal> in their public headers
366 and firefox's internal use of a different <literal>CheckImpl()</literal>.
367 </para>
368
369<screen role="nodump"><userinput>sed -e 's/checkImpl/checkFFImpl/g' -i js/src/vm/JSContext*.h</userinput></screen>
370
371 <para>
372 Invoke the Python2 script to compile the package.
373 </para>
374
375<screen><userinput>export CC=gcc CXX=g++ &amp;&amp;
376export MOZBUILD_STATE_PATH=${PWD}/mozbuild &amp;&amp;
377./mach build</userinput></screen>
378
379 <para>
380 The <filename>mozconfig</filename> above disables the tests because
381 they use a lot more time and disk space for no obvious benefit. If
382 you have nevertheless enabled them, you can run the tests by executing
383 <command>./mach gtest</command>. This will require a network connection,
384 and to be run from within an Xorg session - there is a popup dialog
385 when it fails to connect to ALSA (that does not create a failed test).
386 One or two tests will fail. To see the details of the failure(s) you
387 will need to log the output from that command so that you can review it.
388 </para>
389
390 <para>
391 Now, as the <systemitem class="username">root</systemitem> user:
392 </para>
393
394<screen role="root"><userinput>./mach install &amp;&amp;
395
396mkdir -pv /usr/lib/mozilla/plugins &amp;&amp;
397ln -sfv ../../mozilla/plugins /usr/lib/firefox/browser/</userinput></screen>
398
399 <para>
400 Set environment variables back to their values:
401 </para>
402
403<screen><userinput>unset CC CXX MOZBUILD_STATE_PATH</userinput></screen>
404
405 </sect2>
406
407 <sect2 role="commands">
408 <title>Command Explanations</title>
409
410 <para>
411 <command>sed -e 's/checkImpl/checkFFImpl/g' ...</command>: Although the
412 package ships with a modified version of <application>ICU-63</application>
413 and only tests that the system version, if used, is at least 63, changes
414 from upstream 63 cause builds with the system version to fail with an error
415 message <literal>no void JSContext::checkImpl_63 member function</literal>.
416 The sed renames the local function. Upstream ICU-64 works around this.
417 </para>
418
419 <para>
420 <command>export CC=gcc CXX=g++ ...</command>: Upstream now prefer
421 <application>clang</application>, but gcc is a more secure compiler and
422 now produces reasonably-sized builds.
423 </para>
424
425 <para>
426 <command>export MOZBUILD_STATE_PATH=${PWD}/mozbuild</command>: The build
427 is now supposed to tell you that it intends to create <filename
428 class="directory">~/.mozbuild</filename>, and offer you an option to
429 press &lt;ENTER&gt; to accept this, or Ctrl-C to cancel and restart the
430 build after specifying the directory. In practice, the message may not
431 appear until after &lt;ENTER&gt; is keyed, i.e. the build stalls.
432 </para>
433
434 <para>
435 That directory is used for a (probably random) telemetry identifier.
436 Creating this in the build directory, and deleting that after the
437 installation, prevents it being used. If you wish to participate in
438 telemetry, export MOZBUILD_STATE_PATH to point to its default directory.
439 </para>
440
441 <para>
442 <command>./mach build</command>: <application>Firefox</application>
443 now uses this <application>python2</application> script to run the
444 build and install.
445 </para>
446
447 <para>
448 <option>./mach build --verbose</option>: Use this alternative if you
449 need details of which files are being compiled, together with any C or
450 C++ flags being used.
451 </para>
452
453 <para>
454 <option>./mach build -jN</option>: The build should, by default, use
455 all the online CPU cores. There are two reasons to specify the number
456 of cores, e.g. -j4 for 4 cores: First, if using all the cores causes
457 the build to swap because you have insufficient memory (e.g. for 4 cores
458 a build without system graphite2 and harfbuzz now uses towards 8GB
459 of RAM). In such cases, using fewer cores can be faster. Second, on some
460 machines the middle part of the build can drag on as if only one core is
461 present. In those cases, specifying the number of cores may speed up the
462 build.
463 </para>
464
465 <para>
466 <command>mkdir -pv /usr/lib/mozilla/plugins</command>: This ensures
467 that <filename class="directory">/usr/lib/mozilla/plugins/</filename>
468 exists.
469 </para>
470
471 <para>
472 <command>ln -sv ... /usr/lib/firefox/browser</command>:
473 This command creates a symbolic link to <filename
474 class="directory">/usr/lib/mozilla/plugins</filename>. It's not really
475 needed, as <application>Firefox</application> checks <filename
476 class="directory">/usr/lib/mozilla/plugins</filename> by default, but the
477 symbolic link is made to keep all the plugins installed in one folder.
478 </para>
479
480 <para>
481 <option>export CC=clang CXX=clang++ AR=llvm-ar NM=llvm-nm RANLIB=llvm-ranlib</option>:
482 Use this as an alternative to building with gcc and g++ if you wish to use
483 the clang toolchain. Remember to unset these variables after the build.
484 </para>
485
486 </sect2>
487
488 <sect2 role="configuration">
489 <title>Configuring Firefox</title>
490
491 <para>
492 If you use a desktop environment like <application>Gnome</application> or
493 <application>KDE</application> you may like to create a
494 <filename>firefox.desktop</filename> file so that
495 <application>Firefox</application> appears in the panel's menus. If you
496 didn't enable startup-notification in your mozconfig change the
497 StartupNotify line to false. As the
498 <systemitem class="username">root</systemitem> user:
499 </para>
500
501<screen role="root"><userinput>mkdir -pv /usr/share/applications &amp;&amp;
502mkdir -pv /usr/share/pixmaps &amp;&amp;
503
504cat &gt; /usr/share/applications/firefox.desktop &lt;&lt; "EOF" &amp;&amp;
505<literal>[Desktop Entry]
506Encoding=UTF-8
507Name=Firefox Web Browser
508Comment=Browse the World Wide Web
509GenericName=Web Browser
510Exec=firefox %u
511Terminal=false
512Type=Application
513Icon=firefox
514Categories=GNOME;GTK;Network;WebBrowser;
515MimeType=text/html;text/xml;application/xhtml+xml;application/vnd.mozilla.xul+xml;text/mml;x-scheme-handler/http;x-scheme-handler/https;
516StartupNotify=true</literal>
517EOF
518
519ln -sfv /usr/lib/firefox/browser/chrome/icons/default/default128.png \
520 /usr/share/pixmaps/firefox.png</userinput></screen>
521
522 <sect3><title>Configuration Information</title>
523
524 <para>
525 The application settings for firefox are accessible by keying
526 <command>about:config</command> in the address bar.
527 </para>
528
529 <para>
530 With this version of <application>firefox</application>, getting
531 working sound can be a problem. Although upstream prefers pulseaudio,
532 on balance using <application>Alsa</application> may be easier.
533 </para>
534
535 <para>
536 If you enabled <application>Alsa</application> for sound, you may need
537 to alter one variable to get working sound. If you run
538 <command>firefox</command> from a term and try to play something with
539 sound you might encounter error messages like:
540 </para>
541
542 <para>
543 <literal>Sandbox: seccomp sandbox violation: pid 3941, tid 4030,
544 syscall 16, args 48 2147767296 139909894784796 0 0 0.</literal>
545 </para>
546
547 <para>
548 That was on x86_64, on i686 the syscall number is 54. To allow this
549 syscall, in <command>about:config</command> change
550 <command>security.sandbox.content.syscall_whitelist</command> to 16
551 (or 54 if using i686).
552 </para>
553
554 <para>
555 If you use <command>pulseaudio</command> in a Desktop Environment, it
556 might already be started by that DE. But if it is not, although
557 firefox-57 managed to start it, firefox-58 did not. If you run
558 <command>firefox</command> from a term and this problem is present,
559 trying to play sound will
560 encounter error messages warning <literal>Can't get cubeb
561 context!</literal>
562 </para>
563
564 <para>
565 The fix for this is to close firefox, start pulseaudio to check it
566 does start (if not, read the information on Configuring in <xref
567 linkend="pulseaudio"/>) and restart firefox to check it is working.
568 If it now works, add the following to your <filename>~/.xinitrc</filename>:
569<phrase revision="sysv">
570<literal>pulseaudio --verbose --log-target=syslog&amp;</literal></phrase>
571<phrase revision="systemd">
572<literal>pulseaudio --verbose --log-target=journald&amp;</literal></phrase>
573 (unfortunately, on some systems this does not work).
574 </para>
575
576 <para>
577 You may wish to use multiple profiles within firefox. To do that, invoke
578 firefox as <command>firefox --ProfileManager</command>. You can also
579 check which profile is currently in use from
580 <command>about:profiles</command>.
581 </para>
582
583 </sect3>
584 </sect2>
585
586 <sect2 role="content">
587 <title>Contents</title>
588
589 <segmentedlist>
590 <segtitle>Installed Programs</segtitle>
591 <segtitle>Installed Libraries</segtitle>
592 <segtitle>Installed Directory</segtitle>
593
594 <seglistitem>
595 <seg>
596 firefox
597 </seg>
598 <seg>
599 Numerous libraries, browser components, plugins, extensions, and
600 helper modules installed in /usr/lib/firefox
601 </seg>
602 <seg>
603 /usr/lib/firefox and /usr/lib/mozilla
604 </seg>
605 </seglistitem>
606 </segmentedlist>
607
608 <variablelist>
609 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
610 <?dbfo list-presentation="list"?>
611 <?dbhtml list-presentation="table"?>
612
613 <varlistentry id="firefox-prog">
614 <term><command>firefox</command></term>
615 <listitem>
616 <para>
617 is a <application>GTK+-3</application> internet browser that uses
618 the Mozilla Gecko rendering engine.
619 </para>
620 <indexterm zone="firefox firefox-prog">
621 <primary sortas="b-firefox">firefox</primary>
622 </indexterm>
623 </listitem>
624 </varlistentry>
625
626 </variablelist>
627
628 </sect2>
629
630</sect1>
Note: See TracBrowser for help on using the repository browser.