source: general/genlib/libesmtp.xml@ 22ac237

<?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 libesmtp-download-http "http://www.stafford.uklinux.net/libesmtp/libesmtp-&libesmtp-version;.tar.bz2">
  <!ENTITY libesmtp-download-ftp  "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/libesmtp-&libesmtp-version;.tar.bz2">
  <!ENTITY libesmtp-md5sum        "c07aa79293aa36298626fe5e68d6bfba">
  <!ENTITY libesmtp-size          "270 KB">
  <!ENTITY libesmtp-buildsize     "6.9 MB">
  <!ENTITY libesmtp-time          "0.2 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">libesmtp-&libesmtp-version;.tar</keyword>
      <keyword role="ftpdir">libesmtp</keyword>
    </keywordset>
  </sect1info>

  <title>libESMTP-&libesmtp-version;</title>

  <indexterm zone="libesmtp">
    <primary sortas="a-libESMTP">libESMTP</primary>
  </indexterm>

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

    <para>The <application>libESMTP</application> package contains the
    <application>libESMTP</application> libraries which are used by some programs
    to manage email submission to a mail transport layer.</para>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="openssl"/></para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr &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="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>libesmtp-config</seg>
        <seg>libesmtp.[so,a] and <application>libESMTP</application>
        SASL plugins</seg>
        <seg>/usr/lib/esmtp-plugins</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libesmtp-config">
        <term><command>libesmtp-config</command></term>
        <listitem>
          <para>displays version information and the options used to
          compile <application>libESMTP</application>.</para>
          <indexterm zone="libesmtp libesmtp-config">
            <primary sortas="b-libesmtp-config">libesmtp-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libesmtp-lib">
        <term><filename class='libraryfile'>libesmtp.[so,a]</filename></term>
        <listitem>
          <para>is used to manage submission of electronic mail to a Mail
          Transport Agent.</para>
          <indexterm zone="libesmtp libesmtp-lib">
            <primary sortas="c-libesmtp">libesmtp.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libesmtp-plugins">
        <term><filename class='libraryfile'>libesmtp SASL plugins</filename></term>
        <listitem>
          <para>are used to integrate <application>libesmtp</application> with
          SASL authentication.</para>
          <indexterm zone="libesmtp libesmtp-plugins">
            <primary sortas="c-libesmtp-sasl-plugins">libesmtp SASL plugins</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>