.\"     Title: ctrlproxy
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
.\"      Date: 07/22/2007
.\"    Manual: 
.\"    Source: 
.\"
.TH "CTRLPROXY" "1" "07/22/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
ctrlproxy \- a modular IRC proxy with multi\-server support
.SH "SYNOPSIS"
.HP 10
\fBctrlproxy\fR [\-d\ file] [\-l\ file] [\-D] [\-\-init] [\-r\ file] [\-v]
.SH "DESCRIPTION"
.PP

\fBctrlproxy\fR
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).
.PP
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.
.SH "OPTIONS"
.PP
\fBctrlproxy\fR
recognizes the following command\-line options
.PP
\-i, \-\-inetd\-client=NETWORK
.RS 4
Add incoming client on stdin/stdout, connected to the specified network. This can be used for inetd\-like communication and testing.
.RE
.PP
\-d, \-\-debugfile=FILE
.RS 4
Dump IRC traffic to specified file. Only useful for debugging purposes.
.RE
.PP
\-D, \-\-daemon
.RS 4
Go to the background after the program has been started (daemon mode).
.RE
.PP
\-c, \-\-config\-dir=DIR
.RS 4
Read configuration files from the specified directory
\fBDIR\fR
instead of from
\fI.ctrlproxy\fR
in the users' homedirectory.
.RE
.PP
\-\-init
.RS 4
Create a new configuration file.
.RE
.PP
\-v, \-\-version
.RS 4
Show copyright and version information
.RE
.PP
\-?, \-\-help
.RS 4
Show help message with short argument information
.RE
.PP
\-l, \-\-log=FILE
.RS 4
Log ctrlproxy messages to specified file.
.RE
.PP
\-\-usage
.RS 4
Display brief usage message
.RE
.SH "SIGNALS"
.PP
When ctrlproxy receives a
\fBUSR1\fR
signal, it will save it's current state.
.SH "ENVIRONMENT VARIABLES"
.PP
CTRLPROXY_MODULESDIR
.RS 4
Override directory that will be searched for plugins.
.RE
.SH "SEE ALSO"
.PP
irssi (1), ctrlproxy_config(5), http://ctrlproxy.vernstok.nl/, config.example
.SH "BUGS"
.PP
Probably many, but none are known at the moment. Please send any you find to jelmer@nl.linux.org
.SH "LICENSE"
.PP
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.
.PP
This program is distributed in the hope that it will be useful, but \efBWITHOUT ANY WARRANTY\efR; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
.PP
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
.SH "AUTHORS"
.PP

\fIJelmer Vernooij\fR\&[1]
(main developer)
.PP

\fIDaniel Poelzleithner\fR\&[2]
(several major patches)
.PP
See the file AUTHORS for a full list of contributors.
.SH "REFERENCES"
.IP " 1." 4
Jelmer Vernooij
.RS 4
\%mailto:jelmer@nl.linux.org
.RE
.IP " 2." 4
Daniel Poelzleithner
.RS 4
\%mailto:ctrlproxy@poelzi.org
.RE