This page allows you to view and download the documentation that usually comes with slrn, both as plain text and (where available) as HTML. Please note that the FAQ and Reference Manual have their own page.
A Polish translation of the documents found on this page is available from the slrn-pl website.

User's Guide

The slrn FAQ [plain text]

Certain questions come up again and again - this document answers some of them. Please read it before mailing me or posting to Usenet.

Setting up slrn for the first time [plain text]

This document assumes that you have slrn installed (either from sourcecode or using a binary package) and guides you through the configuration until you can use it for the first time.

An introduction to ``scoring'' [plain text]

This text explains the idea behind ``scoring'' and gives you all the information you need to write your personal scorefile for slrn. It also contains an example score file which you might find helpful as a starting point.

Reference documentation

slrn's manual page [man format] [plain text]

The manual page gives a quick overview of slrn, its command line options, as well as the environment variables and files it uses. If you need more detailed information, please refer to the reference manual.

slrnpull's manual page [man format] [plain text]

Like the manual page of slrn, but describing slrnpull.

The slrn reference manual [plain text]

The slrn reference manual gives a detailed explanation of every configuration option in slrn. If you want to read more about it or download it in one of different formats, please visit its separate page. There is now also an Italian translation of it available.

The intrinsic function reference manual [plain text]

This manual contains a complete list of the intrinsic functions slrn offers for use in S-Lang. If you want to extend slrn using this powerful macro language, you will find this very useful.

Changes in slrn [plain text]

This file documents the changes in slrn since version 0.4.0.

Keycodes for OS/2 and Win32 [plain text]

If you want to make use of the function keys, you need to know their escape sequences before you can bind them. OS/2 and Win32 do not generate the standard ANSI sequences, so you need this list to look them up.

README files

Installing slrn for multiple users [plain text]

Please read these notes if you want to set up slrn for multiple users.

Writing macros for slrn [plain text]

This document helps you to get started using the S-Lang macro language to extend slrn. It also contains a complete reference of the ``hooks'' slrn offers.

Reading news from secure servers (via SSL) [plain text]

Explains how to compile slrn with support for SSL and how to use it with secure servers afterwards.

True offline reading using slrn and slrnpull [plain text]

Describes how you can use slrn and slrnpull for "true offline reading", i.e. getting only the article headers first and selecting the article bodies you want to download.

Installing slrn on Unix-like systems [plain text]

A short explanation of how to build and install slrn from sourcecode on Unix-like systems. This includes a full reference of available configure options.

Installing slrn on Windows [plain text]

Some brief notes about how to install / compile slrn on Windows. Please note that they expect that you have some understanding about how both slrn and Windows work. There is documentation on the web which is far better suited for the end user. See our links page for details.

Installing slrn on OS/2 [plain text]

This file gives instructions about how to set up slrn on OS/2 and provides general information about the OS/2 port.

Installing slrn on VMS [plain text]

Describes the steps necessary to build slrn on VMS.

GroupLens support in slrn [plain text]

Some notes about the optional GroupLens support in slrn. Please note that this is likely to be removed from slrn in a future version.

Sample files

A sample configuration file [plain text]

The sample startup file that comes with slrn. It is extensively documented, so it should be easy to adapt to your needs. If you need even more information or cannot find an option, please look at the reference manual.

Download the documentation

Download the available documentation as a tarball (plain text)

Last updated on 2004-10-07

This tarball contains all the documentation that can be found on this page in plain text format.

Download the ``browseable'' documentation as a tarball (HTML)

Last updated on 2004-10-07

This tarball contains the documentation that has already been converted to HTML. Please note that this is currently only a subset of the available documentation. It also excludes the reference manual and FAQ, which are available for download separately.