source: xsoft/graphweb/firefox.xml@ 7ebe22e

10.0 10.1 11.0 8.4 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 7ebe22e was 7ebe22e, checked in by Ken Moffat <ken@…>, 3 years ago

Firefox-65.0

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

  • Property mode set to 100644
File size: 22.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 "b5f952cbb1b1edbae43f6a469059099b">
10 <!ENTITY firefox-size "266 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.4 GB (147 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 "31 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, 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 <xref linkend="libvpx"/>,
163 <xref linkend="libwebp"/>, and
164 <xref linkend="sqlite"/>
165 </para>
166
167 <note>
168 <para>
169 If you don't install recommended dependencies, then internal copies of
170 those packages will be used. They might be tested to work, but they can
171 be out of date or contain security holes.
172 </para>
173 </note>
174
175 <bridgehead renderas="sect4">Optional</bridgehead>
176 <para role="optional">
177 <xref linkend="curl"/>,
178 <xref linkend="dbus-glib"/>,
179 <xref linkend="doxygen"/>,
180 <xref linkend="GConf"/>,
181 <xref role="runtime" linkend="ffmpeg"/> (runtime, to play mov, mp3 or mp4 files),
182 <xref linkend="libwebp"/>,
183 <xref linkend="openjdk"/>,
184 <xref linkend="startup-notification"/>,
185 <xref linkend="valgrind"/>,
186 <xref linkend="wget"/>,
187 <xref linkend="wireless_tools"/>,
188 <!-- <phrase revision="sysv"><ulink url="http://sourceforge.net/projects/liboauth/files/">liboauth</ulink></phrase> -->
189 <xref linkend="liboauth"/>,
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-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
251ac_add_options --with-system-libvpx
252ac_add_options --with-system-nspr
253ac_add_options --with-system-nss
254ac_add_options --with-system-icu
255
256# The gold linker is no-longer the default
257ac_add_options --enable-linker=gold
258
259# You cannot distribute the binary if you do this
260ac_add_options --enable-official-branding
261
262# If you are going to apply the patch for system graphite
263# and system harfbuzz, uncomment these lines:
264#ac_add_options --with-system-graphite2
265#ac_add_options --with-system-harfbuzz
266
267# Stripping is now enabled by default.
268# Uncomment these lines if you need to run a debugger:
269#ac_add_options --disable-strip
270#ac_add_options --disable-install-strip
271
272# The BLFS editors recommend not changing anything below this line:
273ac_add_options --prefix=/usr
274ac_add_options --enable-application=browser
275
276ac_add_options --disable-crashreporter
277ac_add_options --disable-updater
278# enabling the tests will use a lot more space and significantly
279# increase the build time, for no obvious benefit.
280ac_add_options --disable-tests
281
282# Optimization for size is broken with gcc7 and later
283ac_add_options --enable-optimize="-O2"
284
285# From firefox-61 system cairo is not supported
286
287ac_add_options --enable-system-ffi
288ac_add_options --enable-system-pixman
289
290# From firefox-62 --with-pthreads is not recognized
291
292ac_add_options --with-system-bz2
293ac_add_options --with-system-jpeg
294ac_add_options --with-system-png
295ac_add_options --with-system-zlib
296
297mk_add_options MOZ_OBJDIR=@TOPSRCDIR@/firefox-build-dir</literal>
298EOF</userinput></screen>
299
300 <para>
301 Compile <application>Firefox</application> by issuing the following
302 commands:
303 </para>
304
305 <para>
306 If you have installed system versions of graphite2 and harfbuzz and wish
307 firefox to use those instead of its shipped versions, apply the patch and
308 uncomment the appropriate entries in the <filename>mozconfig</filename>
309 file.
310 </para>
311
312<screen><userinput>patch -Np1 -i ../firefox-&firefox-version;-system_graphite2_harfbuzz-1.patch</userinput></screen>
313
314 <para>
315 If the geolocation APIs are needed:
316 </para>
317
318 <note>
319 <para>
320 <!-- Taken from Arch Linux - an immensely helpful link - Thanks -->
321 The Google and Mozilla API Keys below are specific to LFS. If using
322 these instructions for another distro, or if you intend to distribute
323 binary copies of the software using these instructions, please obtain
324 your own keys following the instructions located at
325 <ulink url="http://www.chromium.org/developers/how-tos/api-keys"/> and
326 <ulink url="https://location.services.mozilla.com/api"/> respectively.
327 <!-- BLFS Devs, register an account at Google with your
328 @linuxfromscratch.org email address, and I'll make you an administrator
329 for the 'Google APIs for LFS' project (where the API and OAuth keys
330 were created for use in the book).-->
331 </para>
332 </note>
333
334<screen><userinput>echo "AIzaSyDxKL42zsPjbke5O8_rPVpVrLrJ8aeE9rQ" > google-key
335echo "d2284a20-0505-4927-a809-7ffaf4d91e55" > mozilla-key</userinput></screen>
336
337 <note><para>
338 If you are compiling <application>Firefox</application> in chroot, make
339 sure you have <envar>$SHELL</envar> environment variable set or prepend
340 <envar>SHELL=/bin/sh</envar>. Also ensure that <filename>/dev/shm</filename>
341 is mounted.
342 </para></note>
343
344 <para>
345<!-- Invoke the Python script to compile the package: -->
346 To use the system version of ICU, run a sed to avoid a conflict between
347 upstream ICU's use of <literal>CheckImpl()</literal> in their public headers
348 and firefox's internal use of a different <literal>CheckImpl()</literal>.
349 Then invoke the Python2 script to compile the package.
350 </para>
351
352<screen><userinput>sed -e 's/checkImpl/checkFFImpl/g' -i js/src/vm/JSContext*.h &amp;&amp;
353export CC=clang CXX=clang++ AR=llvm-ar NM=llvm-nm RANLIB=llvm-ranlib &amp;&amp;
354export MOZBUILD_STATE_PATH=${PWD}/mozbuild &amp;&amp;
355./mach build</userinput></screen>
356
357 <para>
358 The <filename>mozconfig</filename> above disables the tests because
359 they use a lot more time and disk space for no obvious benefit. If
360 you have nevertheless enabled them, you can run the tests by executing
361 <command>./mach gtest</command>. This will require a network connection,
362 and to be run from within an Xorg session - there is a popup dialog
363 when it fails to connect to ALSA (that does not create a failed test).
364 One or two tests will fail. To see the details of the failure(s) you
365 will need to log the output from that command so that you can review it.
366 </para>
367
368 <para>
369 Now, as the <systemitem class="username">root</systemitem> user:
370 </para>
371
372<screen role="root"><userinput>./mach install &amp;&amp;
373
374mkdir -pv /usr/lib/mozilla/plugins &amp;&amp;
375ln -sfv ../../mozilla/plugins /usr/lib/firefox/browser/</userinput></screen>
376
377 <para>
378 Set environment variables back to their values:
379 </para>
380
381<screen><userinput>unset CC CXX AR NM RANLIB MOZBUILD_STATE_PATH</userinput></screen>
382
383 </sect2>
384
385 <sect2 role="commands">
386 <title>Command Explanations</title>
387
388 <para>
389 <command>sed -e 's/checkImpl/checkFFImpl/g' ...</command>: Although the
390 package ships with a modified version of <application>ICU-59</application>
391 and only tests that the system version, if requested, is at least 59,
392 changes in <emphasis>some</emphasis> versions cause builds with the system
393 version to fail with error messages of the form <literal>no void
394 JSContext::checkImpl_NN member function</literal> where NN is the system
395 <application>ICU</application> version. The sed renames the local function.
396 </para>
397
398 <para>
399 <command>export CC=clang CXX=clang++ ...</command>: Upstream now use
400 <application>clang</application> and building with any recent version
401 saves a lot of space.
402 </para>
403
404 <para>
405 <command>export MOZBUILD_STATE_PATH=${PWD}/mozbuild</command>: The build
406 is now supposed to tell you that it intends to create <filename
407 class="directory">~/.mozbuild</filename>, and offer you an option to
408 press &lt;ENTER&gt; to accept this, or Ctrl-C to cancel and restart the
409 build after specifying the directory. In practice, the message may not
410 appear until after &lt;ENTER&gt; is keyed, i.e. the build stalls.
411 </para>
412
413 <para>
414 That directory is used for a (probably random) telemetry identifier.
415 Creating this in the build directory, and deleting that after the
416 installation, prevents it being used. If you wish to participate in
417 telemetry, export MOZBUILD_STATE_PATH to point to its default directory.
418 </para>
419
420 <para>
421 <command>./mach build</command>: <application>Firefox</application>
422 now uses this <application>python2</application> script to run the
423 build and install.
424 </para>
425
426 <para>
427 <option>./mach build --verbose</option>: Use this alternative if you
428 need details of which files are being compiled, together with any C or
429 C++ flags being used.
430 </para>
431
432 <para>
433 <option>./mach build -jN</option>: The build should, by default, use
434 all the online CPU cores. There are two reasons to specify the number
435 of cores, e.g. -j4 for 4 cores: First, if using all the cores causes
436 the build to swap because you have insufficient memory (e.g. for 4 cores
437 a build without system graphite2 and harfbuzz now uses slightly over 8GB
438 of RAM). In such cases, using fewer cores can be faster. Second, on some
439 machines the middle part of the build can drag on as if only one core is
440 present. In those cases, specifying the number of cores may speed up the
441 build.
442 </para>
443
444 <para>
445 <command>mkdir -pv /usr/lib/mozilla/plugins</command>: This ensures
446 that <filename class="directory">/usr/lib/mozilla/plugins/</filename>
447 exists.
448 </para>
449
450 <para>
451 <command>ln -sv ... /usr/lib/firefox/browser</command>:
452 This command creates a symbolic link to <filename
453 class="directory">/usr/lib/mozilla/plugins</filename>. It's not really
454 needed, as <application>Firefox</application> checks <filename
455 class="directory">/usr/lib/mozilla/plugins</filename> by default, but the
456 symbolic link is made to keep all the plugins installed in one folder.
457 </para>
458
459 </sect2>
460
461 <sect2 role="configuration">
462 <title>Configuring Firefox</title>
463
464 <para>
465 If you use a desktop environment like <application>Gnome</application> or
466 <application>KDE</application> you may like to create a
467 <filename>firefox.desktop</filename> file so that
468 <application>Firefox</application> appears in the panel's menus. If you
469 didn't enable startup-notification in your mozconfig change the
470 StartupNotify line to false. As the
471 <systemitem class="username">root</systemitem> user:
472 </para>
473
474<screen role="root"><userinput>mkdir -pv /usr/share/applications &amp;&amp;
475mkdir -pv /usr/share/pixmaps &amp;&amp;
476
477cat &gt; /usr/share/applications/firefox.desktop &lt;&lt; "EOF" &amp;&amp;
478<literal>[Desktop Entry]
479Encoding=UTF-8
480Name=Firefox Web Browser
481Comment=Browse the World Wide Web
482GenericName=Web Browser
483Exec=firefox %u
484Terminal=false
485Type=Application
486Icon=firefox
487Categories=GNOME;GTK;Network;WebBrowser;
488MimeType=text/html;text/xml;application/xhtml+xml;application/vnd.mozilla.xul+xml;text/mml;x-scheme-handler/http;x-scheme-handler/https;
489StartupNotify=true</literal>
490EOF
491
492ln -sfv /usr/lib/firefox/browser/chrome/icons/default/default128.png \
493 /usr/share/pixmaps/firefox.png</userinput></screen>
494
495 <sect3><title>Configuration Information</title>
496
497 <para>
498 The application settings for firefox are accessible by keying
499 <command>about:config</command> in the address bar.
500 </para>
501
502 <para>
503 With this version of <application>firefox</application>, getting
504 working sound can be a problem. Although upstream prefers pulseaudio,
505 on balance using <application>Alsa</application> may be easier.
506 </para>
507
508 <para>
509 If you enabled <application>Alsa</application> for sound, you may need
510 to alter one variable to get working sound. If you run
511 <command>firefox</command> from a term and try to play something with
512 sound you might encounter error messages like:
513 </para>
514
515 <para>
516 <literal>Sandbox: seccomp sandbox violation: pid 3941, tid 4030,
517 syscall 16, args 48 2147767296 139909894784796 0 0 0.</literal>
518 </para>
519
520 <para>
521 That was on x86_64, on i686 the syscall number is 54. To allow this
522 syscall, in <command>about:config</command> change
523 <command>security.sandbox.content.syscall_whitelist</command> to 16
524 (or 54 if using i686).
525 </para>
526
527 <para>
528 If you use <command>pulseaudio</command> in a Desktop Environment, it
529 might already be started by that DE. But if it is not, although
530 firefox-57 managed to start it, firefox-58 did not. If you run
531 <command>firefox</command> from a term and this problem is present,
532 trying to play sound will
533 encounter error messages warning <literal>Can't get cubeb
534 context!</literal>
535 </para>
536
537 <para>
538 The fix for this is to close firefox, start pulseaudio to check it
539 does start (if not, read the information on Configuring in <xref
540 linkend="pulseaudio"/>) and restart firefox to check it is working.
541 If it now works, add the following to your <filename>~/.xinitrc</filename>:
542<phrase revision="sysv">
543<literal>pulseaudio --verbose --log-target=syslog&amp;</literal></phrase>
544<phrase revision="systemd">
545<literal>pulseaudio --verbose --log-target=journald&amp;</literal></phrase>
546 (unfortunately, on some systems this does not work).
547 </para>
548
549 <para>
550 You may wish to use multiple profiles within firefox. To do that, invoke
551 firefox as <command>firefox --ProfileManager</command>. You can also
552 check which profile is currently in use from
553 <command>about:profiles</command>.
554 </para>
555
556 </sect3>
557 </sect2>
558
559 <sect2 role="content">
560 <title>Contents</title>
561
562 <segmentedlist>
563 <segtitle>Installed Programs</segtitle>
564 <segtitle>Installed Libraries</segtitle>
565 <segtitle>Installed Directory</segtitle>
566
567 <seglistitem>
568 <seg>
569 firefox
570 </seg>
571 <seg>
572 Numerous libraries, browser components, plugins, extensions, and
573 helper modules installed in /usr/lib/firefox
574 </seg>
575 <seg>
576 /usr/lib/firefox and /usr/lib/mozilla
577 </seg>
578 </seglistitem>
579 </segmentedlist>
580
581 <variablelist>
582 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
583 <?dbfo list-presentation="list"?>
584 <?dbhtml list-presentation="table"?>
585
586 <varlistentry id="firefox-prog">
587 <term><command>firefox</command></term>
588 <listitem>
589 <para>
590 is a <application>GTK+-3</application> internet browser that uses
591 the Mozilla Gecko rendering engine.
592 </para>
593 <indexterm zone="firefox firefox-prog">
594 <primary sortas="b-firefox">firefox</primary>
595 </indexterm>
596 </listitem>
597 </varlistentry>
598
599 </variablelist>
600
601 </sect2>
602
603</sect1>
Note: See TracBrowser for help on using the repository browser.