.Dd July 23, 2004
.Dt wnews 1
.Os
.Sh NAME
.Nm wnews
.Nd console-based RSS news reader
.Sh SYNOPSIS
.B wnews
-[abcfghilnprtvq]
.Sh DESCRIPTION
.Nm
was developed as a result of the shortage of the console-based RSS readers 
available out there. At the time of development, wnews was the only 
project to provide such functionality (at this time, the other alternative 
is snownews). This tool allows you to display RSS feeds in both human 
readable and parseable format in an ncurses interface, console-based interface or a GTK+ interface. In contract to other similar applications, wnews 
provides full RSS feed parsing, displaying news item descriptions properly 
for users to enjoy. In this sense, wnews can not only be used for reading 
news header, but even full news notifications.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl a
If in interactive mode, display window borders using standard ASCII 
characters.
.It Fl b
If in non-interactive mode, do not seperate RSS sections with horizontal
lines.
.It Fl c Ar number
Number of columns to wrap RSS items at, this option must be used with
.Fl t
option.
.It Fl f
Do not do perform any formatting on received data, just provide a raw dump 
of the RSS feed. This requires non-interactive mode to be used, see the
.Fl t
option.
.It Fl g
Run the gtk+ version.
.It Fl h
List the available
.Nm
options.
.It Fl i
Force the usage of the curses-based interactive user interface.
.It Fl l
Do not expand HTML character tags.
.It Fl n Ar number
Display [number] story from the RSS feed. This assumes the user is in 
non-interactive mode (see the
.Fl t
options).
.It Fl p Ar proxy
Use the specified HTTP proxy server, rather than the one specified in the 
user
.Nm
configuration file (see the
.Fl FILES
section).
.It Fl r
Output a list of all resources list in the
.Nm
resources file (see the
.Fl FILES
section).
.It Fl t Ar title
Rather than provide an interactive user interface, display the news items 
of the resource with the specified title to standard output.
.It Fl v
Output the current version of the
.Nm
program in use.
.It Fl q
Do not display the introductory
.Nm
banner on program start-up.
.Sh INTERACTIVE MODE
In interactive mode, the default browser key is 'b'. The user must press 
the space bar in order to browse a news resource, the tab key is used to 
navigate from window to window. The left and right keys will allow a user 
to scroll to the previous and next stories. The up and down keys scrolls 
the story contents.
.Sh FILES
.It Pa ~/.wnews/config
This file contains the user configuration of the
.Nm
client. Options are listed in <OPTION> <VALUE> format in seperate lines. 
The PROXY option expects a string argument containing a path to the HTTP 
proxy server to be used, with proxy port seperate by a semi-colon 
character. The INTERACTIVE option expects a yes or no string, this 
specifies if
.Nm
should execute the interactive console interface by default. The BROWSER 
option expects a string of the command to execute when the browser key is 
pressed and a %s format to represent the URL. The GZIP option expects a 
command to be executed when decompressing GZIP streams from HTTP. The 
TMPDIR option expects a string to the system temporary directory, to be 
used when decompressiong GZIP streams. There are various options available 
in order to change default keybindings, these options expect a single 
character argument. The options are; KEY_UP, KEY_DOWN, KEY_PUP (page up), 
KEY_PDN (page down), KEY_URL (key to display URL of news item), KEY_LEFT, 
KEY_RIGHT, KEY_TAB, KEY_ENTER, KEY_BROWSE (the character to launch a 
browser to display current news item URL), KEY_QUIT (the character to quit 
the application).
.It Pa ~/.wnews/resources
This file contains resource entries in seperate lines. These news sources 
are seperated by the "|" character. The fields are in the order of title, 
description and then an HTTP URL (no http:// or similar protocol 
definition must be used).
.Sh BUGS
This program has quite a bit of random bugs popping in and out. If you 
find any, please e-mail a full bug report to samy@kerneled.org.