source: xsoft/other/thunderbird.xml@ 25c7b8d

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY thunderbird-download-http "&mozilla-http;/thunderbird/releases/&thunderbird-version;esr/source/thunderbird-&thunderbird-version;esr.source.tar.xz">
  <!ENTITY thunderbird-download-ftp  " ">
  <!ENTITY thunderbird-md5sum        "f20899eb706a94076ac88dfe97cc7a88">
  <!ENTITY thunderbird-size          "642 MB">
  <!ENTITY thunderbird-buildsize     "7.8 GB (256 MB installed)">
  <!ENTITY thunderbird-time          "16 SBU (on a 8-core machine)">
  <!-- Removed the -j1 time because python and rust do not obey it, although
       the C/C++ code appears to obey it.

       Version 102.3.3: I disabled all but 4 cores.  SBU was 20 (2019 seconds)
       -->
]>

<sect1 id="thunderbird" xreflabel="Thunderbird-&thunderbird-version;esr">
  <?dbhtml filename="thunderbird.html" ?>


  <title>Thunderbird-&thunderbird-version;esr</title>

  <indexterm zone="thunderbird">
    <primary sortas="a-Thunderbird">Thunderbird</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Thunderbird</title>

    <para>
      <application>Thunderbird</application> is a stand-alone mail/news client
      based on the <application>Mozilla</application> codebase. It uses the
      Gecko rendering engine to enable it to display and compose HTML emails.
    </para>

    &lfs121_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&thunderbird-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&thunderbird-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &thunderbird-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &thunderbird-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &thunderbird-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &thunderbird-time;
        </para>
      </listitem>
    </itemizedlist>


    <bridgehead renderas="sect3">Thunderbird Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cbindgen"/>,
      <xref linkend="dbus-glib"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="llvm"/> including clang, <!-- used by default if found -->
      <xref linkend="nodejs"/>,
      <xref linkend="pulseaudio"/> (or <xref linkend="alsa-lib"/> if you edit
      the mozconfig; although it is now deprecated by mozilla),
      <xref linkend="python3"/> (rebuilt with the sqlite module),
      <xref linkend="startup-notification"/>, and
      <xref linkend="unzip"/>
      <!--<xref linkend="yasm"/>-->
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <!-- When using system ICU, a problem occurs where the calendar and mail
           functions do not render correctly and it causes other strange
           behavior to occur. See Ticket #18323 for more details, as well as
           https://lore.kernel.org/distributions/075a20b1-869b-78f3-9ace-e106a4d43ac4@linuxlounge.net/T/#u -->
      <!--<xref linkend="icu"/>,-->
      <xref linkend="libevent"/>,
      <xref linkend="libvpx"/>,
      <xref linkend="libwebp"/>,
      <xref linkend="nasm"/>,
      <xref linkend="nspr"/>, and
      <xref linkend="nss"/>
    </para>

    <note>
      <para>
        If you don't install recommended dependencies,
        then internal copies of those packages will
        be used. They might be tested to work, but
        they can be out of date or contain security
        holes.
      </para>
    </note>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref role="runtime" linkend="pciutils"/> (runtime),
      <xref linkend="wget"/>,
      <xref linkend="wireless_tools"/>, and
      <ulink url="https://facebook.github.io/watchman/">watchman</ulink>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Thunderbird</title>

    <note>
      <para>
        The build process for Thunderbird can use 8GB+ of RAM when linking.
        Make sure that you have adequate swap or RAM before continuing.
      </para>
    </note>

 <!-- Restore after Python 3.12 is usable for this package again
    <para>
      The building system ships several internal copies of the Python 3
      modules <application>setuptools</application> and
      <filename>six.py</filename>.  The shipped copies are too old
      to work well with Python 3.12 or later.  Replace them with the
      symlinks to the LFS <application>setuptools</application> package and
      <xref linkend='six'/> already installed on the system, and adapt the
      building system for these updated Python modules.  We also need to
      rewrite the code based on the <filename>imp</filename> module removed
      in Python 3.12 and later using the <filename>importlib</filename>
      module:
    </para>

<screen><userinput>(for i in $(find -name six.py); do
   ln -sfv /usr/lib/python&python3-majorver;/site-packages/six.py $i
   [ $? = 0 ] || exit $?
 done) &amp;&amp;

sed '/ConfigParser/s/Safe//'                          \
    -i testing/mozbase/mozprofile/mozprofile/prefs.py &amp;&amp;

(for i in setuptools distutils-precedence.pth  \
          pkg_resources _distutils_hack; do
   rm -rf third_party/python/setuptools/$i     &amp;&amp;
   ln -sv /usr/lib/python&python3-majorver;/site-packages/$i \
          third_party/python/setuptools
   [ $? = 0 ] || exit $?
 done) &amp;&amp;

sed 's/distutils/setuptools._&amp;/'            \
    -i python/mozbuild/mozbuild/nodeutil.py &amp;&amp;

sed -e '/^import/s/imp$/importlib.util/'             \
    -e 's/imp.new_module/__import__/'                \
    -e "s/imp.load_source\(.*\)/spec =               \
        importlib.util.spec_from_file_location\1;    \
        mod = importlib.util.module_from_spec(spec); \
        spec.loader.exec_module(mod)/" -i python/mach/mach/main.py &amp;&amp;
sed '/import imp/d' -i netwerk/dns/prepare_tlds.py
</userinput></screen>
-->

    <para>
      The configuration of <application>Thunderbird</application> is
      accomplished by creating a <filename>mozconfig</filename> file containing
      the desired configuration options. A default
      <filename>mozconfig</filename> is created below. To see the entire list
      of available configuration options (and a brief description of each),
      issue <command>./mach configure -- --help | less</command>. Create the file with
      the following command:
    </para>

<screen><userinput>cat &gt; mozconfig &lt;&lt; "EOF"
<literal># If you have a multicore machine, all cores will be used.

# If you have installed wireless-tools comment out this line:
ac_add_options --disable-necko-wifi

# Uncomment the following option if you have not installed PulseAudio
#ac_add_options --enable-audio-backends=alsa

# Comment out following options if you have not installed
# recommended dependencies:
ac_add_options --with-system-libevent
ac_add_options --with-system-libvpx
ac_add_options --with-system-nspr
ac_add_options --with-system-nss
ac_add_options --with-system-webp
<!-- With Thunderbird ESR 128 we'd replace the following part with
"- -enable-elf-hack=relr", or remove it if relr becomes the default. -->
# on some machines. It is supposed to improve startup time and it shrinks
# libxul.so by a few MB.  With recent Binutils releases the linker already
# supports a much safer and generic way for this.
ac_add_options --disable-elf-hack
export LDFLAGS="$LDFLAGS -Wl,-z,pack-relative-relocs"

# The BLFS editors recommend not changing anything below this line:
ac_add_options --prefix=/usr
ac_add_options --enable-application=comm/mail

ac_add_options --disable-crashreporter
ac_add_options --disable-updater
ac_add_options --disable-debug
ac_add_options --disable-debug-symbols
ac_add_options --disable-tests

# The SIMD code relies on the unmaintained packed_simd crate which
# fails to build with Rustc >= 1.78.0.  We may re-enable it once
# Mozilla port the code to use std::simd and std::simd is stabilized.
ac_add_options --disable-rust-simd

ac_add_options --enable-strip
ac_add_options --enable-install-strip

# You cannot distribute the binary if you do this.
ac_add_options --enable-official-branding

ac_add_options --enable-system-ffi
ac_add_options --enable-system-pixman

ac_add_options --with-system-jpeg
ac_add_options --with-system-png
ac_add_options --with-system-zlib

# Using sandboxed wasm libraries has been moved to all builds instead
# of only mozilla automation builds. It requires extra llvm packages
# and was reported to seriously slow the build. Disable it.
ac_add_options --without-wasm-sandboxed-libraries</literal>
EOF</userinput></screen>

    <!-- https://github.com/rust-lang/rust-bindgen/pull/2689 -->
<!--
    <para>
      Adapt the shipped <application>rust-bindgen</application> copy for
      LLVM-18 and later, and tell <command>cargo</command> we've modified
      the code of <application>rust-bindgen</application> so the checksum
      verification of this crate should be skipped:
    </para>

    <screen><userinput>sed -e "/match cursor.kind()/a                                    \
        CXCursor_LinkageSpec => return Err(ParseError::Recurse)," \
    -i third_party/rust/bindgen/ir/item.rs                        &amp;&amp;

cat &gt;&gt; Cargo.toml &lt;&lt; EOF &amp;&amp;
<literal>[patch.crates-io.bindgen_0_64_0]
package = "bindgen"
version = "0.64.0"
path = "third_party/rust/bindgen"</literal>
EOF

sed -r '/name = "bindgen"/,+5 s/^source|^checksum/#&amp;/' \
    -i Cargo.lock</userinput></screen>
-->

    <!-- https://hg.mozilla.org/mozilla-central/rev/ba6abbd36b49 -->
<!--
    <para>
      Adapt the WebRTC code to use 64-bit timestamp to fix a build
      failure with Clang-18 and later:
    </para>

    <screen><userinput>sed 's/uint32_t timestamp/uint64_t timestamp/'                \
    -i dom/media/gmp-plugin-openh264/gmp-fake-openh264.cpp    \
       dom/media/gtest/TestGMPRemoveAndDelete.cpp             \
       dom/media/webrtc/libwebrtcglue/WebrtcGmpVideoCodec.cpp &amp;&amp;

sed '/mInputImageMap/s/uint32_t/uint64_t/' \
    -i dom/media/webrtc/libwebrtcglue/WebrtcGmpVideoCodec.h</userinput></screen>

    <para>
      Remove several lines of Rust code only useful for ARM and failing to
      compile with Rustc-1.78.0 or newer:
    </para>

    <screen><userinput>sed '/cfg_attr/,/)]/d' -i gfx/qcms/src/lib.rs</userinput></screen>
-->

    <para>
      Now invoke the Python <command>mach</command> script to compile
      <application>Thunderbird</application>:
    </para>

    <note>
      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
       href="../../xincludes/mozshm.xml"/>
    </note>

<screen><userinput>export MACH_BUILD_PYTHON_NATIVE_PACKAGE_SOURCE=none &amp;&amp;
export MOZBUILD_STATE_PATH=$(pwd)/mozbuild          &amp;&amp;
./mach build</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Install <application>Thunderbird</application> by running the following
      commands as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>MACH_BUILD_PYTHON_NATIVE_PACKAGE_SOURCE=none ./mach install</userinput></screen>
<!-- devs: For DESTDIR install, prepend DESTDIR=<dest> to the above -->

    <para>
      Empty the environment variables which were set above:
    </para>

<screen><userinput>unset MACH_BUILD_PYTHON_NATIVE_PACKAGE_SOURCE &amp;&amp;
unset MOZBUILD_STATE_PATH</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <command>MACH_BUILD_PYTHON_NATIVE_PACKAGE_SOURCE=none</command>: Use the
      system python to create a virtual environment for <command>mach</command>
      without downloading any python wheels nor using the system python modules.
      This prevent version mismatches between system modules and bundled ones.
    </para>

<!--
    <para>
      <command>./mach configure</command>: This validates the supplied
      dependencies and the <filename>mozconfig</filename>.
    </para>
-->

    <para>
      <option>./mach build --verbose</option>: Use this alternative if you
      need details of which files are being compiled, together with any C or
      C++ flags being used.
    </para>

    <para>
      <option>./mach build -jN</option>: The build should, by default, use
      all the online CPU cores. If using all the cores causes the build to swap
      because you have insufficient memory, using fewer cores can be faster.
    </para>

    <para>
      <option><envar>CC=gcc CXX=g++</envar></option>: BLFS used to
      prefer to use gcc and g++ instead of upstream's defaults of the
      <application>clang</application> programs. With the release of
      gcc-12 the build takes longer with gcc and g++, primarily because
      of extra warnings, and is bigger. Set these environment variables
      <emphasis>before you run the configure script</emphasis>
      if you wish to continue to use gcc, g++. Building
      with GCC on i?86 is currently broken.
    </para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Thunderbird</title>

    <sect3><title>Configuration Information</title>

      <para>
        If your Window Manager or Desktop Environment does not allow you to
        configure a default browser, you can add a configuration parameter to
        <application>Thunderbird</application> so that a browser will start when
        you click on an Internet/intranet/local URL. The procedure to check
        or modify any of the configuration parameters is quite simple and the
        instructions here can be used to view or modify any of the parameters.
      </para>

      <para>
        First, open the configuration dialog by opening the <quote>Edit</quote>
        drop-down menu. Choose <quote>Settings</quote> and then scroll down
        to the bottom of the page. Then, click the <quote>Config Editor</quote>
        button. Click on the <quote>I accept the risk!</quote> button.
        This will display a list of the configuration preferences and
        information related to each one. You can use the <quote>Filter:</quote>
        bar to enter search criteria and narrow down the listed items. Changing
        a preference can be done using two methods. One, if the preference has a
        boolean value (True/False), simply double-click on the preference to
        toggle the value and two, for other preferences simply right-click on
        the desired line, choose <quote>Modify</quote> from the menu and change
        the value. Creating new preference items is accomplished in the same
        way, except choose <quote>New</quote> from the menu and provide the
        desired data into the fields when prompted.
      </para>

 <!-- Doesn't seem to be present anymore in 128.0
      <para>
        The configuration preference item you need to check so that
        <application>Thunderbird</application> uses a specified browser is the
        <parameter>network.protocol-handler.app.http</parameter> which should be
        set to the path of the desired browser, e.g.
        <option>/usr/bin/firefox</option>.
     </para>
-->
<!--  Bad URL
      <tip>
        <para>
          There is a multitude of configuration parameters you can tweak to
          customize <application>Thunderbird</application>. A very extensive,
          but not so up-to-date list of these parameters can be found at
          <ulink url="http://preferential.mozdev.org/preferences.html"/>.
        </para>
      </tip>
-->
    <para>

      If you use a desktop environment such as <application>GNOME</application>
      or <application>KDE</application>, a desktop file
      <filename>thunderbird.desktop</filename> may be created, in order to
      include a <quote><application>Thunderbird</application></quote> entry in
      the menu. <!--If you didn't enable
      <application>startup-notification</application> in your mozconfig, then
      change the StartupNotify line to false.--> Run the following commands as the
      <systemitem class="username">root</systemitem> user:

    </para>

<screen role="root"><userinput>mkdir -pv /usr/share/{applications,pixmaps} &amp;&amp;

cat &gt; /usr/share/applications/thunderbird.desktop &lt;&lt; "EOF" &amp;&amp;
<literal>[Desktop Entry]
Name=Thunderbird Mail
Comment=Send and receive mail with Thunderbird
GenericName=Mail Client
Exec=thunderbird %u
Terminal=false
Type=Application
Icon=thunderbird
Categories=Network;Email;
MimeType=text/html;text/xml;application/xhtml+xml;application/xml;application/rss+xml;x-scheme-handler/mailto;
StartupNotify=true</literal>
EOF

ln -sfv /usr/lib/thunderbird/chrome/icons/default/default256.png \
        /usr/share/pixmaps/thunderbird.png</userinput></screen>
    </sect3>
  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          thunderbird
        </seg>
        <seg>
          Numerous libraries and modules in the /usr/lib/thunderbird directory
        </seg>
        <seg>
          /usr/lib/thunderbird
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="thunderbird-prog">
        <term><command>thunderbird</command></term>
        <listitem>
          <para>
            is <application>Mozilla</application>'s email and newsgroup client
          </para>
          <indexterm zone="thunderbird thunderbird-prog">
            <primary sortas="b-thunderbird">thunderbird</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>