Merge fix for logging of mode changes by charly.
[jelmer/ctrlproxy.git] / README
1 ctrlproxy
2 ==============
3 Jelmer Vernooij <jelmer@nl.linux.org>
4
5 For a quick start, see the bottom of this file.
6
7 If you are upgrading from an older version of ctrlproxy, please read the 
8 file UPGRADING.
9
10 Introduction
11 ------------
12 CtrlProxy is a lightweight IRC proxy. It allows you to keep a permanent 
13 connection open to an IRC server and using that connection from wherever 
14 you would like to use IRC, without the need to disconnect and connect to IRC 
15 continuously while missing text. 
16
17 Information for users upgrading from 2.6 or 2.7-preXX:
18 ------------------------------------------------------
19
20 The configuration is now maintained as a set of flat-text files in 
21 ~/.ctrlproxy/. Existing configuration files can be upgraded by 
22 running the experimental upgrade utility available in the directory 'scripts' 
23 in the source tarball.
24
25 Features
26 --------
27  * Connect to one server with many clients under one nick transparently
28  * Connect to multiple servers using only one process
29  * CTCP support when no client is attached
30  * Transparent detaching and attaching of clients
31  * Password support
32  * Replication support
33  * Auto-Away support
34  * Keeping track of events occuring 
35  * Direct, inetd-style interfacing with local IRC servers (such as BitlBee)
36  * Works transparently
37  * SSL support
38  * Custom logging in any format you specify
39  * Flood protection
40  * IPv6 Support
41  * Automatic NickServ support
42  * Low memory, CPU and bandwidth requirements
43  * Management of running instances using a command-line tool or 
44    over IRC.
45
46 Dependencies
47 ------------
48  * GNU glib
49  * GNU TLS (optional, for SSL support)
50  * Python (optional, for Python scripting)
51  
52 Building
53 --------
54
55 ctrlproxy can be installed by running:
56
57 ::
58
59         $ ./configure
60         $ make
61         $ make install
62         
63 If you have a bzr checkout, run :
64
65 ::
66
67         $ ./autogen.sh
68
69 before you run ./configure, make and make install
70
71 Quick start
72 -----------
73 1. Install ctrlproxy
74
75 2. Run ctrlproxy --init 
76
77 Enter a password and a port to ctrlproxy should listen on.
78
79 CtrlProxy will write a configuration to ~/.ctrlproxy. You may 
80 want to edit ~/.ctrlproxy/config.
81
82 3. Run ctrlproxy --daemon or ctrlproxy
83
84 4. Connect to ctrlproxy from your IRC client on the port you specified earlier. 
85 For more information on connecting with your favorite IRC client, see the 
86 user guide.
87
88 Documentation
89 -------------
90 Most documentation is in the user guide and the 
91 manpages: ctrlproxy(1) and ctrlproxy_config(5).
92 The example config.example file might also be of some use.
93
94 Reporting Bugs
95 --------------
96 Bugs can be reported at http://bugs.bitlbee.org/ctrlproxy/