source: networking/mailnews/alpine.xml@ d719805

<?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 alpine-download-http "http://alpine.freeiz.com/alpine/release/src/alpine-&alpine-version;.tar.xz">
  <!ENTITY alpine-download-ftp  " ">
  <!ENTITY alpine-md5sum        "02dad85c1be80ce020206f222ecf5ac8">
  <!ENTITY alpine-size          "4.6 MB">
  <!ENTITY alpine-buildsize     "122 MB">
  <!ENTITY alpine-time          "1.0 SBU">
]>

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

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

  <title>Alpine-&alpine-version;</title>

  <indexterm zone="alpine">
    <primary sortas="a-alpine">alpine</primary>
  </indexterm>

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

    <para><application>Alpine</application> is a text-based email client
    developed by the University of Washington.</para>

    &lfs81_checked;

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

    <bridgehead renderas="sect3">Alpine Dependencies</bridgehead>
<!--
    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
    <xref linkend="openssl"/>
    </para>
-->
    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
    <xref linkend="openldap"/>,
    <xref linkend="mitkrb"/>,
    <xref linkend="aspell"/>,
    <xref linkend="tcl"/>, and
    <xref linkend="linux-pam"/>
    </para>

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

  </sect2>

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

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

<screen><userinput>LIBS+="-lcrypto" ./configure --prefix=/usr       \
                             --sysconfdir=/etc   \
                             --without-ldap      \
                             --without-krb5      \
                             --without-pam       \
                             --without-tcl       \
                             --with-ssl-dir=/usr \
                             --with-passfile=.pine-passfile &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><command>LIBS+="-lcrypto"</command>: Enable linking to
    openssl. Additional linker flags are required for 
    <xref linkend="linux-pam"/>, <option>-lpam</option>, and for
    <xref linkend="mitkrb"/>, <option>-lkrb5</option>.</para>

    <para><parameter>--without-ldap</parameter>: Disables LDAP support.</para>

    <para><parameter>--without-krb5</parameter>: Disables Kerberos support.</para>

    <para><parameter>--without-pam</parameter>: Disables Linux-PAM
    support.</para>

    <para><parameter>--without-tcl</parameter>: Disables TCL support.</para>

    <para><parameter>--with-ssl-dir=/usr</parameter>: Sets the root path to
    OpenSSL libraries and include files.</para>

    <para><parameter>--with-passfile=.pine-passfile</parameter>: Sets the
    password cache file.</para>

    <para><option>--without-ssl</option>: Disables OpenSSL support.</para>

  </sect2>

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

    <sect3 id="alpine-config">
      <title>Config Files</title>

      <para><filename>~/.pinerc</filename></para>

      <indexterm zone="alpine alpine-config">
        <primary sortas="e-AA.pinerc">~/.pinerc</primary>
      </indexterm>

    </sect3>

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

      <para>It is not required to manually edit any configuration files to use
      the <application>Alpine</application> email client. Users can configure
      <application>Alpine</application> using the graphical configuration menu,
      which stores the changes in <filename>~/.pinerc</filename>.</para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>alpine, pico, pilot, rpdump, and rpload</seg>
        <seg>none</seg>
        <seg>none</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="alpine-bin">
        <term><command>alpine</command></term>
        <listitem>
          <para>is the Alpine mailer.</para>
          <indexterm zone="alpine alpine-bin">
            <primary sortas="b-alpine-bin">alpine</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pico">
        <term><command>pico</command></term>
        <listitem>
          <para>is a standalone text editor similar to the Alpine message composer.</para>
          <indexterm zone="alpine pico">
            <primary sortas="b-pico">pico</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pilot">
        <term><command>pilot</command></term>
        <listitem>
          <para>is a standalone file system navigator.</para>
          <indexterm zone="alpine pilot">
            <primary sortas="b-pilot">pilot</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rpdump">
        <term><command>rpdump</command></term>
        <listitem>
          <para>is a utility for downloading a pinerc or address book to the
          local machine.</para>
          <indexterm zone="alpine rpdump">
            <primary sortas="b-rpdump">rpdump</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rpload">
        <term><command>rpload</command></term>
        <listitem>
          <para> is a utility for uploading a local pinerc or address book to
          an IMAP server.</para>
          <indexterm zone="alpine rpload">
            <primary sortas="b-rpload">rpload</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>