source: networking/mailnews/mailx.xml

<?xml version="1.0" encoding="UTF-8"?>
<!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;

  <!-- upstream is apparently still using CVS at sourceforge,
  but not making tarballs.  fedora have a script using CVS, but
  debian keep a tarball -->
  <!ENTITY mailx-download-http "&sources-anduin-http;/mailx/heirloom-mailx_&mailx-version;.orig.tar.gz">
  <!ENTITY mailx-download-ftp  " ">
  <!ENTITY mailx-md5sum        "29a6033ef1412824d02eb9d9213cb1f2">
  <!ENTITY mailx-size          "317 KB">
  <!ENTITY mailx-buildsize     "3.2 MB">
  <!ENTITY mailx-time          "less than 0.1 SBU">
]>

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


  <title>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. It 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>

    &lfs121_checked;

    <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">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>
          Required patch: <ulink
          url="&patch-root;/heirloom-mailx-&mailx-version;-fixes-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <!-- <xref linkend="openssl10"/> or -->
      <xref linkend="nss"/>,
      <xref linkend="mitkrb"/> (for IMAP GSSAPI authentication), and an
      <xref linkend="server-mail"/>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Heirloom mailx</title>

   <!-- see r12697 for explanation, and still used by fedora even though it often
    does work with a parallel make -->
    <note>
      <para>
        This package does not support parallel build.
      </para>
    </note>

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

<screen><userinput>patch -Np1 -i ../heirloom-mailx-&mailx-version;-fixes-1.patch &amp;&amp;

sed 's@&lt;openssl@&lt;openssl-1.0/openssl@' \
    -i openssl.c fio.c makeconfig      &amp;&amp;

make -j1 LDFLAGS+="-L /usr/lib/openssl/" \
         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/heirloom-mailx-&mailx-version; &amp;&amp;
install -v -m644 README /usr/share/doc/heirloom-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>
<!-- ~/.nailrc seems not to be supported anymore
        <filename>/etc/nail.rc</filename>, <filename>~/.mailrc</filename>
        and <filename>~/.nailrc</filename>
-->
        <filename>/etc/nail.rc</filename> and <filename>~/.mailrc</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>

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

      <para>
        For displaying mails, <application>mailx</application>
        uses a pager program. Since the default of <command>pg</command>
        is not available on a LFS system, its required to
        specify which pager is to use. By default, there is
        <command>more</command> and the more comfortable
        <command>less</command> installed. If the
        variable PAGER is not set in <filename>/etc/profile</filename>
        or <filename>~/.bash_profile</filename>, or if it
        should be another pager just for reading mails, it can be
        set system wide in <filename>/etc/nail.rc</filename>:
      </para>

      <screen role="nodump"><userinput>echo "set PAGER=<replaceable>&lt;more|less&gt;</replaceable>" &gt;&gt; /etc/nail.rc</userinput></screen>

      <para>or individually for the actual user in <filename>~/.mailrc</filename>:</para>

      <screen role="nodump"><userinput>echo "set PAGER=<replaceable>&lt;more|less&gt;</replaceable>" &gt;&gt; ~/.mailrc</userinput></screen>

      <para>
        Other interesting options to set in the config files might
        be EDITOR and MAILDIR.
      </para>

      <para>
        If not set in the environment for other packages, the
        default editor can be set by:
      </para>

      <screen role="nodump"><userinput>echo "set EDITOR=<replaceable>&lt;vim|nano|...&gt;</replaceable>" &gt;&gt; /etc/nail.rc</userinput></screen>

      <para>
        Depending on which kind of <xref linkend="server-mail"/> is
        installed, it might be required to set the MAILDIR variable
        so <application>mailx</application> is able to find the mails:
      </para>

<screen role="nodump"><userinput>echo "set MAILDIR=Maildir" &gt;&gt; /etc/nail.rc</userinput></screen>

    </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="b-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="b-nail">nail</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>