source: basicnet/mailnews/pine.xml@ bfe245f

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/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-size          "2.9 MB">
  <!ENTITY pine-buildsize     "50 MB">
  <!ENTITY pine-time          "0.95 SBU">
]>

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

<sect2>
<title>Introduction to <application>Pine</application></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>

<sect3><title>Package information</title>
<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 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>
</sect3>

<sect3><title>Additional downloads</title>
<itemizedlist spacing='compact'>
<listitem><para>Recommended patch: <ulink
url="&patch-root;/pine-&pine-version;-fhs-3.patch"/></para></listitem>
</itemizedlist>
</sect3>

<sect3><title><application>Pine</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="openssl"/></para></sect4>
<sect4><title>Optional</title>
<para>
<xref linkend="openldap"/> and
<xref linkend="mitkrb"/>
</para></sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>Pine</application></title>

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

<screen><userinput><command>patch -Np1 -i ../pine-&pine-version;-fhs-3.patch &amp;&amp;
./build DEBUG=-O MAILSPOOL=/var/mail \
    SSLDIR=/usr SSLCERTS=/etc/ssl/certs slx &amp;&amp;
cp doc/*.1 /usr/share/man/man1 &amp;&amp;    
cd bin &amp;&amp;
install pine imapd ipop2d ipop3d mailutil mtest pico \
    pilot rpdump rpload /usr/bin</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><command>patch -Np1 -i ../pine-&pine-version;-fhs.patch</command>: This
patch will make <application>Pine</application> use <filename
class="directory">/etc</filename> for configuration files.</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
-lcrypt 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>/var/mail.</filename></para>

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

<para><screen><command>cd bin &amp;&amp;
install pine imapd ipop2d ipop3d mailutil mtest pico \
    pilot rpdump rpload /usr/bin</command></screen>
This installs <application>Pine</application>.</para>

</sect2>

<sect2>
<title>Configuring <application>Pine</application></title>

<sect3><title>Config files</title>
<para><filename>~/.pinerc</filename></para>
</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>
<title>Contents</title>
<para>The <application>Pine</application> package contains
<command>pine</command>,
<command>pico</command>,
<command>pilot</command>,
<command>imapd</command>,
<command>ipop2d</command>,
<command>ipop3d</command>,
<command>mtest</command>,
<command>rpload</command> and
<command>rpdump</command>.</para>
</sect2>

<sect2><title>Description</title>

<sect3><title>pine</title>
<para><command>pine</command> is the <application>Pine</application> mail user 
agent.</para></sect3>

<sect3><title>pico</title>
<para><command>pico</command> is a stand-alone editor, similar to the
<application>Pine</application> internal message composer.</para></sect3>

<sect3><title>pilot</title>
<para><command>pilot</command> is a file and directory navigator and browser.</para></sect3>

<sect3><title>imapd</title>
<para><command>imapd</command> is the <acronym>IMAP</acronym> server daemon.</para></sect3>

<sect3><title>ipop2d</title>
<para><command>ipop2d</command> is an <acronym>IMAP</acronym> to
<acronym>POP</acronym>2 conversion server.</para></sect3>

<sect3><title>ipop3d</title>
<para><command>ipop3d</command> is an <acronym>IMAP</acronym> to
<acronym>POP</acronym>3 conversion server.</para></sect3>

<sect3><title>mtest</title>
<para><command>mtest</command> is a minimal <acronym>IMAP</acronym> mail user 
agent, used for debugging.</para></sect3>

<sect3><title>rpload</title>
<para><command>rpload</command> 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></sect3>


<sect3><title>rpdump</title>
<para><command>rpdump</command> is used to copy data from remote
<application>Pine</application> configuration files or address books into a 
local file.</para></sect3>

</sect2>

</sect1>