source: basicnet/mailnews/procmail.xml@ 518538f

<?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 procmail-download-http "http://www.procmail.org/procmail-&procmail-version;.tar.gz">
  <!ENTITY procmail-download-ftp  "ftp://ftp.procmail.net/pub/procmail/procmail-&procmail-version;.tar.gz">
  <!ENTITY procmail-size          "338 KB">
  <!ENTITY procmail-buildsize     "1.5 MB">
  <!ENTITY procmail-time          "0.38 SBU">
]>

<sect1 id="procmail" xreflabel="Procmail-&procmail-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="procmail.html"?>
<title>Procmail-&procmail-version;</title>

<sect2>
<title>Introduction to <application>Procmail</application></title>

<para>The <application>Procmail</application> package contains an autonomous mail processor. This
is useful for filtering and sorting incoming mail.</para>

<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): <ulink
url="&procmail-download-http;"/></para></listitem>
<listitem><para>Download (FTP): <ulink
url="&procmail-download-ftp;"/></para></listitem>
<listitem><para>Download size: &procmail-size;</para></listitem>
<listitem><para>Estimated disk space required:
&procmail-buildsize;</para></listitem>
<listitem><para>Estimated build time:
&procmail-time;</para></listitem></itemizedlist>
</sect3>


</sect2>

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

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

<screen><userinput><command>make LOCKINGTEST=/tmp install &amp;&amp;
make install-suid</command></userinput></screen>

</sect2>

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

<para><command>make LOCKINGTEST=/tmp install</command>: This prevents make from
asking you where to test file-locking patterns.</para>

<para><command>make install-suid</command>: Modifies permissions of
the installed files.</para>
</sect2>

<sect2>
<title>Configuring <application>Procmail</application></title>

<sect3><title>Config files</title>
<para><filename>/etc/procmailrc</filename>,
<filename>~/.procmailrc</filename></para>
</sect3>

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

<para>Recipes have to be written and placed in your
<filename>~/.procmailrc</filename> for execution. The procmailex man
page is the starting place to learn how to write recipes.</para>
</sect3>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>Procmail</application> package contains <command>procmail</command>, <command>formail</command>, <command>lockfile</command> and <command>mailstat</command>.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>procmail</title>
<para><command>procmail</command> is an autonomous mail processor.  It performs
all the functions of a <acronym>MDA</acronym> (Mail Delivery Agent).</para></sect3>

<sect3><title>formail</title>
<para><command>formail</command> is a filter that can be used to format mail 
into mailbox format.</para></sect3>

<sect3><title>lockfile</title>
<para><command>lockfile</command> is a utility that can lock a file for single 
use interactively or in a script.</para></sect3>

<sect3><title>mailstat</title>
<para><command>mailstat</command> prints a summary report of mail that has been
filtered by <command>procmail</command> since the last time <command>
mailstat</command> was ran.</para></sect3>

</sect2>

</sect1>