source: xsoft/other/balsa.xml@ d777a3a

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

  <!ENTITY balsa-download-http "http://balsa.gnome.org/balsa-&balsa-version;.tar.bz2">
  <!ENTITY balsa-download-ftp  " ">
  <!ENTITY balsa-md5sum        "c357968588edc753ca51d397dbc2a9d3">
  <!ENTITY balsa-size          "3.1 MB">
  <!ENTITY balsa-buildsize     "52.6 MB">
  <!ENTITY balsa-time          "0.7 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">balsa-&balsa-version;.tar</keyword>
      <keyword role="ftpdir">balsa</keyword>
    </keywordset>
  </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>

    <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">Balsa Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="libgnomeui"/>,
    <xref linkend="libgnomeprintui"/>,
    <xref linkend="scrollkeeper"/>,
    <xref linkend="aspell"/> and
    <xref linkend="gmime"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="libgtkhtml"/>,
    <xref linkend="libesmtp"/>,
    <xref linkend="openssl"/>,
    <xref linkend="openldap"/>,
    <xref linkend="pcre"/>,
    <xref linkend="sendmail"/> (or other
    <ulink url="../server/mail.html">MTA</ulink> that links to
    <command>/usr/sbin/sendmail</command>),
    <xref linkend="heimdal"/> or <xref linkend="mitkrb"/>, and
    <ulink url="http://www.sqlite.org/">SQLite</ulink></para>

    <bridgehead renderas="sect4">Optional to Build Experimental S/MIME Support</bridgehead>
    <para role="optional"><ulink
    url="http://www.gnupg.org/download/index.html#libksba">Libksba</ulink>,
    <ulink url="http://www.gnupg.org/download/index.html#gpgme">GPGME</ulink> and
    <ulink url="http://www.gnupg.org/download/index.html#gnupg2">GnuPG-1.9.x</ulink></para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
    --localstatedir=/var/lib --sysconfdir=&gnome-etc-dir; \
    --with-gtkhtml=no --with-esmtp=no &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>

    <para><parameter>--localstatedir=/var/lib</parameter>: This switch puts
    <application>ScrollKeeper</application> files in
    <filename class="directory">/var/lib/scrollkeeper</filename> instead of
    <filename class="directory">$GNOME_PREFIX/var/scrollkeeper</filename>.</para>

    <para><parameter>--sysconfdir=&gnome-etc-dir;</parameter>: This switch puts
    configuration files in <filename class="directory">&gnome-etc-dir;</filename>
    instead of <filename class="directory">$GNOME_PREFIX/etc</filename>.</para>

    <para><parameter>--with-gtkhtml=no</parameter>: This parameter is used if
    you don't have <application>libgtkhtml</application> installed. Remove
    this parameter if the package is installed. Note that you won't be able to
    read or write HTML formatted mail messages if you use this parameter.</para>

    <para><parameter>--with-esmtp=no</parameter>: This parameter is used if
    you don't have <application>libESMTP</application> installed. Remove this
    parameter if the package is installed.</para>

    <para><option>--with-ssl</option>: Use this option to enable SSL support if
    <application>OpenSSL</application> is installed.</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-sqlite</option>: Use this option to enable SQLite
    address book support if <application>SQLite</application> is
    installed.</para>

    <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>--enable-smime</option>: Use this option to enable S/MIME
    support if <application>Libksba</application> and
    <application>GnuPG-1.9.x</application> is installed.</para>

  </sect2>

  <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 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>$GNOME_PREFIX/share/balsa, $GNOME_PREFIX/share/sounds/balsa and
        $GNOME_PREFIX/share/gnome/help/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 <application>GNOME</application>-2 based mail
          client.</para>
          <indexterm zone="balsa balsa-prog">
            <primary sortas="b-balsa">balsa</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>