source: basicnet/mailnews/mailx.xml@ 058bfd80

<?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 mailx-download-http "http://prdownloads.sourceforge.net/heirloom/mailx-&mailx-version;.tar.bz2">
  <!ENTITY mailx-download-ftp  " ">
  <!ENTITY mailx-md5sum        "67e8236a73f8a2d85c45cf8a2bdf7af1">
  <!ENTITY mailx-size          "268 KB">
  <!ENTITY mailx-buildsize     "3.2 MB">
  <!ENTITY mailx-time          "less than 0.1 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">mailx-&mailx-version;.tar</keyword>
      <keyword role="ftpdir">mailx</keyword>
    </keywordset>
  </sect1info>

  <title>Heirloom mailx-&mailx-version;</title>

  <indexterm zone="mailx">
    <primary sortas="a-Heirloom-mailx">Heirloom mailx</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Heirloom mailx</title>

    <para>The <application>Heirloom mailx</application> package (formerly
    known as the <application>Nail</application> package) contains
    <command>mailx</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>Heirloom mailx</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="&mailx-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&mailx-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &mailx-md5sum;</para>
      </listitem>
      <listitem><para>Download size: &mailx-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &mailx-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &mailx-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Heirloom mailx Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="openssl"/> or
    <xref linkend="nss"/>,
    <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 Heirloom mailx</title>

    <para>Install <application>Heirloom mailx</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 UCBINSTALL=/usr/bin/install install &amp;&amp;
ln -v -sf mailx /usr/bin/mail &amp;&amp;
ln -v -sf mailx /usr/bin/nail &amp;&amp;
install -v -m755 -d /usr/share/doc/mailx-&mailx-version; &amp;&amp;
install -v -m644 README mailx.1.html /usr/share/doc/mailx-&mailx-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 UCBINSTALL=/usr/bin/install
    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 Heirloom mailx</title>

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

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

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

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

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

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

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

  </sect2>

</sect1>