NAME
ctrlproxy - a modular IRC proxy with multi-server
support
SYNOPSIS
- ctrlproxy [-d file] [-l file] [-D]
[-r file] [-v]
DESCRIPTION
ctrlproxy
- is a modular IRC proxy. It connects to a number of IRC servers
and then passes data it receives on to the modules that have been
loaded into it. Current modules are client_simple (for proxy
support) and log (for irssi-style log file generation).
By default, ctrlproxy listens for client connections on port
6668 and any ports after that one, depending on the number of
servers it is connected to.
OPTIONS
ctrlproxy recognizes the following command-line options
- -d, --debugfile=FILE
- Dump IRC traffic to specified file. Only useful for debugging
purposes.
- -D, --daemon
- Go to the background after the program has been started (daemon
mode).
- -r, --rc-file=RCFILE
- Read configuration file from specified location RCFILE
instead of from .ctrlproxyrc in the users' homedirectory.
- -v, --version
- Show copyright and version information
- -?, --help
- Show help message with short argument information
- -l, --log=FILE
- Log ctrlproxy messages to specified file.
- --usage
- Display brief usage message
PLUGINS
Current included plugins with ctrlproxy are:
- repl_memory
- Simple replication module. Replicates all data that has been
said before you disconnected.
- log_irssi
- Log irc traffic to a specified file, using the same style as
the irssi(1) IRC
client does.
- ctcp
- CTCP replies CTCP messages when there is no client connected to
ctrlproxy. Currently supported: VERSION, FINGER, CLIENTINFO, TIME
and SOURCE.
- auto-away
- Automatically sets /AWAY after specified amount of time
(defaults to 10 minutes).
- stats
- Keep track of the number of times a certain user on a certain
channel has used a certain pattern.
- socket
- Provides the ipv4, ipv6 and pipe transports. Required for
connecting to a IRC server.
- strip
- Makes sure that responses to queries from a certain client
don't go to the other clients.
- admin
- Provides remote administration support. Not implemented at the
moment.
- nickserv
- Automatically authenticate yourself with the NickServ service.
- antiflood
- Makes sure you don't send too much lines in a short period of
time, which might cause you to be kicked by the server with an
"Excess flood" message.
- log_custom
- Allows custom logging in a user-specified format.
Read the relevant manpages for more info about these plugins.
SIGNALS
When ctrlproxy receives a USR1 signal, it will save it's
current state to the configuration file (usually ~/.ctrlproxyrc).
SEE ALSO
irssi (1), ctrlproxyrc (5), http://www.nl.linux.org/~jelmer/ctrlproxy/,
ctrlproxyrc.example
BUGS
Probably many, but none are known at the moment. Please send any
you find to jelmer@nl.linux.org
LICENSE
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty
of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public
License along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple PLace, Suite 330, Boston, MA 02111-1307
USA
AUTHOR
[1]Jelmer Vernooij
REFERENCES
- 1. Jelmer Vernooij
- mailto: