source: xsoft/graphweb/firefox.xml@ 4d176c4f

elogind
Last change on this file since 4d176c4f was 4d176c4f, checked in by DJ Lucas <dj@…>, 5 years ago

Merge to HEAD 21084.

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

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