source: xsoft/graphweb/firefox.xml@ b6ddf49

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since b6ddf49 was 42ddc30, checked in by Xi Ruoyao <xry111@…>, 12 months ago

treewide: Replace "User Notes" with "Editor Notes"

  • 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;esr/source/firefox-&firefox-version;esr.source.tar.xz">
8 <!ENTITY firefox-download-ftp " ">
9 <!ENTITY firefox-md5sum "2d23d6194f285fea5693b2550851720c">
10 <!ENTITY firefox-size "461 MB">
11
12 <!-- NB with stylo, much of the build uses rust, and therefore cargo files.
13 But the extra cached cargo files, if any, seem to be minimal -->
14 <!ENTITY firefox-buildsize "7.0 GB (199 MB installed) without tests">
15 <!-- editors: with ff63 and rust-1.29, ./mach build -j4 is probably the
16 most practical way to get a timing on a machine with more cores, if taking
17 cores offline is not practical. If in doubt, round up -->
18 <!ENTITY firefox-time "19 SBU using -j4, without tests">
19]>
20
21<sect1 id="firefox" xreflabel="Firefox-&firefox-version;">
22 <?dbhtml filename="firefox.html" ?>
23
24
25<!-- indicate this is the ESR variant,
26 The point was that the 102.0 stable release differed slightly.
27 <title>Firefox-&firefox-version;</title>-->
28 <title>Firefox-&firefox-version;esr</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 &lfs113_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 Required patch:
83 <ulink url="&patch-root;/firefox-&firefox-version;-consolidated-1.patch"/>
84 </para>
85 </listitem>
86 <listitem>
87 <para>
88 Required patch for new <xref linkend="ffmpeg"/> API:
89 <ulink url="&patch-root;/firefox-&firefox-version;-ffmpeg_6-1.patch"/>
90 </para>
91 </listitem>
92 </itemizedlist>
93
94 <note>
95 <para>
96 The directory name is firefox-&firefox-version;
97 </para>
98
99 <para>
100 Extracting the tarball
101 will reset the permissions of the current directory to 0755 if you
102 have permission to do that. If you do this in a directory where
103 the sticky bit is set, such
104 as <filename class="directory">/tmp</filename> it will end with error
105 messages:
106 </para>
107
108<literallayout>tar: .: Cannot utime: Operation not permitted
109tar: .: Cannot change mode to rwxr-xr-t: Operation not permitted
110tar: Exiting with failure status due to previous errors
111</literallayout>
112
113 <para>
114 This does finish with non-zero status, but it does
115 <emphasis>NOT</emphasis> mean there is a real problem.
116 Do not untar as the <systemitem class="username">root</systemitem> user
117 in a directory where the sticky bit is set - that will unset it.
118 </para>
119
120 <para>
121 As with other large packages which use C++ (or rust), the SBU times
122 to build this vary more widely than you might expect. The build times
123 will increase significantly if your machine has to swap.
124 </para>
125
126 <para>
127 Although upstream prefer to use <application>PulseAudio</application>,
128 for the moment <application>Alsa</application> can still be used. Both
129 may need runtime configuration to get sound working.
130 </para>
131 </note>
132
133 <bridgehead renderas="sect3">Firefox Dependencies</bridgehead>
134
135 <bridgehead renderas="sect4">Required</bridgehead>
136 <para role="required">
137 <xref linkend="autoconf213"/>,
138 <xref linkend="cbindgen"/>,
139 <xref linkend="dbus-glib"/>,
140 <xref linkend="gtk3"/>,
141 <xref linkend="libnotify"/>,
142 <xref linkend="llvm"/> (with clang, used for bindgen even if using gcc),
143 <xref linkend="nodejs"/>,
144 <xref linkend="pulseaudio"/>
145 (or
146 <xref linkend="alsa-lib"/> if you edit the mozconfig;
147 now deprecated by mozilla), in either case please read the
148 Configuration Information,
149 <xref linkend="python3"/> (rebuilt after installing <xref linkend="sqlite"/>),
150 <xref linkend="startup-notification"/>,
151 <xref linkend="unzip"/>,
152 <xref linkend="yasm"/>, and
153 <xref linkend="zip"/>
154 </para>
155
156 <bridgehead renderas="sect4">Recommended</bridgehead>
157 <para role="recommended">
158 <xref linkend="icu"/>,
159 <xref linkend="libevent"/>,
160 <xref linkend="libvpx"/>,
161 <xref linkend="libwebp"/>,
162 <xref linkend="nasm"/>,
163 <xref linkend="nss"/>
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="doxygen"/>,
178 <xref role="runtime" linkend="ffmpeg"/> (runtime, to play mov, mp3 or mp4 files),
179 <xref linkend="liboauth"/>,
180 <xref linkend="valgrind"/>,
181 <xref linkend="wget"/>,
182 <xref linkend="wireless_tools"/>,
183 <ulink url="https://github.com/libproxy/libproxy">libproxy</ulink>
184 </para>
185
186 <para condition="html" role="usernotes">
187 Editor Notes: <ulink url="&blfs-wiki;/firefox"/>
188 </para>
189 </sect2>
190
191 <sect2 role="installation">
192 <title>Installation of Firefox</title>
193
194 <para>
195 The configuration of <application>Firefox</application> is accomplished
196 by creating a <filename>mozconfig</filename> file containing the desired
197 configuration options. A default <filename>mozconfig</filename> is
198 created below. To see the entire list of available configuration options
199 (and an abbreviated description of some of them), issue <command>./mach
200 configure -- --help | less</command>. You may also
201 wish to review the entire file and uncomment any other desired options.
202 Create the file by issuing the following command:
203 </para>
204
205<screen><userinput>cat &gt; mozconfig &lt;&lt; "EOF"
206<literal># If you have a multicore machine, all cores will be used by default.
207
208# If you have installed (or will install) wireless-tools, and you wish
209# to use geolocation web services, comment out this line
210ac_add_options --disable-necko-wifi
211
212# API Keys for geolocation APIs - necko-wifi (above) is required for MLS
213# Uncomment the following line if you wish to use Mozilla Location Service
214#ac_add_options --with-mozilla-api-keyfile=$PWD/mozilla-key
215
216# Uncomment the following line if you wish to use Google's geolocation API
217# (needed for use with saved maps with Google Maps)
218#ac_add_options --with-google-location-service-api-keyfile=$PWD/google-key
219
220# startup-notification is required since firefox-78
221
222# Uncomment the following option if you have not installed PulseAudio and
223# want to use alsa instead
224#ac_add_options --enable-audio-backends=alsa
225
226# Comment out following options if you have not installed
227# recommended dependencies:
228ac_add_options --with-system-icu
229ac_add_options --with-system-libevent
230ac_add_options --with-system-libvpx
231ac_add_options --with-system-nspr
232ac_add_options --with-system-nss
233ac_add_options --with-system-webp
234
235# Unlike with thunderbird, although using the gold linker can
236# save four megabytes in the installed file it does not make
237# the build faster.
238
239# libdav1d (av1 decoder) requires nasm. Uncomment this if nasm
240# has not been installed. Do not uncomment this if you have
241# ffmpeg installed.
242#ac_add_options --disable-av1
243
244# You cannot distribute the binary if you do this
245ac_add_options --enable-official-branding
246
247# Stripping is now enabled by default.
248# Uncomment these lines if you need to run a debugger:
249#ac_add_options --disable-strip
250#ac_add_options --disable-install-strip
251
252# Disabling debug symbols makes the build much smaller and a little
253# faster. Comment this if you need to run a debugger. Note: This is
254# required for compilation on i686.
255ac_add_options --disable-debug-symbols
256
257# The elf-hack is reported to cause failed installs (after successful builds)
258# on some machines. It is supposed to improve startup time and it shrinks
259# libxul.so by a few MB - comment this if you know your machine is not affected.
260ac_add_options --disable-elf-hack
261
262# The BLFS editors recommend not changing anything below this line:
263ac_add_options --prefix=/usr
264ac_add_options --enable-application=browser
265ac_add_options --disable-crashreporter
266ac_add_options --disable-updater
267# enabling the tests will use a lot more space and significantly
268# increase the build time, for no obvious benefit.
269ac_add_options --disable-tests
270
271# The default level of optimization again produces a working build with gcc.
272ac_add_options --enable-optimize
273
274ac_add_options --enable-system-ffi
275ac_add_options --enable-system-pixman
276
277ac_add_options --with-system-jpeg
278ac_add_options --with-system-png
279ac_add_options --with-system-zlib
280
281# Using sandboxed wasm libraries has been moved to all builds instead
282# of only mozilla automation builds. It requires extra llvm packages
283# and was reported to seriously slow the build. Disable it.
284ac_add_options --without-wasm-sandboxed-libraries
285
286# The following option unsets Telemetry Reporting. With the Addons Fiasco,
287# Mozilla was found to be collecting user's data, including saved passwords and
288# web form data, without users consent. Mozilla was also found shipping updates
289# to systems without the user's knowledge or permission.
290# As a result of this, use the following command to permanently disable
291# telemetry reporting in Firefox.
292unset MOZ_TELEMETRY_REPORTING
293
294mk_add_options MOZ_OBJDIR=@TOPSRCDIR@/firefox-build-dir</literal>
295EOF</userinput></screen>
296
297 <para>
298 Compile <application>Firefox</application> by issuing the following
299 commands:
300 </para>
301<!-- Fixed in 102.9
302 <para>
303 A change in cbindgen-0.24.2 causes a symbol to now be output by
304 cbindgen, but it has already been defined in a header. This sed
305 prevents the build from eventually failing:
306 </para>
307
308<screen><userinput>sed -i '/ROOT_CLIP_CHAIN/d' gfx/webrender_bindings/webrender_ffi.h</userinput></screen>
309-->
310<!-- Not needed with clang. Upstream bug at
311 https://bugzilla.mozilla.org/show_bug.cgi?id=1729459
312
313 <para>
314 If building on a 32 bit machine, the following sed works around
315 an issue with an incompatible <quote>double</quote> type in one
316 header file:
317 </para>
318
319<screen><userinput>case "$(uname -m)" in
320 i?86) sed -e '/typedef[ ]*double/s/double/long double/' \
321 -i modules/fdlibm/src/math_private.h ;;
322esac</userinput></screen>
323-->
324 <para>
325 If the geolocation APIs are needed:
326 </para>
327
328 <note>
329 <para>
330 <!-- Taken from Arch Linux - an immensely helpful link - Thanks -->
331 The Google and Mozilla API Keys below are specific to LFS. If using
332 these instructions for another distro, or if you intend to distribute
333 binary copies of the software using these instructions, please obtain
334 your own keys following the instructions located at
335 <ulink url="https://www.chromium.org/developers/how-tos/api-keys"/> and
336 <ulink url="https://location.services.mozilla.com/api"/> respectively.
337 <!-- BLFS Devs, register an account at Google with your
338 @linuxfromscratch.org email address, and I'll make you an administrator
339 for the 'Google APIs for LFS' project (where the API and OAuth keys
340 were created for use in the book).-->
341 </para>
342 </note>
343
344<screen><userinput>echo "AIzaSyDxKL42zsPjbke5O8_rPVpVrLrJ8aeE9rQ" > google-key
345echo "613364a7-9418-4c86-bcee-57e32fd70c23" > mozilla-key</userinput></screen>
346
347 <note>
348
349 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
350 href="../../xincludes/mozshm.xml"/>
351
352 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
353 href="../../xincludes/mozmach.xml"/>
354
355 </note>
356
357 <para>
358 Fix building Firefox with Clang 16 or C++ headers from GCC 13.
359 And, work around a build failure with Rustc-1.70.0:
360 </para>
361
362<screen><userinput remap="pre">patch -Np1 -i ../firefox-&firefox-version;-consolidated-1.patch</userinput></screen>
363
364 <para>
365 Apply the following patch so that firefox is able to play H.264 videos:
366 </para>
367
368<screen><userinput remap="pre">patch -Np1 -i ../firefox-&firefox-version;-ffmpeg_6-1.patch</userinput></screen>
369
370 <para>
371 Now invoke the Python <command>mach</command> script to compile the package.
372 </para>
373
374<screen><userinput>export MACH_BUILD_PYTHON_NATIVE_PACKAGE_SOURCE=none &amp;&amp;
375export MOZBUILD_STATE_PATH=${PWD}/mozbuild &amp;&amp;
376./mach configure &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_BUILD_PYTHON_NATIVE_PACKAGE_SOURCE=none ./mach install</userinput></screen>
395
396 <para>
397 Empty the environment variables which were set above:
398 </para>
399
400<screen><userinput>unset MACH_BUILD_PYTHON_NATIVE_PACKAGE_SOURCE MOZBUILD_STATE_PATH</userinput></screen>
401
402 </sect2>
403
404 <sect2 role="commands">
405 <title>Command Explanations</title>
406
407<!--<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
408 href="../../xincludes/SIOCGSTAMP.xml"/>-->
409
410 <para>
411 <command>export MOZBUILD_STATE_PATH=${PWD}/mozbuild</command>: The build
412 is now supposed to tell you that it intends to create <filename
413 class="directory">~/.mozbuild</filename>, and offer you an option to
414 press &lt;ENTER&gt; to accept this, or Ctrl-C to cancel and restart the
415 build after specifying the directory. In practice, the message may not
416 appear until after &lt;ENTER&gt; is keyed, i.e. the build stalls.
417 </para>
418
419 <para>
420 That directory is used for a (probably random) telemetry identifier.
421 Creating this in the build directory, and deleting that after the
422 installation, prevents it being used. If you wish to participate in
423 telemetry, export MOZBUILD_STATE_PATH to point to its default directory
424 and remove the entry from the <filename>mozconfig</filename>.
425 </para>
426
427 <para>
428 <command>MACH_BUILD_PYTHON_NATIVE_PACKAGE_SOURCE=none</command>: Use the
429 system python to create a virtual environment for <command>mach</command>
430 without downloading any python wheels nor using the system python modules.
431 This prevent version mismatches between system modules and bundled ones.
432 </para>
433
434 <para>
435 <command>./mach configure</command>: This validates the supplied
436 dependencies and the <filename>mozconfig</filename>.
437 </para>
438
439 <para>
440 <option>./mach build --verbose</option>: Use this alternative if you
441 need details of which files are being compiled, together with any C or
442 C++ flags being used. But do not add '--verbose' to the install command
443 since it is not accepted there.
444 </para>
445
446 <para>
447 <option>./mach build -jN</option>: The build should, by default, use
448 all the online CPU cores. If using all the cores causes the build to swap
449 because you have insufficient memory, using fewer cores can be faster.
450 </para>
451
452 <para>
453 <option><envar>CC=gcc CXX=g++</envar></option>: BLFS used to
454 prefer to use gcc and g++ instead of upstream's defaults of the
455 <application>clang</application> programs. With the release of
456 gcc-12 the build takes longer with gcc and g++, primarily because
457 of extra warnings, and is bigger. Set these environment variables
458 <emphasis>before you run the configure script</emphasis>
459 if you wish to continue to use gcc, g++. Building
460 with GCC on i?86 is currently broken.
461 </para>
462
463 </sect2>
464
465 <sect2 role="configuration">
466 <title>Configuring Firefox</title>
467
468 <para>
469 If you use a desktop environment like <application>Gnome</application> or
470 <application>KDE</application> you may want to create a
471 <filename>firefox.desktop</filename> file so that
472 <application>Firefox</application> appears in the panel's menus.
473 As the &root; user:
474 </para>
475
476<screen role="root"><userinput>mkdir -pv /usr/share/applications &amp;&amp;
477mkdir -pv /usr/share/pixmaps &amp;&amp;
478
479MIMETYPE="text/xml;text/mml;text/html;" &amp;&amp;
480MIMETYPE+="application/xhtml+xml;application/vnd.mozilla.xul+xml;" &amp;&amp;
481MIMETYPE+="x-scheme-handler/http;x-scheme-handler/https" &amp;&amp;
482
483cat &gt; /usr/share/applications/firefox.desktop &lt;&lt; EOF &amp;&amp;
484<literal>[Desktop Entry]
485Encoding=UTF-8
486Name=Firefox Web Browser
487Comment=Browse the World Wide Web
488GenericName=Web Browser
489Exec=firefox %u
490Terminal=false
491Type=Application
492Icon=firefox
493Categories=GNOME;GTK;Network;WebBrowser;
494MimeType=$MIMETYPE
495StartupNotify=true</literal>
496EOF
497
498unset MIMETYPE &amp;&amp;
499
500ln -sfv /usr/lib/firefox/browser/chrome/icons/default/default128.png \
501 /usr/share/pixmaps/firefox.png</userinput></screen>
502
503 <sect3><title>Configuration Information</title>
504
505 <para>
506 The application settings for firefox are accessible by keying
507 <command>about:config</command> in the address bar.
508 </para>
509
510 <para>
511 Occasionally, getting working sound in
512 <application>firefox</application> can be a problem. Although upstream
513 prefers pulseaudio,
514 on balance using <application>Alsa</application> may be easier.
515 </para>
516
517 <para>
518 If you enabled <application>Alsa</application> for sound, you may need
519 to alter one variable to get working sound. If you run
520 <command>firefox</command> from a terminal and try to play something
521 with sound you might encounter error messages like:
522 </para>
523
524 <para>
525 <literal>Sandbox: seccomp sandbox violation: pid 3941, tid 4030,
526 syscall 16, args 48 2147767296 139909894784796 0 0 0.</literal>
527 </para>
528
529 <para>
530 That was on x86_64, on i686 the syscall number is 54. To allow this
531 syscall, in <command>about:config</command> change
532 <command>security.sandbox.content.syscall_whitelist</command> to 16
533 (or 54 if using i686).
534 </para>
535
536 <para>
537 If you use <command>pulseaudio</command> in a Desktop Environment, it
538 might already be started by that DE. But if it is not, although
539 firefox-57 managed to start it, firefox-58 did not. If you run
540 <command>firefox</command> from a terminal and this problem is present,
541 trying to play sound will
542 encounter error messages warning <literal>Can't get cubeb
543 context!</literal>
544 </para>
545
546 <para>
547 The fix for this is to close firefox, start pulseaudio to check it
548 does start (if not, read the information on Configuring in <xref
549 linkend="pulseaudio"/>) and restart firefox to check it is working.
550 If it now works, add the following to your <filename>~/.xinitrc</filename>:
551<phrase revision="sysv">
552<literal>pulseaudio --verbose --log-target=syslog&amp;</literal></phrase>
553<phrase revision="systemd">
554<literal>pulseaudio --verbose --log-target=journald&amp;</literal></phrase>
555 (unfortunately, on some systems this does not work).
556 </para>
557
558 <para>
559 You may wish to use multiple profiles within firefox. To do that, invoke
560 firefox as <command>firefox --ProfileManager</command>. You can also
561 check which profile is currently in use from
562 <command>about:profiles</command>.
563 </para>
564
565 <para>
566 Although WebRender (using the GPU for compositing) is not used by
567 default, it now appears to work well on supported hardware (ATI, Nvidia
568 and Intel GPUs with Mesa-18 or later). For an explanation, please see
569 <ulink
570 url="https://hacks.mozilla.org/2017/10/the-whole-web-at-maximum-fps-how-webrender-gets-rid-of-jank/">hacks.mozilla.org</ulink>.
571 The only downside seems to be that on a machine with limited RAM it might
572 use more RAM.
573 </para>
574
575 <para>
576 To check if WebRender is being used, look in about:support. In the Graphics
577 section, Compositing will either show 'Basic' (i.e. not in use) or
578 'WebRender'. To enable it, go to about:config and change gfx.webrender.all
579 to True. You will need to restart firefox.
580 </para>
581
582 <para>
583 It may be useful to mention the processes from firefox which can appear in
584 <command>top</command> - as well as firefox itself, there may be multiple
585 Web Content processes, and now an RDD Process (Remote Data Decoder) which
586 appears when playing web videos encoded with av1 (libdav1d). If WebRender
587 has been enabled, a GPU Process will also appear when firefox has to
588 repaint (e.g. scrolling, opening a new tab, or playing a video).
589 </para>
590
591 </sect3>
592 </sect2>
593
594 <sect2 role="content">
595 <title>Contents</title>
596
597 <segmentedlist>
598 <segtitle>Installed Programs</segtitle>
599 <segtitle>Installed Libraries</segtitle>
600 <segtitle>Installed Directory</segtitle>
601
602 <seglistitem>
603 <seg>
604 firefox
605 </seg>
606 <seg>
607 Numerous libraries, browser components, plugins, extensions, and
608 helper modules installed in /usr/lib/firefox
609 </seg>
610 <seg>
611 /usr/lib/firefox
612 </seg>
613 </seglistitem>
614 </segmentedlist>
615
616 <variablelist>
617 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
618 <?dbfo list-presentation="list"?>
619 <?dbhtml list-presentation="table"?>
620
621 <varlistentry id="firefox-prog">
622 <term><command>firefox</command></term>
623 <listitem>
624 <para>
625 is a <application>GTK+-3</application> internet browser that uses
626 the Mozilla Gecko rendering engine
627 </para>
628 <indexterm zone="firefox firefox-prog">
629 <primary sortas="b-firefox">firefox</primary>
630 </indexterm>
631 </listitem>
632 </varlistentry>
633
634 </variablelist>
635
636 </sect2>
637
638</sect1>
Note: See TracBrowser for help on using the repository browser.