source: server/mail/qpopper.xml@ 7b769ad

<?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;

    <!-- Inserted as a reminder to do this. The mention of a test suite
         is usually right before the root user installation commands. Please
         delete these 12 (including one blank) lines after you are done.-->

    <!-- Use one of the two mentions below about a test suite,
         delete the line that is not applicable. Of course, if the
         test suite uses syntax other than "make check", revise the
         line to reflect the actual syntax to run the test suite -->

    <!-- <para>This package does not come with a test suite.</para> -->
    <!-- <para>To test the results, issue: <command>make check</command>.</para> -->
<!-- Dead link
  <!ENTITY qpopper-download-http "http://ftp.uni-koeln.de/mail/qpopper&qpopper-version;.tar.gz">
-->
  <!ENTITY qpopper-download-http " ">
  <!ENTITY qpopper-download-ftp "ftp://ftp.qualcomm.com/eudora/servers/unix/popper/qpopper&qpopper-version;.tar.gz">
  <!ENTITY qpopper-md5sum "de2cd15f95cfd00d0d080fd16287acad">
  <!ENTITY qpopper-size "2.7 MB">
  <!ENTITY qpopper-buildsize "9.1 MB">
  <!ENTITY qpopper-time "0.1 SBU">
]>

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

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

  <title>Qpopper-&qpopper-version;</title>

  <indexterm zone="qpopper">
    <primary sortas="a-Qpopper">Qpopper</primary>
  </indexterm>

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

    <para>The <application>Qpopper</application> package contains a
    POP3 mail server.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">An <xref linkend="server-mail"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="openssl"/>,
    <xref linkend="gdbm"/>,
    <xref linkend="linux-pam"/>, and
    <xref linkend="mitkrb"/> or <xref linkend="heimdal"/></para>

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

  </sect2>

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

    <para>Install <application>Qpopper</application> with the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr --enable-standalone &amp;&amp;
make</userinput></screen>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install &amp;&amp;
install -D -m644 GUIDE.pdf /usr/share/doc/qpopper-&qpopper-version;/GUIDE.pdf</userinput></screen>

  </sect2>

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

    <para><option>--enable-standalone</option>: This option gives the
    flexibility to run <application>Qpopper</application> in
    standalone mode.</para>

  </sect2>

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

    <sect3 id="qpopper-config">
      <title>Configuration Information</title>

      <para>Update the <application>Syslog</application> configuration file and
      force the <command>syslogd</command> daemon to reread the new file so that
      <application>Qpopper</application> events are logged:</para>

      <indexterm zone="qpopper qpopper-config">
        <primary sortas="e-etc-syslog.conf">/etc/syslog.conf</primary>
      </indexterm>

<screen role="root"><userinput>echo "local0.notice;local0.debug /var/log/POP.log" &gt;&gt; \
    /etc/syslog.conf &amp;&amp;
killall -HUP syslogd</userinput></screen>

      <para id="qpopper-init">If you want <application>Qpopper</application> to
      start automatically when the system is booted, install the
      <filename>/etc/rc.d/init.d/qpopper</filename> init script included in the
      <xref linkend="bootscripts"/> package.</para>

      <indexterm zone="qpopper qpopper-init">
        <primary sortas="f-qpopper">popper</primary>
      </indexterm>

<screen role="root"><userinput>make install-qpopper</userinput></screen>

      <para>This startup procedure uses a configuration file.  The details of
      the configuration file can be found in the documentation file
      <filename>GUIDE.pdf</filename>.</para>

<screen role="root"><userinput>cat &gt; /etc/mail/qpopper.conf &lt;&lt; "EOF"
<literal># Qpopper configuration file

set debug = false

set spool-dir = /var/spool/mail/
set temp-dir  = /var/spool/mail/

set downcase-user = true
set trim-domain = true

set statistics = true

# End /etc/shells</literal>
EOF</userinput></screen>

      <para>If you use <command>inetd</command>, the following command will
      add the <application>Qpopper</application> entry to
      <filename>/etc/inetd.conf</filename>:</para>

      <indexterm zone="qpopper qpopper-config">
        <primary sortas="e-etc-inetd.conf">/etc/inetd.conf</primary>
      </indexterm>

<screen role="root"><userinput>echo "pop3 stream tcp nowait root /usr/sbin/popper popper" &gt;&gt; \
    /etc/inetd.conf &amp;&amp;
killall inetd || inetd</userinput></screen>

      <para>Issue a <command>killall -HUP inetd</command> to reread the
      changed <filename>inetd.conf</filename> file.</para>

      <para>If you use <command>xinetd</command>, the following command will
      create the <application>Qpopper</application> file as
      <filename>/etc/xinetd.d/pop3</filename>:</para>

<screen role="root"><userinput>cat &gt;&gt; /etc/xinetd.d/pop3 &lt;&lt; "EOF"
<literal># Begin /etc/xinetd.d/pop3

service pop3
{
    port            = 110
    socket_type     = stream
    protocol        = tcp
    wait            = no
    user            = root
    server          = /usr/sbin/popper
}

# End /etc/xinetd.d/pop3</literal>
EOF</userinput></screen>

      <indexterm zone="qpopper qpopper-config">
        <primary sortas="e-etc-xinetd.conf">/etc/xinetd.conf</primary>
      </indexterm>

      <indexterm zone="qpopper qpopper-config">
        <primary sortas="e-etc-xinetd.d-pop3">/etc/xinetd.d/pop3</primary>
      </indexterm>

      <para>Issue a <command>killall -HUP xinetd</command> to reread the
      changed <filename>xinetd.conf</filename> file.</para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>popper</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="popper-qpopper">
        <term><command>popper</command></term>
        <listitem>
          <para>is the POP3 server daemon.</para>
          <indexterm zone="qpopper popper-qpopper">
            <primary sortas="b-popper">popper</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>