source: basicnet/mailnews/nail.xml@ 7e7cb4a

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY nail-download-http "http://prdownloads.sourceforge.net/nail/nail-&nail-version;.tar.bz2">
  <!ENTITY nail-download-ftp  " ">
  <!ENTITY nail-md5sum        "54f42db31911d734fcf37a89b72d4df7">
  <!ENTITY nail-size          "267 KB">
  <!ENTITY nail-buildsize     "3.2 MB">
  <!ENTITY nail-time          "less than 0.1 SBU">
]>

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

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

  <title>Nail-&nail-version;</title>

  <indexterm zone="nail">
    <primary sortas="a-Nail">Nail</primary>
  </indexterm>

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

    <para>The <application>Nail</application> package contains
    <command>nail</command>, a command-line Mail User Agent derived from
    Berkeley Mail which is intended to provide the functionality of the POSIX
    <command>mailx</command> command with additional support for MIME messages,
    IMAP (including caching), POP3, SMTP, S/MIME, message threading/sorting,
    scoring, and filtering. <application>Nail</application> is especially
    useful for writing scripts and batch processing.</para>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para><xref linkend="openssl"/> or Mozilla NSS (from
    <xref linkend="mozilla"/> or
    <xref linkend="firefox"/> or
    <xref linkend="thunderbird"/>),
    <xref linkend="heimdal"/> or <xref linkend="mitkrb"/> (for IMAP GSSAPI
    authentication) and an
    <ulink url="../server/mail.html">MTA</ulink></para>

  </sect2>

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

    <para>Install <application>Nail</application> by running the following
    commands.</para>

<screen><userinput>make SENDMAIL=/usr/sbin/sendmail</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 PREFIX=/usr install UCBINSTALL=/usr/bin/install &amp;&amp;
ln -v -sf nail /usr/bin/mail &amp;&amp;
ln -v -sf nail /usr/bin/mailx &amp;&amp;
install -v -m755 -d /usr/share/doc/nail-&nail-version; &amp;&amp;
install -v -m644 README nail.1.html /usr/share/doc/nail-&nail-version;</userinput></screen>

  </sect2>

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

    <para><command>make SENDMAIL=/usr/sbin/sendmail</command>: This changes the
    default MTA path of <command>/usr/lib/sendmail</command>.</para>

    <para><command>make PREFIX=/usr install UCBINSTALL=/usr/bin/install</command>:
    This changes the default installation path of
    <filename class='directory'>/usr/local</filename> and the default
    <command>install</command> command path of
    <filename class='directory'>/usr/ucb</filename>.</para>

  </sect2>

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

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

      <para><filename>/etc/nail.rc</filename>, <filename>~/.mailrc</filename> and
      <filename>~/.nailrc</filename></para>

      <indexterm zone="nail nail-config">
        <primary sortas="e-etc-nail.rc">/etc/nail.rc</primary>
      </indexterm>

      <indexterm zone="nail nail-config">
        <primary sortas="e-AA.mailrc">~/.mailrc</primary>
      </indexterm>

      <indexterm zone="nail nail-config">
        <primary sortas="e-AA.nailrc">~/.nailrc</primary>
      </indexterm>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>mail, mailx and nail</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="nail-prog">
        <term><command>nail</command></term>
        <listitem>
          <para>is a command-line mail user agent compatible with the
          <command>mail</command> command found on commercial Unix versions.</para>
          <indexterm zone="nail nail-prog">
            <primary sortas="b-nail">nail</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mail-nail">
        <term><command>mail</command></term>
        <listitem>
          <para>is a symbolic link to <command>nail</command>.</para>
          <indexterm zone="nail mail-nail">
            <primary sortas="g-mail">mail</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mailx-nail">
        <term><command>mailx</command></term>
        <listitem>
          <para>is a symbolic link to <command>nail</command>.</para>
          <indexterm zone="nail mailx-nail">
            <primary sortas="g-mailx">mailx</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>