← Back to branch summary

~ctrlproxy/ctrlproxy/trunk

« back to all changes in this revision

Viewing changes to README

  • Committer: jelmer
  • Date: 2003-10-18 22:02:02 UTC
  • Revision ID: jelmer@samba.org-20031018220202-6801a76318fb4d13
Update

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
1
 
ctrlproxy 0.6
 
1
ctrlproxy
2
2
==============
3
 
 
4
 
Jelmer Vernooij <jelmer@nl.linux.org>, 14 October 2002
 
3
Jelmer Vernooij <jelmer@nl.linux.org>
5
4
 
6
5
Why ctrlproxy?
7
6
--------------
11
10
of course run irssi on my workstation, but my workstation isn't on 
12
11
24/7 and some people depend on the channel logs I generate.
13
12
 
 
13
The structure of ctrlproxy is very modular and it is easily extendible.
 
14
 
14
15
Features
15
16
--------
16
17
 * Connect to one server with many clients under one nick transparently
19
20
 * irssi-style logging support
20
21
 * Transparent detaching and attaching of clients
21
22
 * Password support
 
23
 * Replication support (from memory)
 
24
 * Auto-Away support
 
25
 * Keeping track of events occuring 
 
26
 * Direct, inetd-style interfacing with local IRC servers (such as bitlbee)
 
27
 * Responses to queries are only sent to the originator of the query
 
28
 * SSL support
 
29
 * Custom logging in any format you specify
 
30
 * Flood protection
22
31
 
23
32
Requirements
24
33
------------
25
34
 * libpopt
26
 
 * GNU libc
 
35
 * GNU glib
 
36
 * libxml2
 
37
 
 
38
 And for the stats module:
 
39
 * libtdb
 
40
 * libpcre (optional)
27
41
 
28
42
Building
29
43
--------
30
 
 
31
 
ircproxy can be installed using:
32
 
 
 
44
 
 
45
ctrlproxy can be installed using:
 
46
 
 
47
$ ./configure
33
48
$ make
34
49
$ make install
35
50
 
36
 
You might want to change the PREFIX in Makefile.settings
 
51
If you have a CVS checkout, run :
 
52
 
 
53
$ autoreconf
 
54
 
 
55
before you run ./configure, make and make install
37
56
 
38
57
Documentation
39
58
-------------
40
 
Most documentation is in the manpages: ctrlproxy(1) and ctrlproxyrc(5)
 
59
Most documentation is in the manual and the 
 
60
manpages: ctrlproxy(1) and ctrlproxyrc(5).
41
61
The example ctrlproxyrc file might be of some use..
 
62
 
 
63
After you've installed, configured and started ctrlproxy you can connect to 
 
64
it on port 6668 and up.
 
65
 
 
66
Petnames
 
67
--------
 
68
During the time I have been using ctrlproxy, people have been giving it some 
 
69
weird nick names, you'd probably have to know dutch to understand them:
 
70
 
 
71
- ctrlbraxy
 
72
- ctrlprutsy
 
73
- kont-rol proxy