source: archive/pine.xml@ d63fed6

<?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 pine-download-http "http://mirror.sit.wisc.edu/pub/net/mail/pine/pine&pine-version;.tar.bz2">
  <!ENTITY pine-download-ftp  "ftp://ftp.cac.washington.edu/pine/pine&pine-version;.tar.bz2">
  <!ENTITY pine-md5sum        "39ca07b3d305b4cd0d6aaf4585123275">
  <!ENTITY pine-size          "3.0 MB">
  <!ENTITY pine-buildsize     "64 MB">
  <!ENTITY pine-time          "0.6 SBU">
]>

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

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

  <title>Pine-&pine-version;</title>

  <indexterm zone="pine">
    <primary sortas="a-Pine">Pine</primary>
  </indexterm>

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

    <para>The <application>Pine</application> package contains the
    <application>Pine</application> Mail User Agent and several
    server daemons for various mail protocols, in addition to some nice
    file and directory editing/browsing programs.</para>

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Recommended Patch: <ulink
        url="&patch-root;/pine-&pine-version;-utf8-1.patch"/></para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="openssl"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="openldap"/> and <xref linkend="mitkrb"/></para>

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

  </sect2>

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

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

<screen><userinput>patch -Np1 -i ../pine-&pine-version;-utf8-1.patch &amp;&amp;
sed -i "s@/usr/local/lib/pine@/etc/pine@g" \
    $(grep -lr /usr/local/lib/pine *) &amp;&amp;
./build DEBUG=-O MAILSPOOL=/var/mail \
    SSLDIR=/usr SSLCERTS=/etc/ssl/certs slx</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>install -v -m644 doc/*.1 /usr/share/man/man1 &amp;&amp;
install -v -p -m644 doc/tech-notes/*.html /usr/share/doc/pine&pine-version; &amp;&amp;
install -v -m755 \
bin/{pine,imapd,ipop2d,ipop3d,mailutil,mtest,pico,pilot,rpdump,rpload} \
    /usr/bin</userinput></screen>

  </sect2>

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

    <para><command>patch -Np1 -i ../pine-&pine-version;-utf8-1.patch</command>:
    This patch enables Pine UTF-8 and charset conversion.</para>

    <para><command>sed -i "s@/usr/ ... /lib/pine *)</command>: This
    <command>sed</command> will make <application>Pine</application> use <filename
    class="directory">/etc</filename> for configuration files. It also alters
    the documentation to reflect that.</para>

    <para>The build procedure for <application>Pine</application> is somewhat
    unusual, in that options usually passed as <command>./configure</command>
    options or housed in $<envar>CFLAGS</envar> must all be passed on the command
    line to the <command>./build</command> script.</para>

    <para><command>./build slx</command>: <application>Pine</application> offers
    quite a few target platforms, slx specifies Linux using
    <option>-lcrypt</option> to get the crypt function.  See the
    <filename>doc/pine-ports</filename> file for more information and
    other authentication options.</para>

    <para><command>DEBUG=-O</command>: This flag compiles an optimized
    version of <command>pine</command> and <command>pico</command> that
    produces no debug files.</para>

    <para><command>MAILSPOOL=/var/mail</command>: Location of mail spool
    files, <filename class="directory">/var/mail</filename>.</para>

    <para><command>SSLDIR=/usr SSLCERTS=/etc/ssl/certs</command>: Location
    of <application>OpenSSL</application> files.</para>

  </sect2>

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

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

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

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

    </sect3>

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

      <para>The <command>pine</command> executable needs no global configuration to
      use.  Users set <application>Pine</application> options in
      <filename>~/.pinerc</filename> using an internal configuration menu.</para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>imapd, ipop2d, ipop3d, mtest, pico, pilot, pine, rpdump, and rpload</seg>
        <seg>None</seg>
        <seg>/usr/share/doc/pine&pine-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="imapd-pine">
        <term><command>imapd</command></term>
        <listitem>
          <para>is the IMAP server daemon.</para>
          <indexterm zone="pine imapd-pine">
            <primary sortas="b-pine">pine</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ipop2d">
        <term><command>ipop2d</command></term>
        <listitem>
          <para>is an IMAP to POP2 conversion server.</para>
          <indexterm zone="pine ipop2d">
            <primary sortas="b-ipop2d">ipop2d</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ipop3d">
        <term><command>ipop3d</command></term>
        <listitem>
          <para>is an IMAP to POP3 conversion server.</para>
          <indexterm zone="pine ipop3d">
            <primary sortas="b-ipop3d">ipop3d</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mtest">
        <term><command>metest</command></term>
        <listitem>
          <para>is a minimal IMAP mail user agent, used for debugging.</para>
          <indexterm zone="pine mtest">
            <primary sortas="b-mtest">mtest</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pico-pine">
        <term><command>pico</command></term>
        <listitem>
          <para>is a stand-alone editor, similar to the
          <application>Pine</application> internal message composer.</para>
          <indexterm zone="pine pico-pine">
            <primary sortas="b-pico">pico</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pilot">
        <term><command>pilot</command></term>
        <listitem>
          <para>is a file and directory navigator and browser.</para>
          <indexterm zone="pine pilot">
            <primary sortas="b-pilot">pilot</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pine-prog">
        <term><command>pine</command></term>
        <listitem>
          <para>is the <application>Pine</application> mail user agent.</para>
          <indexterm zone="pine pine-prog">
            <primary sortas="b-pine">pine</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rpdump">
        <term><command>rpdump</command></term>
        <listitem>
          <para>is used to copy data from remote <application>Pine</application>
          configuration files or address books into a local file.</para>
          <indexterm zone="pine rpdump">
            <primary sortas="b-rpdump">rpdump</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rpload">
        <term><command>rpload</command></term>
        <listitem>
          <para>is the <application>Pine</application> remote data utility, used to
          convert local <application>Pine</application> configuration files or address
          books into remote configurations or address books.</para>
          <indexterm zone="pine rpload">
            <primary sortas="b-rpload">rpload</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>