source: xsoft/graphweb/firefox.xml@ d52dba8

10.0 10.1 11.0 11.1 11.2 8.4 9.0 9.1 bdubbs/svn elogind lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since d52dba8 was d52dba8, checked in by Ken Moffat <ken@…>, 4 years ago

Firefox-63.0.3. Also fix typo in node-js changelog entry.

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

  • Property mode set to 100644
File size: 21.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;/source/firefox-&firefox-version;.source.tar.xz">
8 <!ENTITY firefox-download-ftp " ">
9 <!ENTITY firefox-md5sum "03aa81edafce60069428349b4762cc03">
10 <!ENTITY firefox-size "254 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 "9.0 GB (153 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 in
16 doubt, round up -->
17 <!ENTITY firefox-time "22 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 &lfs83_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, almost 6GB
114 of real memory is used during the final link and the SBUs can increase
115 significantly if the machine has to swap to do this.
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="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 <xref linkend="libvpx"/>,
162 <xref linkend="nodejs"/>, and
163 <xref linkend="sqlite"/>
164 </para>
165
166 <note>
167 <para>
168 If you don't install recommended dependencies, then internal copies of
169 those packages will be used. They might be tested to work, but they can
170 be out of date or contain security holes.
171 </para>
172 </note>
173
174 <bridgehead renderas="sect4">Optional</bridgehead>
175 <para role="optional">
176 <xref linkend="curl"/>,
177 <xref linkend="dbus-glib"/>,
178 <xref linkend="doxygen"/>,
179 <xref linkend="GConf"/>,
180 <xref role="runtime" linkend="ffmpeg"/> (runtime, to play mov, mp3 or mp4 files),
181 <xref linkend="libwebp"/>,
182 <xref linkend="openjdk"/>,
183 <xref linkend="startup-notification"/>,
184 <xref linkend="valgrind"/>,
185 <xref linkend="wget"/>,
186 <xref linkend="wireless_tools"/>,
187 <phrase revision="sysv"><ulink url="http://sourceforge.net/projects/liboauth/files/">liboauth</ulink></phrase>
188 <phrase revision="systemd"><xref linkend="liboauth"/></phrase>,
189 <ulink url="https://github.com/libproxy/libproxy">libproxy</ulink>,
190 and (with the patch)
191 <xref linkend="graphite2"/> and
192 <xref linkend="harfbuzz"/>
193 </para>
194
195 <para condition="html" role="usernotes">
196 User Notes: <ulink url="&blfs-wiki;/firefox"/>
197 </para>
198 </sect2>
199
200 <sect2 role="installation">
201 <title>Installation of Firefox</title>
202
203 <para>
204 The configuration of <application>Firefox</application> is accomplished
205 by creating a <filename>mozconfig</filename> file containing the desired
206 configuration options. A default <filename>mozconfig</filename> is
207 created below. To see the entire list of available configuration options
208 (and an abbreviated description of some of them), issue <command>./mach
209 configure &amp;&amp; ./configure --help | less</command>. You may also
210 wish to review the entire file and uncomment any other desired options.
211 Create the file by issuing the following command:
212 </para>
213
214<screen><userinput>cat &gt; mozconfig &lt;&lt; "EOF"
215<literal># If you have a multicore machine, all cores will be used by default.
216# You can change the number of non-rust jobs by setting a valid number
217# of cores in this option, but when rust crates are being compiled
218# jobs will be scheduled for all the available CPU cores.
219#mk_add_options MOZ_MAKE_FLAGS="-j1"
220
221# If you have installed dbus-glib, comment out this line:
222ac_add_options --disable-dbus
223
224# If you have installed dbus-glib, and you have installed (or will install)
225# wireless-tools, and you wish to use geolocation web services, comment out
226# this line
227ac_add_options --disable-necko-wifi
228
229# API Keys for geolocation APIs - necko-wifi (above) is required for MLS
230# Uncomment the following line if you wish to use Mozilla Location Service
231#ac_add_options --with-mozilla-api-keyfile=$PWD/mozilla-key
232
233# Uncomment the following line if you wish to use Google's geolocaton API
234# (needed for use with saved maps with Google Maps)
235#ac_add_options --with-google-api-keyfile=$PWD/google-key
236
237# Uncomment this line if you have installed startup-notification:
238#ac_add_options --enable-startup-notification
239
240# Uncomment the following option if you have not installed PulseAudio
241#ac_add_options --disable-pulseaudio
242# and uncomment this if you installed alsa-lib instead of PulseAudio
243#ac_add_options --enable-alsa
244
245# If you have installed GConf, comment out this line
246ac_add_options --disable-gconf
247
248# Uncomment this if you have not installed nodejs,
249# but note that nodejs will be required in firefox-64
250#ac_add_options --disable-nodejs
251
252# From firefox-61, the stylo CSS code can no-longer be disabled
253
254# Comment out following options if you have not installed
255# recommended dependencies:
256ac_add_options --enable-system-sqlite
257ac_add_options --with-system-libevent
258ac_add_options --with-system-libvpx
259ac_add_options --with-system-nspr
260ac_add_options --with-system-nss
261ac_add_options --with-system-icu
262
263# The gold linker is no-longer the default
264ac_add_options --enable-linker=gold
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# The BLFS editors recommend not changing anything below this line:
280ac_add_options --prefix=/usr
281ac_add_options --enable-application=browser
282
283ac_add_options --disable-crashreporter
284ac_add_options --disable-updater
285# enabling the tests will use a lot more space and significantly
286# increase the build time, for no obvious benefit.
287ac_add_options --disable-tests
288
289# Optimization for size is broken with gcc7 and later
290ac_add_options --enable-optimize="-O2"
291
292# From firefox-61 system cairo is not supported
293
294ac_add_options --enable-system-ffi
295ac_add_options --enable-system-pixman
296
297# From firefox-62 --with-pthreads is not recognized
298
299ac_add_options --with-system-bz2
300ac_add_options --with-system-jpeg
301ac_add_options --with-system-png
302ac_add_options --with-system-zlib
303
304mk_add_options MOZ_OBJDIR=@TOPSRCDIR@/firefox-build-dir</literal>
305EOF</userinput></screen>
306
307 <para>
308 Compile <application>Firefox</application> by issuing the following
309 commands:
310 </para>
311
312 <para>
313 If you have installed system versions of graphite2 and harfbuzz and wish
314 firefox to use those instead of its shipped versions, apply the patch and
315 uncomment the appropriate entries in the <filename>mozconfig</filename>
316 file.
317 </para>
318
319<screen><userinput>patch -Np1 -i ../firefox-&firefox-version;-system_graphite2_harfbuzz-1.patch</userinput></screen>
320
321 <para>
322 If the geolocation APIs are needed:
323 </para>
324
325 <note>
326 <para>
327 <!-- Taken from Arch Linux - an immensely helpful link - Thanks -->
328 The Google and Mozilla API Keys below are specific to LFS. If using
329 these instructions for another distro, or if you intend to distribute
330 binary copies of the software using these instructions, please obtain
331 your own keys following the instructions located at
332 <ulink url="http://www.chromium.org/developers/how-tos/api-keys"/> and
333 <ulink url="https://location.services.mozilla.com/api"/> respectively.
334 <!-- BLFS Devs, register an account at Google with your
335 @linuxfromscratch.org email address, and I'll make you an administrator
336 for the 'Google APIs for LFS' project (where the API and OAuth keys
337 were created for use in the book).-->
338 </para>
339 </note>
340
341<screen><userinput>echo "AIzaSyDxKL42zsPjbke5O8_rPVpVrLrJ8aeE9rQ" > google-key
342echo "d2284a20-0505-4927-a809-7ffaf4d91e55" > mozilla-key</userinput></screen>
343
344 <note><para>
345 If you are compiling <application>Firefox</application> in chroot, make
346 sure you have <envar>$SHELL</envar> environment variable set or prepend
347 <envar>SHELL=/bin/sh</envar>. Also ensure that <filename>/dev/shm</filename>
348 is mounted.
349 </para></note>
350
351 <para>
352<!-- Invoke the Python script to compile the package: -->
353 Fix a problem with certain versions of ICU, then invoke the Python script
354 to compile the package.
355 </para>
356
357<screen><userinput>sed -e 's/checkImpl/checkFFImpl/g' -i js/src/vm/JSContext*.h &amp;&amp;
358export CC=clang CXX=clang++ AR=llvm-ar NM=llvm-nm RANLIB=llvm-ranlib &amp;&amp;
359./mach build &amp;&amp;
360unset CC CXX AR NM RANLIB</userinput></screen>
361
362 <para>
363 The <filename>mozconfig</filename> above disables the tests because
364 they use a lot more time and disk space for no obvious benefit. If
365 you have nevertheless enabled them, you can run the tests by executing
366 <command>./mach gtest</command>. This will require a network connection,
367 and to be run from within an Xorg session - there is a popup dialog
368 when it fails to connect to ALSA (that does not create a failed test).
369 One or two tests will fail. To see the details of the failure(s) you
370 will need to log the output from that command so that you can review it.
371 </para>
372
373 <para>
374 Now, as the <systemitem class="username">root</systemitem> user:
375 </para>
376
377<screen role="root"><userinput>./mach install &amp;&amp;
378
379mkdir -pv /usr/lib/mozilla/plugins &amp;&amp;
380ln -sfv ../../mozilla/plugins /usr/lib/firefox/browser/</userinput></screen>
381<!--
382 <para>
383 Set environment variables back to their values:
384 </para>
385
386<screen><userinput>export CFLAGS=$CFLAGS_HOLD &amp;&amp;
387export CXXFLAGS=$CXXFLAGS_HOLD &amp;&amp;
388unset CFLAGS_HOLD CXXFLAGS_HOLD</userinput></screen>
389-->
390
391 </sect2>
392
393 <sect2 role="commands">
394 <title>Command Explanations</title>
395
396 <para>
397 <command>sed -e 's/checkImpl/checkFFImpl/g' ...</command>: Although the
398 package ships with a modified version of <application>ICU-59</application>
399 and only tests that the system version, if requested, is at least 59,
400 changes in <emphasis>some</emphasis> versions cause builds with the system
401 version to fail with error messages of the form <literal>no void
402 JSContext::checkImpl_NN member function</literal> where NN is the system
403 <application>ICU</application> version. The sed renames the local function.
404 </para>
405
406 <para>
407 <command>export CC=clang CXX=clang++ ...</command>: Upstream now use
408 <application>clang</application> and building with any recent version
409 saves a lot of space.
410 </para>
411
412 <para>
413 <command>./mach build</command>: <application>Firefox</application>
414 now uses this <application>python2</application> script to run the
415 build and install.
416 </para>
417
418 <para>
419 <option>./mach build --verbose</option>: Use this alternative if you
420 need details of which files are being compiled, together with any C or
421 C++ flags being used.
422 </para>
423
424 <para>
425 <option>./mach build -j4</option>: In theory, <command>mach</command>
426 will use the number of online CPU cores - but on some machines the bulk
427 of the build will drag on as if only 1 core is present. Specifying the
428 number of jobs (4 in this example) fixes that. Unlike traditional
429 recommendations for running <command>make</command>, the exact number
430 of cores is usually fastest - exceptionally, N+1 may be better on a
431 well-specified modern machine. But do NOT use this if building from a
432 term where <command>taskset</command> has been used to restrict the
433 available cores.
434 </para>
435
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>
441
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>
450
451 </sect2>
452
453 <sect2 role="configuration">
454 <title>Configuring Firefox</title>
455
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>
465
466<screen role="root"><userinput>mkdir -pv /usr/share/applications &amp;&amp;
467mkdir -pv /usr/share/pixmaps &amp;&amp;
468
469cat &gt; /usr/share/applications/firefox.desktop &lt;&lt; "EOF" &amp;&amp;
470<literal>[Desktop Entry]
471Encoding=UTF-8
472Name=Firefox Web Browser
473Comment=Browse the World Wide Web
474GenericName=Web Browser
475Exec=firefox %u
476Terminal=false
477Type=Application
478Icon=firefox
479Categories=GNOME;GTK;Network;WebBrowser;
480MimeType=text/html;text/xml;application/xhtml+xml;application/vnd.mozilla.xul+xml;text/mml;x-scheme-handler/http;x-scheme-handler/https;
481StartupNotify=true</literal>
482EOF
483
484ln -sfv /usr/lib/firefox/browser/chrome/icons/default/default128.png \
485 /usr/share/pixmaps/firefox.png</userinput></screen>
486
487 <sect3><title>Configuration Information</title>
488
489 <para>
490 The application settings for firefox are accessible by keying
491 <command>about:config</command> in the address bar.
492 </para>
493
494 <para>
495 With this version of <application>firefox</application>, getting
496 working sound can be a problem. Although upstream prefers pulseaudio,
497 on balance using <application>Alsa</application> may be easier.
498 </para>
499
500 <para>
501 If you enabled <application>Alsa</application> for sound, you may need
502 to alter one variable to get working sound. If you run
503 <command>firefox</command> from a term and try to play something with
504 sound you might encounter error messages like:
505 </para>
506
507 <para>
508 <literal>Sandbox: seccomp sandbox violation: pid 3941, tid 4030,
509 syscall 16, args 48 2147767296 139909894784796 0 0 0.</literal>
510 </para>
511
512 <para>
513 That was on x86_64, on i686 the syscall number is 54. To allow this
514 syscall, in <command>about:config</command> change
515 <command>security.sandbox.content.syscall_whitelist</command> to 16
516 (or 54 if using i686).
517 </para>
518
519 <para>
520 If you use <command>pulseaudio</command> in a Desktop Environment, it
521 might already be started by that DE. But if it is not, although
522 firefox-57 managed to start it, firefox-58 does not. If you run
523 <command>firefox</command> from a term, trying to play sound will
524 encounter error messages warning <literal>Can't get cubeb
525 context!</literal>
526 </para>
527
528 <para>
529 The fix for this is to close firefox, start pulseaudio to check it
530 does start (if not, read the information on Configuring in <xref
531 linkend="pulseaudio"/>) and restart firefox to check it is working.
532 If it now works, add the following to your <filename>~/.xinitrc</filename>:
533<phrase revision="sysv">
534<literal>pulseaudio --verbose --log-target=syslog&amp;</literal></phrase>
535<phrase revision="systemd">
536<literal>pulseaudio --verbose --log-target=journald&amp;</literal></phrase>
537 (unfortunately, on some systems this does not work).
538 </para>
539
540 <para>
541 You may wish to use multiple profiles within firefox. To do that, invoke
542 firefox as <command>firefox --ProfileManager</command>. You can also
543 check which profile is currently in use from
544 <command>about:profiles</command>.
545 </para>
546
547 </sect3>
548 </sect2>
549
550 <sect2 role="content">
551 <title>Contents</title>
552
553 <segmentedlist>
554 <segtitle>Installed Programs</segtitle>
555 <segtitle>Installed Libraries</segtitle>
556 <segtitle>Installed Directory</segtitle>
557
558 <seglistitem>
559 <seg>
560 firefox
561 </seg>
562 <seg>
563 Numerous libraries, browser components, plugins, extensions, and
564 helper modules installed in /usr/lib/firefox
565 </seg>
566 <seg>
567 /usr/lib/firefox and /usr/lib/mozilla
568 </seg>
569 </seglistitem>
570 </segmentedlist>
571
572 <variablelist>
573 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
574 <?dbfo list-presentation="list"?>
575 <?dbhtml list-presentation="table"?>
576
577 <varlistentry id="firefox-prog">
578 <term><command>firefox</command></term>
579 <listitem>
580 <para>
581 is a <application>GTK+-3</application> internet browser that uses
582 the Mozilla Gecko rendering engine.
583 </para>
584 <indexterm zone="firefox firefox-prog">
585 <primary sortas="b-firefox">firefox</primary>
586 </indexterm>
587 </listitem>
588 </varlistentry>
589
590 </variablelist>
591
592 </sect2>
593
594</sect1>
Note: See TracBrowser for help on using the repository browser.