source: xsoft/other/thunderbird.xml@ a41f643

<?xml version="1.0" encoding="ISO-8859-1"?>
<!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     "http://releases.mozilla.org/pub/mozilla.org/thunderbird/releases/&thunderbird-version;/source/thunderbird-&thunderbird-version;.source.tar.bz2">
  <!ENTITY thunderbird-download-ftp      "ftp://ftp.mozilla.org/pub/mozilla.org/thunderbird/releases/&thunderbird-version;/source/thunderbird-&thunderbird-version;.source.tar.bz2">
  <!ENTITY thunderbird-md5sum            "f004aa5ddf2a30b5df96e06df416b0c9">
  <!ENTITY thunderbird-size              "58 MB">
  <!ENTITY thunderbird-buildsize         "624 MB">
  <!ENTITY thunderbird-time              "14 SBU">

  <!ENTITY thunderbird-enigmail-version  "1.0.1">

  <!ENTITY thunderbird-enigmail-download "http://www.mozilla-enigmail.org/download/source/enigmail-&thunderbird-enigmail-version;.tar.gz">
  <!ENTITY thunderbird-enigmail-md5sum   "508ca9ab0396afb49e82eda88014924b">
  <!ENTITY thunderbird-enigmail-size     "1.1 MB">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Thunderbird-&thunderbird-version;</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.</para>

    <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>

    <para>To enable the <application>Enigmail</application> extension to the
    <application>Thunderbird</application> mail client, you'll need to download
    the tarball shown below. The <application>Enigmail</application> extension
    allows users to access the authentication and encryption features provided
    by the <application>GnuPG</application> package. The Enigmail extension
    will not operate correctly unless you have <xref linkend="gnupg"/> or
    <xref linkend="gnupg2"/> installed.</para>

    <itemizedlist spacing='compact'>
      <listitem>
        <para><ulink url="&thunderbird-enigmail-download;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &thunderbird-enigmail-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &thunderbird-enigmail-size;</para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="gtk2"/>,
    <xref linkend="libidl"/>, and
    <xref linkend="zip"/></para>

    <para>Note: <application>libjpeg</application> should have been installed
    before <application>GTK+</application> and should exist on your system. If
    for some reason you haven't installed <application>libjpeg</application>,
    you should remove the <option>--with-system-jpeg</option> option from the
    <filename>.mozconfig</filename> file created below.</para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="nss"/> (if you will be installing
    any other package that utilizes NSS/NSPR, such as
    <application>Firefox</application>, <application>SeaMonkey</application>,
    <application>Evolution</application>, or
    <application>OpenOffice</application>)</para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="unzip"/> and
    <xref linkend="libgnomeui"/> (to build the gnomevfs extension)</para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/Thunderbird"/></para>

  </sect2>

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

    <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 an abbreviated description of each one), issue
    <command>./configure --help</command>. If you would prefer to download the
    file instead of creating it by typing or cut-and-pasting, you can find it
    at <ulink url="&files-anduin;/thunderbird-&thunderbird-version;-mozconfig"/>
    (the file must be installed in the root of the source tree
    <filename class='directory'>comm-1.9.1</filename> directory, and named
    <filename>.mozconfig</filename>). Create the file by issuing the following
    command:</para>

<screen><?dbfo keep-together="auto"?><userinput>cat &gt; .mozconfig &lt;&lt; "EOF"
<literal># This file contains the options used in the Thunderbird build. You may
# need to specify additional options for your specific build needs.
# Use the information provided by running './configure --help' to
# help you determine if you need to add any additional options.
# Some additional options can be added by uncommenting the examples
# in this file or adding options by inserting a line containing
# 'ac_add_options --some-option-you-need'.  Be aware that some accepted
# options, such as '--with-system-bz2', do not affect the build.

# specify that we want to build thunderbird
ac_add_options --enable-application=mail

# sepcify that we want to build the Lightning calendar extension as per the
# Mozilla distributed Thunderbird.
ac_add_options --enable-calendar

# Create an object directory and specify to build the package in that
# directory. If desired, modify the location of the object directory
# to a directory inside the source tree by removing '../' from the
# line below.
mk_add_options MOZ_OBJDIR=@TOPSRCDIR@/../thunderbird-build

# Specify the installation prefix. If you would prefer Xulrunner
# installed in a different prefix, modify the line below to fit
# your needs (the config will always be written to /etc/gre.d)
ac_add_options --prefix=/usr

# apply a minimal level of optimization (-O)
ac_add_options --enable-optimize

# These options are used so that the Xulrunner binaries are linked to
# the system-installed copies of the specified libraries instead of
# the source tree code which may not be the most recent versions.
# With the exception of libsqlite3, the libraries are statically linked.

# (Options to use system installed libraries)
# Using the shipped version of libsqlite3 has been reported to cause
# problems with other applications which were using sqlite3.
# Only comment this line if you know exactly what you are doing!
ac_add_options --enable-system-sqlite

# Comment this only if you want to use whatever patched version of cairo
# is in the shipped mozilla tree, together with the system headers.
ac_add_options --enable-system-cairo

# Comment this if you have not installed lcms.
ac_add_options --enable-system-lcms

# Comment this if you did not build libjpeg before GTK+-2.
ac_add_options --with-system-jpeg

# These two options enable support for building Thunderbird with
# system-installed versions of the Network Security Services (NSS)
# and Netscape Portable Runtime (NSPR) libraries. Comment them if
# you wish to use the included copies (not recommended).
ac_add_options --with-system-nspr
ac_add_options --with-system-nss

# Comment this if you have not built png with the apng patch.
ac_add_options --with-system-png

# The pthreads option is only used when building nspr
# Uncomment this if you build the included nspr.
#ac_add_options --with-pthreads

# zlib is included in LFS. Do not comment this line.
ac_add_options --with-system-zlib

# (Options to disable parts of the package)
# This option is used to disable the a11y support in the Xulrunner
# binaries. Comment out this option if you require a11y support.
ac_add_options --disable-accessibility

# Uncomment this if you did not build curl.
#ac_add_options --disable-crashreporter

# Comment this if you have built dbus-glib.
ac_add_options --disable-dbus

# Comment this if you have gnome-vfs and libgnomeui, and wish to
# integrate thunderbird into your gnome desktop
ac_add_options --disable-gnomevfs

# This option is added so that the Mozilla Installer program is not
# built or installed. The program is not required for a BLFS
# installation of Xulrunner.
ac_add_options --disable-installer

# Enable the build of static internal libs (this is currently required, until
# Thunderbird 3.1, DO NOT COMMENT, see note below about XulRunner).
ac_add_options --enable-static

# This option is added so that test libraries and programs are not
# built. These would only be required for debugging purposes.
ac_add_options --disable-tests

# Disable the updater, which is not appropriate if you build from source
ac_add_options --disable-updater

# (options to add extra parts of the package)
# This option causes the installed binaries to have the official
# Thunderbird name embedded in them. Due to license restrictions, you
# may not distribute binaries created using this option.  It also
# means you get a popup EULA when you first run thunderbird.
ac_add_options --enable-official-branding

# This option is used to enable source tree included LDAP support in
# the Firefox binaries.  This used to be required for mozab support in
# OpenOffice, however, is now deprecated.
ac_add_options --enable-ldap

# This option is used so that the debugging symbols are removed from
# the installed binaries during the installation process. Comment out
# this option if you may have a need to retain the debugging symbols
# in the installed binaries (the resulting binaries will be about 7MB
# bigger).
ac_add_options --enable-strip

# Uncomment this option if you desire support for dual-monitor
# display using the X-Window Xinerama libraries.
#ac_add_options --enable-xinerama

# Enable strong cryptography (This is explicitly required if you plan to use
the enigmail extension for Thunderbird).
ac_add_options --enable-crypto

# Point to the xulrunner libraries - comment these for a standalone client
# DO NOT UNCOMMENT THESE - System XULRunner is broken until Thunderbird
# development catches up with XULRunner-1.9.2 (TB-3.1, est. April 6, 2010).
#ac_add_options --with-system-libxul
#ac_add_options --with-default-mozilla-five-home=/usr/lib/xulrunner-devel-&xulrunner-version;</literal>

EOF</userinput></screen>

    <para>Compile <application>Thunderbird</application> by
    issuing the following commands:</para>

<screen><userinput>make -f client.mk build</userinput></screen>

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

    <para>If you're building the <application>Enigmail</application> extension,
    issue the following commands:</para>

<screen><userinput>tar -xf ../enigmail-&thunderbird-enigmail-version;.tar.gz -C mailnews/extensions &amp;&amp;
( cd mailnews/extensions/enigmail &amp;&amp; ./makemake -r ) &amp;&amp;

make -C ../thunderbird-build/mailnews/extensions/enigmail &amp;&amp;
make -C ../thunderbird-build/mailnews/extensions/enigmail \
        XPIFILE=enigmail-&thunderbird-enigmail-version;.xpi xpi</userinput></screen>

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

<screen role="root"><userinput>make -f client.mk install</userinput></screen>

    <para>If you built the <application>Enigmail</application> extension,
    issue the following commands as the <systemitem
    class="username">root</systemitem> user to install the
    <filename>.xpi</filename> file:</para>

<screen role="root"><userinput>install -v -m644 -D ../thunderbird-build/mozilla/dist/bin/enigmail-&thunderbird-enigmail-version;.xpi \
    /usr/lib/thunderbird-&thunderbird-version;/xpi_store/enigmail-&thunderbird-enigmail-version;.xpi</userinput></screen>

    <para>If you want to install <application>Enigmail</application> globally
    so that all users who run <application>Thunderbird</application> will have
    access to the extension, issue the command shown below. Note that this
    procedure starts an instance of <application>Thunderbird</application> and
    you must have an X server running. Issue the following command as the
    <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>/usr/bin/thunderbird -install-global-extension \
    /usr/lib/thunderbird-&thunderbird-version;/xpi_store/enigmail-&thunderbird-enigmail-version;.xpi</userinput></screen>

    <para>Global installation of other extensions can be done using the same
    basic method as the <application>Enigmail</application> extension.</para>

  </sect2>

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

    <para><command>make -f client.mk ...</command>: Mozilla products are
    packaged to allow the use of a configuration file which can be used to
    pass the configuration settings to the <command>configure</command>
    command. <command>make</command> uses the <filename>client.mk</filename>
    file to get initial configuration and setup parameters, then depending on
    the target parameter (<parameter>build</parameter> or
    <parameter>install</parameter>), either runs the
    <command>configure</command> script and compiles the package or installs
    the package.</para>

<!--
    <para><command>( cd mailnews/... &amp;&amp; ./makemake -r )</command>:
    This command is used to recursively create <filename>Makefile</filename>s
    in the <filename class='directory'>enigmail</filename> directory.</para>

    <para><command>make -C ... xpi</command>: This command builds the
    <application>Enigmail</application>
    <filename class='extension'>.xpi</filename> file which is used to install
    <application>Enigmail</application>.</para>
-->

  </sect2>

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

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

      <para>No specific configuration is required as long as the
      <command>thunderbird</command> script is in the user's path. If
      <application>Thunderbird</application> is installed in a non-standard
      location, then make a symlink to the <command>thunderbird</command>
      script in the <filename class="directory">/usr/bin</filename>
      directory.</para>
<!--
      <para>If you don't have privileges to install extensions globally, or
      you prefer to not install global extensions, you can configure
      <application>Thunderbird</application> on an individual user basis for
      access to extensions. For example, if you built the
      <application>Enigmail</application> extension and did not install it
      globally, it can be installed on an as-needed basis for each user of the
      system who may use <application>Thunderbird</application>. It is
      accomplished through the <application>Thunderbird</application>
      <quote>Tools</quote> menu. Choose the <quote>Extensions</quote> &ndash;
      <quote>Install</quote> option and fill in the <quote>Look in:</quote>
      field with <filename
      class='directory'>/usr/lib/thunderbird-&thunderbird-version;/xpi_store</filename>.
      You'll then see the
      <filename>enigmail-&thunderbird-enigmail-version;-linux-????.xpi</filename>
      file listed. Choose this file and click on <quote>Open</quote>, then
      click on <quote>Install now</quote>. The
      <application>Enigmail</application> extension will install and you will
      be prompted to restart <application>Thunderbird</application>.</para>
-->
      <para>If your Window or Desktop Manager 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
      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>Preferences</quote>
      and then click on the <quote>Advanced</quote> icon on the top menu
      bar. Choose the <quote>Advanced</quote> tab and click on the
      <quote>Config Editor</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>

      <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>

    <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>

    </sect3>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>thunderbird and thunderbird-config</seg>
        <seg>Numerous libraries, email/newsgroups components, plugins,
        extensions, and helper modules installed in <filename
        class='directory'>/usr/lib/thunderbird-&thunderbird-version;</filename>
        </seg>
        <seg>/usr/include/thunderbird-&thunderbird-version;,
        /usr/lib/thunderbird-&thunderbird-version;, and
        /usr/share/idl/thunderbird-&thunderbird-version;</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 next-generation
          email and newsgroup client.</para>
          <indexterm zone="thunderbird thunderbird-prog">
            <primary sortas="b-thunderbird">thunderbird</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>