source: xsoft/graphweb/firefox.xml@ 9116137c

10.0 10.1 11.0 11.1 11.2 11.3 12.0 9.0 9.1 kea ken/inkscape-core-mods lazarus lxqt plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 9116137c was 9116137c, checked in by Bruce Dubbs <bdubbs@…>, 5 years ago

Update google option in firefox

git-svn-id: svn:// af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 22.8 KB
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
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 "86d63a1460237412d787acaadf82cefe">
10 <!ENTITY firefox-size "269 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.6 GB (156 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 "30 SBU (with parallelism=4) without tests">
20<sect1 id="firefox" xreflabel="Firefox-&firefox-version;">
21 <?dbhtml filename="firefox.html" ?>
23 <sect1info>
24 <othername>$LastChangedBy$</othername>
25 <date>$Date$</date>
26 </sect1info>
28 <title>Firefox-&firefox-version;</title>
30 <indexterm zone="firefox">
31 <primary sortas="a-Firefox">Firefox</primary>
32 </indexterm>
34 <sect2 role="package">
35 <title>Introduction to Firefox</title>
37 <para>
38 <application>Firefox</application> is a stand-alone browser based on the
39 <application>Mozilla</application> codebase.
40 </para>
42 &lfs84_checked;
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>
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>
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>
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
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>
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>
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>
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>
135 <bridgehead renderas="sect3">Firefox Dependencies</bridgehead>
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>
158 <bridgehead renderas="sect4">Recommended</bridgehead>
159 <para role="recommended">
160 <xref linkend="icu"/>,
161 <xref linkend="libevent"/>,
162<!-- fails to build in 65.0 (headers changed)
163 <xref linkend="libvpx"/>, -->
164 <xref linkend="libwebp"/>, and
165 <xref linkend="sqlite"/>
166 </para>
168 <note>
169 <para>
170 If you don't install recommended dependencies, then internal copies of
171 those packages will be used. They might be tested to work, but they can
172 be out of date or contain security holes.
173 </para>
174 </note>
176 <bridgehead renderas="sect4">Optional</bridgehead>
177 <para role="optional">
178 <xref linkend="curl"/>,
179 <xref linkend="dbus-glib"/>,
180 <xref linkend="doxygen"/>,
181 <xref linkend="GConf"/>,
182 <xref role="runtime" linkend="ffmpeg"/> (runtime, to play mov, mp3 or mp4 files),
183 <!-- <phrase revision="sysv"><ulink url="">liboauth</ulink></phrase> -->
184 <xref linkend="liboauth"/>,
185 <xref linkend="openjdk"/>,
186 <xref linkend="startup-notification"/>,
187 <xref linkend="valgrind"/>,
188 <xref linkend="wget"/>,
189 <xref linkend="wireless_tools"/>,
190 <ulink url="">libproxy</ulink>,
191 and (with the patch)
192 <xref linkend="graphite2"/> and
193 <xref linkend="harfbuzz"/>
194 </para>
196 <para condition="html" role="usernotes">
197 User Notes: <ulink url="&blfs-wiki;/firefox"/>
198 </para>
199 </sect2>
201 <sect2 role="installation">
202 <title>Installation of Firefox</title>
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>
215<screen><userinput>cat &gt; mozconfig &lt;&lt; "EOF"
216<literal># If you have a multicore machine, all cores will be used by default.
218# If you have installed dbus-glib, comment out this line:
219ac_add_options --disable-dbus
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
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
230# Uncomment the following line if you wish to use Google's geolocaton API
231# (needed for use with saved maps with Google Maps)
232#ac_add_options --with-google-location-service-api-keyfile=$PWD/google-key
234# Uncomment this line if you have installed startup-notification:
235#ac_add_options --enable-startup-notification
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
242# If you have installed GConf, comment out this line
243ac_add_options --disable-gconf
245# From firefox-61, the stylo CSS code can no-longer be disabled
247# Comment out following options if you have not installed
248# recommended dependencies:
249ac_add_options --enable-system-sqlite
250ac_add_options --with-system-libevent
251# current firefox fails to build against libvpx-1.8.0
252#ac_add_options --with-system-libvpx
253# firefox-65 understands webp and ships with an included copy
254ac_add_options --with-system-webp
255ac_add_options --with-system-nspr
256ac_add_options --with-system-nss
257ac_add_options --with-system-icu
259# The gold linker is no-longer the default
260ac_add_options --enable-linker=gold
262# The shipped libdavid (av1 decoder) is not built by default,
263# at least on linux, but if nasm is not present libxul tries to
264# link to one of libdavid's objects and fails. It is thought
265# libdavid will be enabled in firefox-67, at which point nasm
266# might be required.
267ac_add_options --disable-av1
269# You cannot distribute the binary if you do this
270ac_add_options --enable-official-branding
272# If you are going to apply the patch for system graphite
273# and system harfbuzz, uncomment these lines:
274#ac_add_options --with-system-graphite2
275#ac_add_options --with-system-harfbuzz
277# Stripping is now enabled by default.
278# Uncomment these lines if you need to run a debugger:
279#ac_add_options --disable-strip
280#ac_add_options --disable-install-strip
282# The BLFS editors recommend not changing anything below this line:
283ac_add_options --prefix=/usr
284ac_add_options --enable-application=browser
286ac_add_options --disable-crashreporter
287ac_add_options --disable-updater
288# enabling the tests will use a lot more space and significantly
289# increase the build time, for no obvious benefit.
290ac_add_options --disable-tests
292# With clang, unlike gcc-7 and later, the default level
293# of optimization produces a working build.
294ac_add_options --enable-optimize
296# From firefox-61 system cairo is not supported
298ac_add_options --enable-system-ffi
299ac_add_options --enable-system-pixman
301# From firefox-62 --with-pthreads is not recognized
303ac_add_options --with-system-bz2
304ac_add_options --with-system-jpeg
305ac_add_options --with-system-png
306ac_add_options --with-system-zlib
308mk_add_options MOZ_OBJDIR=@TOPSRCDIR@/firefox-build-dir</literal>
311 <para>
312 Compile <application>Firefox</application> by issuing the following
313 commands:
314 </para>
316 <para>
317 If you have installed system versions of graphite2 and harfbuzz and wish
318 firefox to use those instead of its shipped versions, apply the patch and
319 uncomment the appropriate entries in the <filename>mozconfig</filename>
320 file.
321 </para>
323<screen><userinput>patch -Np1 -i ../firefox-&firefox-version;-system_graphite2_harfbuzz-1.patch</userinput></screen>
325 <para>
326 If the geolocation APIs are needed:
327 </para>
329 <note>
330 <para>
331 <!-- Taken from Arch Linux - an immensely helpful link - Thanks -->
332 The Google and Mozilla API Keys below are specific to LFS. If using
333 these instructions for another distro, or if you intend to distribute
334 binary copies of the software using these instructions, please obtain
335 your own keys following the instructions located at
336 <ulink url=""/> and
337 <ulink url=""/> respectively.
338 <!-- BLFS Devs, register an account at Google with your
339 email address, and I'll make you an administrator
340 for the 'Google APIs for LFS' project (where the API and OAuth keys
341 were created for use in the book).-->
342 </para>
343 </note>
345<screen><userinput>echo "AIzaSyDxKL42zsPjbke5O8_rPVpVrLrJ8aeE9rQ" > google-key
346echo "d2284a20-0505-4927-a809-7ffaf4d91e55" > mozilla-key</userinput></screen>
348 <note><para>
349 If you are compiling <application>Firefox</application> in chroot, make
350 sure you have <envar>$SHELL</envar> environment variable set or prepend
351 <envar>SHELL=/bin/sh</envar>. Also ensure that <filename>/dev/shm</filename>
352 is mounted.
353 </para></note>
355 <para>
356<!-- Invoke the Python script to compile the package: -->
357 To use the system version of ICU, run a sed to avoid a conflict between
358 upstream ICU's use of <literal>CheckImpl()</literal> in their public headers
359 and firefox's internal use of a different <literal>CheckImpl()</literal>.
360 Then invoke the Python2 script to compile the package.
361 </para>
363<screen><userinput>sed -e 's/checkImpl/checkFFImpl/g' -i js/src/vm/JSContext*.h &amp;&amp;
364export CC=clang CXX=clang++ AR=llvm-ar NM=llvm-nm RANLIB=llvm-ranlib &amp;&amp;
365export MOZBUILD_STATE_PATH=${PWD}/mozbuild &amp;&amp;
366./mach build</userinput></screen>
368 <para>
369 The <filename>mozconfig</filename> above disables the tests because
370 they use a lot more time and disk space for no obvious benefit. If
371 you have nevertheless enabled them, you can run the tests by executing
372 <command>./mach gtest</command>. This will require a network connection,
373 and to be run from within an Xorg session - there is a popup dialog
374 when it fails to connect to ALSA (that does not create a failed test).
375 One or two tests will fail. To see the details of the failure(s) you
376 will need to log the output from that command so that you can review it.
377 </para>
379 <para>
380 Now, as the <systemitem class="username">root</systemitem> user:
381 </para>
383<screen role="root"><userinput>./mach install &amp;&amp;
385mkdir -pv /usr/lib/mozilla/plugins &amp;&amp;
386ln -sfv ../../mozilla/plugins /usr/lib/firefox/browser/</userinput></screen>
388 <para>
389 Set environment variables back to their values:
390 </para>
392<screen><userinput>unset CC CXX AR NM RANLIB MOZBUILD_STATE_PATH</userinput></screen>
394 </sect2>
396 <sect2 role="commands">
397 <title>Command Explanations</title>
399 <para>
400 <command>sed -e 's/checkImpl/checkFFImpl/g' ...</command>: Although the
401 package ships with a modified version of <application>ICU-59</application>
402 and only tests that the system version, if requested, is at least 59,
403 changes in <emphasis>some</emphasis> versions cause builds with the system
404 version to fail with error messages of the form <literal>no void
405 JSContext::checkImpl_NN member function</literal> where NN is the system
406 <application>ICU</application> version. The sed renames the local function.
407 </para>
409 <para>
410 <command>export CC=clang CXX=clang++ ...</command>: Upstream now use
411 <application>clang</application> and building with any recent version
412 saves a lot of space.
413 </para>
415 <para>
416 <command>export MOZBUILD_STATE_PATH=${PWD}/mozbuild</command>: The build
417 is now supposed to tell you that it intends to create <filename
418 class="directory">~/.mozbuild</filename>, and offer you an option to
419 press &lt;ENTER&gt; to accept this, or Ctrl-C to cancel and restart the
420 build after specifying the directory. In practice, the message may not
421 appear until after &lt;ENTER&gt; is keyed, i.e. the build stalls.
422 </para>
424 <para>
425 That directory is used for a (probably random) telemetry identifier.
426 Creating this in the build directory, and deleting that after the
427 installation, prevents it being used. If you wish to participate in
428 telemetry, export MOZBUILD_STATE_PATH to point to its default directory.
429 </para>
431 <para>
432 <command>./mach build</command>: <application>Firefox</application>
433 now uses this <application>python2</application> script to run the
434 build and install.
435 </para>
437 <para>
438 <option>./mach build --verbose</option>: Use this alternative if you
439 need details of which files are being compiled, together with any C or
440 C++ flags being used.
441 </para>
443 <para>
444 <option>./mach build -jN</option>: The build should, by default, use
445 all the online CPU cores. There are two reasons to specify the number
446 of cores, e.g. -j4 for 4 cores: First, if using all the cores causes
447 the build to swap because you have insufficient memory (e.g. for 4 cores
448 a build without system graphite2 and harfbuzz now uses slightly over 8GB
449 of RAM). In such cases, using fewer cores can be faster. Second, on some
450 machines the middle part of the build can drag on as if only one core is
451 present. In those cases, specifying the number of cores may speed up the
452 build.
453 </para>
455 <para>
456 <command>mkdir -pv /usr/lib/mozilla/plugins</command>: This ensures
457 that <filename class="directory">/usr/lib/mozilla/plugins/</filename>
458 exists.
459 </para>
461 <para>
462 <command>ln -sv ... /usr/lib/firefox/browser</command>:
463 This command creates a symbolic link to <filename
464 class="directory">/usr/lib/mozilla/plugins</filename>. It's not really
465 needed, as <application>Firefox</application> checks <filename
466 class="directory">/usr/lib/mozilla/plugins</filename> by default, but the
467 symbolic link is made to keep all the plugins installed in one folder.
468 </para>
470 </sect2>
472 <sect2 role="configuration">
473 <title>Configuring Firefox</title>
475 <para>
476 If you use a desktop environment like <application>Gnome</application> or
477 <application>KDE</application> you may like to create a
478 <filename>firefox.desktop</filename> file so that
479 <application>Firefox</application> appears in the panel's menus. If you
480 didn't enable startup-notification in your mozconfig change the
481 StartupNotify line to false. As the
482 <systemitem class="username">root</systemitem> user:
483 </para>
485<screen role="root"><userinput>mkdir -pv /usr/share/applications &amp;&amp;
486mkdir -pv /usr/share/pixmaps &amp;&amp;
488cat &gt; /usr/share/applications/firefox.desktop &lt;&lt; "EOF" &amp;&amp;
489<literal>[Desktop Entry]
491Name=Firefox Web Browser
492Comment=Browse the World Wide Web
493GenericName=Web Browser
494Exec=firefox %u
503ln -sfv /usr/lib/firefox/browser/chrome/icons/default/default128.png \
504 /usr/share/pixmaps/firefox.png</userinput></screen>
506 <sect3><title>Configuration Information</title>
508 <para>
509 The application settings for firefox are accessible by keying
510 <command>about:config</command> in the address bar.
511 </para>
513 <para>
514 With this version of <application>firefox</application>, getting
515 working sound can be a problem. Although upstream prefers pulseaudio,
516 on balance using <application>Alsa</application> may be easier.
517 </para>
519 <para>
520 If you enabled <application>Alsa</application> for sound, you may need
521 to alter one variable to get working sound. If you run
522 <command>firefox</command> from a term and try to play something with
523 sound you might encounter error messages like:
524 </para>
526 <para>
527 <literal>Sandbox: seccomp sandbox violation: pid 3941, tid 4030,
528 syscall 16, args 48 2147767296 139909894784796 0 0 0.</literal>
529 </para>
531 <para>
532 That was on x86_64, on i686 the syscall number is 54. To allow this
533 syscall, in <command>about:config</command> change
534 <command>security.sandbox.content.syscall_whitelist</command> to 16
535 (or 54 if using i686).
536 </para>
538 <para>
539 If you use <command>pulseaudio</command> in a Desktop Environment, it
540 might already be started by that DE. But if it is not, although
541 firefox-57 managed to start it, firefox-58 did not. If you run
542 <command>firefox</command> from a term and this problem is present,
543 trying to play sound will
544 encounter error messages warning <literal>Can't get cubeb
545 context!</literal>
546 </para>
548 <para>
549 The fix for this is to close firefox, start pulseaudio to check it
550 does start (if not, read the information on Configuring in <xref
551 linkend="pulseaudio"/>) and restart firefox to check it is working.
552 If it now works, add the following to your <filename>~/.xinitrc</filename>:
553<phrase revision="sysv">
554<literal>pulseaudio --verbose --log-target=syslog&amp;</literal></phrase>
555<phrase revision="systemd">
556<literal>pulseaudio --verbose --log-target=journald&amp;</literal></phrase>
557 (unfortunately, on some systems this does not work).
558 </para>
560 <para>
561 You may wish to use multiple profiles within firefox. To do that, invoke
562 firefox as <command>firefox --ProfileManager</command>. You can also
563 check which profile is currently in use from
564 <command>about:profiles</command>.
565 </para>
567 </sect3>
568 </sect2>
570 <sect2 role="content">
571 <title>Contents</title>
573 <segmentedlist>
574 <segtitle>Installed Programs</segtitle>
575 <segtitle>Installed Libraries</segtitle>
576 <segtitle>Installed Directory</segtitle>
578 <seglistitem>
579 <seg>
580 firefox
581 </seg>
582 <seg>
583 Numerous libraries, browser components, plugins, extensions, and
584 helper modules installed in /usr/lib/firefox
585 </seg>
586 <seg>
587 /usr/lib/firefox and /usr/lib/mozilla
588 </seg>
589 </seglistitem>
590 </segmentedlist>
592 <variablelist>
593 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
594 <?dbfo list-presentation="list"?>
595 <?dbhtml list-presentation="table"?>
597 <varlistentry id="firefox-prog">
598 <term><command>firefox</command></term>
599 <listitem>
600 <para>
601 is a <application>GTK+-3</application> internet browser that uses
602 the Mozilla Gecko rendering engine.
603 </para>
604 <indexterm zone="firefox firefox-prog">
605 <primary sortas="b-firefox">firefox</primary>
606 </indexterm>
607 </listitem>
608 </varlistentry>
610 </variablelist>
612 </sect2>
Note: See TracBrowser for help on using the repository browser.