irmp3-ncurses
=============

A curses frontend for irmp3 using the network control module.
Copyright (C) 2003-2005 Ross Axe <ross.axe@blueyonder.co.uk>


	Legal Stuff:
This program is free software; you can redistribute it and/or modify
it under the terms of version 2 of the GNU General Public License as
published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
file COPYING for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA


	Requirements:
Not much I suspect.  You need a Unix-like system and a curses library. 
Also works with Cygwin, MinGW, MacOS-X and possibly DJGPP.  It's mostly tested
with Slackware Linux 10.2 and ncurses 5.4.  Any curses library *should* work,
but you don't get mouse support without ncurses.  PDCurses also works quite
well.  You will need gcc to compile, or another compiler that implements enough
C99. It's been tested with irmp3 0.5.7pre1.  Other versions should work
(hopefully). mod_netctl is obviously essential.  Playlist and browser support
are also assumed.  Any old hardware should do, hopefully.  Disabling the
playlist may help in the case of (really) low RAM and large playlists.  It may
also help if you're having bandwidth problems, particularly if you read the
audio files over the network.


	Configuration:
irmp3-ncurses uses GNU autoconf and accepts all standard autoconf options, as
listed in the file INSTALL.  irmp3-ncurses specific options to ./configure are
as follows:

--enable-mouse		   Try to use ncurses mouse support
--enable-irmp3-host	   These options set the default server to contact if
--enable-irmp3-port	one is not specified on the command line
--enable-v04x		   Target specific irmp3 version. 0.4.x is now
--enable-v05x		disabled by default
--enable-playlist	   Display a playlist window to the right. This is
			enabled by default
--enable-logging	   Allow saving the contents of the debug window to a
			file. Also set the default log level. Defaults to "yes"
			(loglevel 0)
--enable-scrolling-titles  This option provides an opportunity to disable
			scrolling titles, in case configure guesses wrong, or
			you just don't like them.
--enable-poll-method	   Select method to use to poll for input. Options are:
		sigio	   Use SIGIO.  This is the default on POSIX platforms
				that support it.
		select	   potentially buggy, but should work on all
				POSIX platforms.
		wthread	   Windows threads; required when using Winsock.
				Only valid on MS-Windows.
			Normally, configure will make the correct choice.
--with-sockets		   Choose type of sockets to use.  Valid options are:
		winsock	   Use Windows sockets 1.1.  Only valid on MS-Windows.
				Implies --enable-poll-method=wthread.
		winsock2   Use Winsock 2.2.  Only valid on MS-Windows.
				Implies --enable-poll-method=wthread.
				This option has only been compile-tested.
		posix	   POSIX sockets API.  Used by most UNIXes
			Normally, configure will make the correct choice, with
			POSIX being preferred over Winsock if both are
			available (e.g. cygwin, winelib).
--with-curses		   Normally, configure will automatically detect which
			curses library to use. In the case of multiple curses
			libraries being available on you system, this option
			provides a way to override the default choice.
			Currently available choices are:
		auto		search for ncurses, xcurses, pdcurses and
					curses, in that order
		ncurses		only look for ncurses
		xcurses		only look for XCurses (the X11 port of
					PDCurses)
		pdcurses	only look for PDCurses
		slang		only look for S-Lang curses emulation
		curses		prefer the library installed as -lcurses, but
					accept any
			NOTE: xcurses support is currently broken.
--disable-colour	   Do not try to use colour, even on terminals that
--disable-color		support it.  The default is to use colour.

Read the INSTALL file for full installation instructions, but essentially
it's just...

$ ./configure [options ...]
$ make
$ su
# make install

...as usual.

Lazy people (like me) can use --enable-irmp3-host="hostname" to set the default
target.  This accepts DNS names as well.  The port can also be set in this way
and defaults to 9232, same as irmp3d.


For usage information, read the man page (man 1 irmp3-ncurses).  Keystroke help
is also available by hitting '?' in the program.


That's it.  Any problems, suggestions or bug/success reports etc, just
email me at <ross.axe@blueyonder.co.uk>
