ctrlproxy
==============
Jelmer Vernooij <jelmer@nl.linux.org>

For a quick start, see the bottom of this file.

If you are upgrading from an older version of ctrlproxy, please read the 
file UPGRADING.

Introduction
------------
CtrlProxy is a lightweight IRC proxy. It allows you to keep a permanent 
connection open to an IRC server and using that connection from wherever 
you would like to use IRC, without the need to disconnect and connect to IRC 
continuously while missing text. 

Features
--------
 * Connect to one server with many clients under one nick transparently
 * Connect to multiple servers using only one process
 * CTCP support when no client is attached
 * irssi-style logging support
 * Transparent detaching and attaching of clients
 * Password support
 * Replication support
 * Auto-Away support
 * Keeping track of events occuring 
 * Direct, inetd-style interfacing with local IRC servers (such as BitlBee)
 * Works transparently
 * SSL support
 * Custom logging in any format you specify
 * Flood protection
 * IPv6 Support
 * Automatic NickServ support
 * Low memory, CPU and bandwidth requirements

Requirements
------------
 * GNU glib
 * GNU TLS (optional)
 
Building
--------

ctrlproxy can be installed by running:

$ ./configure
$ make
$ make install

If you have a bzr checkout, run :

$ ./autogen.sh

before you run ./configure, make and make install

Quick start
-----------
1. Install ctrlproxy

2. Run ctrlproxy --init 

2. Run ctrlproxy --daemon or ctrlproxy

3. Connect to ctrlproxy from your IRC client.

Documentation
-------------
Most documentation is in the manual and the 
manpages: ctrlproxy(1) and ctrlproxy_config(5).
The example config.example file might also be of some use.
