source: xsoft/other/balsa.xml@ d7f56e3

<?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 balsa-download-http "https://pawsa.fedorapeople.org/balsa/balsa-&balsa-version;.tar.xz">
  <!ENTITY balsa-download-ftp  " ">
  <!ENTITY balsa-md5sum        "bebd22cb6bac87ee05255c48ee1d28dd">
  <!ENTITY balsa-size          "3.5 MB">
  <!ENTITY balsa-buildsize     "66 MB">
  <!ENTITY balsa-time          "0.2 SBU (Using parallelism=4)">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>Balsa-&balsa-version;</title>

  <indexterm zone="balsa">
    <primary sortas="a-Balsa">Balsa</primary>
  </indexterm>

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

    <para>
      The <application>Balsa</application> package contains a
      <application>GNOME</application>-2 based mail client.
    </para>

    &lfs112_checked;

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>

    <itemizedlist spacing="compact">
      <listitem>
        <para>
          <ulink url="&patch-root;/balsa-&balsa-version;-upstream_fix-1.patch"/>
          Recommended patch, required to build without <xref linkend="webkitgtk"/>
        </para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="aspell"/>,
      <xref linkend="enchant"/>,
      <xref linkend="gmime3"/>,
      <xref linkend="gpgme"/>,
      <xref linkend="gtk3"/>, and
      <xref linkend="libnotify"/>
      <!--<xref linkend="rarian"/>-->
    </para>

    <bridgehead renderas="sect4">Required (Runtime)</bridgehead>
    <para role="required">
      <xref role="runtime" linkend="server-mail"/> (that provides a
      <command>sendmail</command> command)
    </para>

<!-- in 2.6.3 the only references to pcre are in the old spec file,
     the INSTALL file which seems to be out of date,
     and the ChangeLog where it was defaulted to off in 2008.
     Not mentioned in configure.
    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="pcre"/>
    </para>-->

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="compface"/>,
      <xref linkend="gcr"/>,
      <xref linkend="gtksourceview"/>,
      <xref linkend="libcanberra"/>,
      <xref linkend="libsecret"/>,
      <xref linkend="mitkrb"/>,
      <xref linkend="openldap"/>,
      <xref linkend="procmail"/>,
      <xref linkend="sqlite"/>,
      <xref linkend="webkitgtk"/>,
      <ulink url="https://pypi.python.org/pypi/html2text/">html2text</ulink>,
      <ulink url="http://clayo.org/osmo/">osmo</ulink>,
      <ulink url="https://sourceforge.net/projects/rubrica.berlios/">rubrica</ulink>,
      <ulink url="&gnome-download-http;/yelp-tools/">yelp-tools</ulink>
    </para>

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

  </sect2>

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

    <para>
      First, fix a build issue if html support is not being used:
    </para>

<screen><userinput>patch -Np1 -i ../balsa-&balsa-version;-upstream_fix-1.patch</userinput></screen>

    <para>
      Install <application>Balsa</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr            \
            --sysconfdir=/etc        \
            --localstatedir=/var/lib \
            --without-html-widget    &amp;&amp;
make</userinput></screen>

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

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role='root'><userinput>make install</userinput></screen>

  </sect2>

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

    <!-- Support has been added for this, but the option is still unrecognized.
    <para>
      <parameter>- -with-rubrica</parameter>: This parameter is used
      to provide Rubrica2 address book support.
    </para>
    -->

    <!-- configure says this is an invalid option with 2.5.11
    <para>
      <option>- -enable-smime</option>: Use this option to enable S/MIME
      support if <application>GnuPG-2.x.x</application> is installed.
    </para>
    -->

    <para>
      <parameter>--without-html-widget</parameter>: This option disables
      building the HTML renderer. If you want the HTML renderer to be built,
      verify that you have <xref linkend="webkitgtk"/> installed, and then
      remove this option.
    </para>

    <para>
      <option>--with-canberra</option>: Enable libcanberra support.
    </para>

    <para>
      <option>--with-compface</option>: Enable compface support.
    </para>

    <para>
      <option>--with-gcr</option>: Use libgcr for TLS support.
    </para>

    <para>
      <option>--with-gss</option>: Enable GSSAPI support.
    </para>

    <para>
      <option>--with-ldap</option>: Use this option to enable LDAP address
      book support if <application>OpenLDAP</application> is installed.
    </para>

    <para>
      <option>--with-libsecret</option>: Enable strong password
      support and support for gnome-keyring to store passwords.
    </para>

    <!-- configure says this is an invalid option with 2.5.11
    <para>
      <option>- -with-gpgme</option>: Use this option to enable GPG support
      if <quote><application>GnuPG</application> Made Easy</quote>
      (<application>GPGME</application>) is installed.
    </para>
    -->

    <para>
      <option>--with-sqlite</option>: Use this option to enable SQLite
      address book support if <application>SQLite</application> is
      installed.
    </para>

  </sect2>

<!-- All of this information is invalid. These options no longer exist since
     Balsa was ported to GTK3.
  <sect2 role="configuration">
    <title>Configuring Balsa</title>

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

      <para>
        All configuration of <application>Balsa</application> is done
        through the <application>Balsa</application> menu system, with mailbox
        configuration done with the Settings&mdash;&gt;Preferences menu.
      </para>

      <para>
        If you are unable to connect to your ISP, they probably don't
        support APOP.  Disable it in Settings/Preferences/POP3/advanced.
      </para>

      <para>
        If you enable filters for your incoming POP3 mail, you must have
        <xref linkend="procmail"/> installed, as the incoming mail will be
        handed off to <command>procmail</command> for processing.
      </para>

    </sect3>

  </sect2>
-->

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

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

      <seglistitem>
        <seg>balsa and balsa-ab</seg>
        <seg>None</seg>
        <seg>/etc/sounds/events,
             /usr/share/balsa,
             and /usr/share/sounds/balsa</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="balsa-prog">
        <term><command>balsa</command></term>
        <listitem>
          <para>
            is a glib based mail client
          </para>
          <indexterm zone="balsa balsa-prog">
            <primary sortas="b-balsa">balsa</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="balsa-ab">
        <term><command>balsa-ab</command></term>
        <listitem>
          <para>
            is the address-book application used by <command>balsa</command>
          </para>
          <indexterm zone="balsa balsa-ab">
            <primary sortas="b-balsa">balsa-ab</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>