source: basicnet/mailnews/slrn.xml@ 4a46bf8

<?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 slrn-download-http "http://prdownloads.sourceforge.net/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-size          "1011 KB">
  <!ENTITY slrn-buildsize     "9.3 MB">
  <!ENTITY slrn-time          "0.19 SBU">
]>

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

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

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

<sect3><title>Package information</title>
<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 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>
</sect3>

<sect3><title><application>slrn</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="slang"/> and <acronym>MTA</acronym> (See <xref linkend="server-mail"/>)</para></sect4>

<sect4><title>Optional</title>
<para>
<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></sect4>
</sect3>

</sect2>

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

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

<screen><userinput><command>./configure --prefix=/usr --sysconfdir=/etc \
    --with-slrnpull --enable-spool &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>

</sect2>

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

<para><parameter>--with-slrnpull --enable-spool</parameter>: Build the
<command>slrnpull</command> executable.</para>

</sect2>

<sect2>
<title>Configuring <application>slrn</application></title>

<sect3><title>Config files</title>
<para><filename>/etc/slrn.rc</filename>,
<filename>~/.slrnrc</filename></para>
</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 we will just put it into the
environment of the configuration step. We will use the
<acronym>LFS</acronym> news server 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><command>NNTPSERVER=<replaceable>news.linuxfromscratch.org</replaceable> \
    slrn -f ~/.jnewsrc --create</command></userinput></screen>

<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 slrn. It is extensively documented but if you
need more information, look at <ulink
url="http://slrn.sourceforge.net/docs/">the slrn
website</ulink>.</para>

</sect3>

</sect2>

<sect2>
<title>Contents</title>
<para>The <application>slrn</application> package contains 
<command>slrn</command> and
<command>slrnpull</command>.</para>
</sect2>

<sect2><title>Description</title>

<sect3><title>slrn</title>
<para><command>slrn</command> is the slang-based news reader.</para></sect3>

<sect3><title>slrnpull</title>
<para><command>slrnpull</command> is used to pull a small news feed from
an <acronym>NNTP</acronym> server for offline reading.</para></sect3>

</sect2>

</sect1>