kwybnc is a small IRC proxy for UNIX operating systems. Its main
design goals are efficiency, low memory footprint, small binary size
and security.

kwybnc is written by Ulrich Rhein <uli@lk2hoppe.de> and published
under the terms and conditions of the GNU General Public License
Version 2. See LICENSE for further information.

Installation
------------
Get kwybnc. You can fetch a kwybnc release at
http://kwybnc.sourceforge.net or the current developer version from
anonymous CVS by performing

$ cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/kwybnc login 
$ cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/kwybnc co kwybnc2

If you get a release (which is the recommended option for kwybnc
users), unpack it using

tar xfj kwybnc-<version>.tar.bz2
cd kwybnc-<version>

You need GNU Make for compiling the source. You can optionally make
use of the diet libc by doing the following:

$ ed Makefile
/DIET/s,^#,,
wq
$

Then, type 'make'. kwybnc will then be built. You may place then the
kwybnc binary to your favourite target directory.

Configuration
-------------

Startup: kwybnc <PATH-TO-CONFIG-FILE-DIRECTORY>

kwybnc reads its configuration files from seven distinct files in a
common directory. The directory has to be executable (kwybnc chdir(2)s
to it). All files are mandatory. Here is a list:

"bindaddress"		The address kwybnc bind(2)s to. If you want kwybnc
			bind itself to all addresses, put "0.0.0.0" in
			there.
"bncpasswd"		The password part in the BAUTH command.
"bncport"		kwybnc's server port.
"bncuser"		The user part in the BAUTH command.
"ircnick"		kwybnc's default nick when connecting to an IRC
			server.
"ircport"		The port of the IRC server kwybnc connects to.
"ircuser"		kwybnc's default USER.
"server"		The server's IP address.

Additionally, you can configure some stuff at compile time in config.h in
the kwybnc source.

Bugs
----

Report bugs directly to me (<uli@lk2hoppe.de>) or to the bug tracker at
<http://sourceforge.net/projects/kwybnc/>.

Thanks
------

kwybnc was partially inspired by sbnc, written by Karsten 'soohrt' Desler.

CVS Revision: $Id: README,v 1.1 2003/12/08 18:46:22 upr Exp $