1CTRLPROXY(1) CTRLPROXY(1)
2
6 ctrlproxy - a modular IRC proxy with multi-server support
7
9 ctrlproxy [-d file] [-l file] [-D] [-r file] [-v]
10
12 ctrlproxy is a modular IRC proxy. It connects to a number of IRC
13 servers and then passes data it receives on to the modules that have
14 been loaded into it. Current modules are client_simple (for proxy
15 support) and log (for irssi-style log file generation).
16 By default, ctrlproxy listens for client connections on port 6668 and
18 any ports after that one, depending on the number of servers it is
19 connected to.
20
22 ctrlproxy recognizes the following command-line options
23 -d, --debugfile=FILE
25 Dump IRC traffic to specified file. Only useful for debugging
26 purposes.
27 -D, --daemon
29 Go to the background after the program has been started (daemon
30 mode).
31 -r, --rc-file=RCFILE
33 Read configuration file from specified location RCFILE instead
34 of from .ctrlproxyrc in the users' homedirectory.
35 -v, --version
37 Show copyright and version information
38 -?, --help
40 Show help message with short argument information
41 -l, --log=FILE
43 Log ctrlproxy messages to specified file.
44 --usage
46 Display brief usage message
47
49 Current included plugins with ctrlproxy are:
50 repl_memory
52 Simple replication module. Replicates all data that has been
53 said before you disconnected.
54 log_irssi
56 Log irc traffic to a specified file, using the same style as the
57 irssi(1) IRC client does.
58 ctcp CTCP replies CTCP messages when there is no client connected to
60 ctrlproxy. Currently supported: VERSION, FINGER, CLIENTINFO,
61 TIME and SOURCE.
62 auto-away
64 Automatically sets /AWAY after specified amount of time
65 (defaults to 10 minutes).
66 stats Keep track of the number of times a certain user on a certain
68 channel has used a certain pattern.
69 socket Provides the ipv4, ipv6 and pipe transports. Required for
71 connecting to a IRC server.
72 strip Makes sure that responses to queries from a certain client don't
74 go to the other clients.
75 admin Provides remote administration support. Not implemented at the
77 moment.
78 nickserv
80 Automatically authenticate yourself with the NickServ service.
81 antiflood
83 Makes sure you don't send too much lines in a short period of
84 time, which might cause you to be kicked by the server with an
85 "Excess flood" message.
86 log_custom
88 Allows custom logging in a user-specified format.
89 Read the relevant manpages for more info about these plugins.
91
93 When ctrlproxy receives a USR1 signal, it will save it's current state
94 to the configuration file (usually ~/.ctrlproxyrc).
95
97 irssi (1), ctrlproxyrc (5), http://www.nl.linux.org/~jelmer/ctrlproxy/,
98 ctrlproxyrc.example
99
101 Probably many, but none are known at the moment. Please send any you
102 find to jelmer@nl.linux.org
103
105 This program is free software; you can redistribute it and/or modify it
106 under the terms of the GNU General Public License as published by the
107 Free Software Foundation; either version 2 of the License, or (at your
108 option) any later version.
109 This program is distributed in the hope that it will be useful, but
111 WITHOUT ANY WARRANTY; without even the implied warranty of
112 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
113 General Public License for more details.
114 You should have received a copy of the GNU General Public License along
116 with this program; if not, write to the Free Software Foundation, Inc.,
117 59 Temple PLace, Suite 330, Boston, MA 02111-1307 USA
118
120 [1]Jelmer Vernooij
121
123 1. Jelmer Vernooij
124 mailto:jelmer@nl.linux.org
125 08/27/2006 CTRLPROXY(1)