source: archive/slrn.xml@ 69b2349

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

  <!ENTITY slrn-download-http "&sourceforge-repo;/slrn/slrn-&slrn-version;.tar.bz2">
  <!ENTITY slrn-download-ftp  "ftp://ftp.fh-heilbronn.de/pub/mirrors/slrn/slrn-&slrn-version;.tar.bz2">
  <!ENTITY slrn-md5sum        "9b613007df537444a5f8a4a2994fadb7">
  <!ENTITY slrn-size          "1011 KB">
  <!ENTITY slrn-buildsize     "9.3 MB">
  <!ENTITY slrn-time          "0.19 SBU">
]>

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

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

  <title>Slrn-&slrn-version;</title>

  <indexterm zone="slrn">
    <primary sortas="a-Slrn">Slrn</primary>
  </indexterm>

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

    <para><application>slrn</application> is a slang-based news reader, capable of
    reading local news spools as well as groups from an NNTP server. Small local news
    spools can also be created with the use of the <command>slrnpull</command>
    program included in the <application>slrn</application> distribution.</para>

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

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="openssl"/>,
    <ulink url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>,
    <ulink url="http://www.fpx.de/fp/Software/UUDeview/">UUDeview</ulink>,
    <ulink url="http://www.isc.org/index.pl?/sw/inn/">INN</ulink> and
    <ulink url="http://homepage.mac.com/imeowbot/iblog/C1355421991/">libcanlock</ulink></para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc \
    --with-slrnpull --enable-spool &amp;&amp;
make</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 install</userinput></screen>

  </sect2>

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

    <para><parameter>--with-slrnpull --enable-spool</parameter>: These
    switches enable building the <command>slrnpull</command>
    executable.</para>

    <para><option>--with-ssl</option>: This switch adds
    <application>OpenSSL</application> support to
    <application>slrn</application>.</para>

    <para><option>--with-uudeview</option>: This switch adds
    <application>UUDeview</application> support to
    <application>slrn</application>.</para>

  </sect2>

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

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

      <para><filename>/etc/slrn.rc</filename>,
      <filename>~/.slrnrc</filename></para>

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

      <indexterm zone="slrn slrn-config">
        <primary sortas="e-AA.slrnrc">~/.slrnrc</primary>
      </indexterm>

    </sect3>

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

      <para>The first time <command>slrn</command> is run, the
      <filename>~/.jnewsrc</filename> file must be created. For this configuration
      to work, you must have an environmental variable, <envar>NNTPSERVER</envar>,
      set. In normal operation it would be exported into the environment by a startup file,
      like <filename>/etc/profile</filename> or <filename>~/.bashrc</filename>. Here it
      is just put it into the environment of the configuration step. For now, the LFS news
      server is used in this example, but you should use whatever server you prefer.</para>

      <para>Create the <filename>~/.jnewsrc</filename> file with the following
      command:</para>

<screen><userinput>NNTPSERVER=<replaceable>&lt;news.&lfs-domainname;&gt;</replaceable> \
    slrn -f ~/.jnewsrc --create</userinput></screen>

      <indexterm zone="slrn slrn-config">
        <primary sortas="e-AA.jnewsrc">~/.jnewsrc</primary>
      </indexterm>

      <para>You will also have to edit one of the configuration files. There is a sample
      startup <filename>/usr/share/doc/slrn/slrn.rc</filename> file that comes with
      <application>slrn</application>. It is extensively documented but if you need more
      information, look at <ulink url="http://slrn.sourceforge.net/docs/">the
      <application>slrn</application> website</ulink>.</para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>slrn and slrnpull</seg>
        <seg>None</seg>
        <seg>/usr/share/slrn and usr/share/doc/slrn</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="slrn-prog">
        <term><command>slrn</command></term>
        <listitem>
          <para>is the slang-based news reader.</para>
          <indexterm zone="slrn slrn-prog">
            <primary sortas="b-slrn">slrn</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="slrnpull">
        <term><command>slrnpull</command></term>
        <listitem>
          <para>is used to pull a small news feed from an NNTP server for offline
          reading.</para>
          <indexterm zone="slrn slrnpull">
            <primary sortas="b-slrnpull">slrnpull</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>