?index
These are the available help subjects:
 commands - All available commands and settings
 clients - Using ctrlproxy with different clients
 logging - Information about setting up logging
 about - About information

You can read more about them with help <subject>
For other questions about ctrlproxy, please join #ctrlproxy on Freenode (irc.freenode.net)
%
?admin
CtrlProxy supports remote administration through IRC. Commands can be executed by either using the /CTRLPROXY command in your IRC client, sending them to the nickctrlproxy on a network or by connecting to the admin network, which is built into CtrlProxy.
It is also possible to use this interface from the command-line on the machine where CtrlProxy is running by using thectrlproxy-admin command.
The syntax for the commands is very simple: the command should be followed by one or arguments, separated by spaces. Quoting is not supported. Those familiar with NickServ or ChanServ will already be used to this syntax.
%
?commands
The following commands are available:
 * network add - Adds a new network
 * addserver - Adds a new server to the specified network.
 * backlog - Send backlog for a single channel or network.
 * charset - Change client charset
 * connect - Connect to a network
 * network del - Delete a network
 * die - Close ctrlproxy
 * disconnect - Disconnect from a network
 * detach - Detach the current client
 * echo - Echo specified text
 * network list - Print list of networks
 * set log_level - Change or display log level
 * set report-time - Change whether time should be printed when displaying backlog
 * set motd-file - Change or display the MOTD path
 * set - Change settings
 * nextserver - Connect to next server in network
 * saveconfig - Save configuration
 * startlistener - Add a new listener
 * stoplistener - Stop listener
 * listlistener - List existing listeners
 * help - Print help
%
?network add
Syntax: network add <name>

Add a new network with the specified name.
%
?addserver
Syntax: ADDSERVER <network> <host>[:<port>] [<password>]

Example: addserver OPN irc.freenode.net:6667
%
?backlog
Syntax: BACKLOG [<channel>]

Without any arguments, the BACKLOG command replicates all the backlogs for the current network.
With one argument, the name of a channel, all lines on that channel are replicated.
%
?charset
Syntax: CHARSET <charset>

Change the character set that ctrlproxy should expect the client to send data in.
See the output of iconv -l for a list of possible character sets.
%
?connect
Syntax: CONNECT <network>

Connect to the specified network. Ctrlproxy will connect to the first known server for this network.
%
?network del
Syntax: network del <network>

Remove the specified network. The network may not be connected.
%
?die
Syntax: DIE

Disconnect all clients and servers and exit ctrlproxy.
%
?disconnect
Syntax: DISCONNECT <network>

Disconnect from the specified network.
%
?detach
Syntax: DETACH

Detach client from the proxy.
%
?echo
Syntax: ECHO <text>

Repeats specified text. Useful mainly for debugging.
%
?network list
Syntax: network list

Prints out a list of all networks ctrlproxy is connected to at the moment.
%
?set log_level
Syntax: set log_level [<level>]

View or change the CtrlProxy internal log level.
%
?set report-time
Syntax: set report-time [<true|false>]

Whether or not time should be displayed when sending backlog to the user.
%
?set motd-file
Syntax: set log_level [<level>]

View or change the path of the message-of-the-day clients see when they log on.
%
?set
Syntax: set [<name> [<value>]]

List, view or change internal settings.
Specifying no argument will list all available settings.
%
?nextserver
Syntax: NEXTSERVER [<NETWORK>]

Makes the specified network disconnect from the current server and go to the next one.
%
?saveconfig
Syntax: SAVECONFIG [<path>]

Save the (updated) configuration to the location it was loaded from (usually $HOME/.ctrlproxy/).
%
?startlistener
Syntax: STARTLISTENER [<address>:]<port> <password> [<network>]

Add listener on specified port
%
?stoplistener
Syntax: STOPLISTENER [<address>:]<port>

Stop listener on specified port
%
?listlistener
Syntax: LISTLISTENER

List all listeners
%
?help
Syntax: HELP [<topic>]

Prints out list of available commands.
%
?admin example
Adding a new network called 'OFTC', listening for incoming connections on port 6667.network add OFTC addserver OFTC irc.oftc.net connect OFTC
%
?clients
This chapter contains some brief information on how to configure various IRC clients for use with CtrlProxy.
All IRC clients should be able to work with ctrlproxy (ctrlproxy acts just like any other IRC server and follows the RFC's). Please let us know on the CtrlProxy IRC channel if you find a client that is not working.
%
?irssi
Configure the port and password settings in ~/.ctrlproxy/config and run the following commands in irssi:/set proxy_address ctrlproxy-host/set proxy_password ctrlproxy-password/set proxy_port ctrlproxy-port/set use_proxy ONYou should now be able to connect to any networks as you normally would with irssi.
%
?xchat
Configure socks in xchat to point at the host and port ctrlproxy is listening on. If you specified a password in the ctrlproxy configuration, specify it here as well. CtrlProxy will ignore the username that is sent by xchat.
%
?bitchx
Configure socks in BitchX:/SET socks_host ctrlproxy-hostand, if you're running ctrlproxy on a port different than 1080:/SET socks_port ctrlproxy-port
%
?other-socks-clients
Clients with SOCKS support can simply configure ctrlproxy as if it was an ordinary SOCKS proxy. The username sent by the client is ignored by CtrlProxy, the password has to match the password configured in ctrlproxy's configuration.
%
?other-clients
Other clients can connect to ctrlproxy as if they were connecting to a standard IRC server.
The client should log in with the password that was configured in the configuration file, followed by a colon and the name of the network to connect to.
For example, the password to use to login to the network Freenode with the ctrlproxy password set to geheim would be:geheim:Freenode.
%
?commands
The following commands are available:
 * network add - Adds a new network
 * addserver - Adds a new server to the specified network.
 * backlog - Send backlog for a single channel or network.
 * charset - Change client charset
 * connect - Connect to a network
 * network del - Delete a network
 * die - Close ctrlproxy
 * disconnect - Disconnect from a network
 * detach - Detach the current client
 * echo - Echo specified text
 * network list - Print list of networks
 * set log_level - Change or display log level
 * set report-time - Change whether time should be printed when displaying backlog
 * set motd-file - Change or display the MOTD path
 * set - Change settings
 * nextserver - Connect to next server in network
 * saveconfig - Save configuration
 * startlistener - Add a new listener
 * stoplistener - Stop listener
 * listlistener - List existing listeners
 * help - Print help
%
?network add
Syntax: network add <name>

Add a new network with the specified name.
%
?addserver
Syntax: ADDSERVER <network> <host>[:<port>] [<password>]

Example: addserver OPN irc.freenode.net:6667
%
?backlog
Syntax: BACKLOG [<channel>]

Without any arguments, the BACKLOG command replicates all the backlogs for the current network.
With one argument, the name of a channel, all lines on that channel are replicated.
%
?charset
Syntax: CHARSET <charset>

Change the character set that ctrlproxy should expect the client to send data in.
See the output of iconv -l for a list of possible character sets.
%
?connect
Syntax: CONNECT <network>

Connect to the specified network. Ctrlproxy will connect to the first known server for this network.
%
?network del
Syntax: network del <network>

Remove the specified network. The network may not be connected.
%
?die
Syntax: DIE

Disconnect all clients and servers and exit ctrlproxy.
%
?disconnect
Syntax: DISCONNECT <network>

Disconnect from the specified network.
%
?detach
Syntax: DETACH

Detach client from the proxy.
%
?echo
Syntax: ECHO <text>

Repeats specified text. Useful mainly for debugging.
%
?network list
Syntax: network list

Prints out a list of all networks ctrlproxy is connected to at the moment.
%
?set log_level
Syntax: set log_level [<level>]

View or change the CtrlProxy internal log level.
%
?set report-time
Syntax: set report-time [<true|false>]

Whether or not time should be displayed when sending backlog to the user.
%
?set motd-file
Syntax: set log_level [<level>]

View or change the path of the message-of-the-day clients see when they log on.
%
?set
Syntax: set [<name> [<value>]]

List, view or change internal settings.
Specifying no argument will list all available settings.
%
?nextserver
Syntax: NEXTSERVER [<NETWORK>]

Makes the specified network disconnect from the current server and go to the next one.
%
?saveconfig
Syntax: SAVECONFIG [<path>]

Save the (updated) configuration to the location it was loaded from (usually $HOME/.ctrlproxy/).
%
?startlistener
Syntax: STARTLISTENER [<address>:]<port> <password> [<network>]

Add listener on specified port
%
?stoplistener
Syntax: STOPLISTENER [<address>:]<port>

Stop listener on specified port
%
?listlistener
Syntax: LISTLISTENER

List all listeners
%
?help
Syntax: HELP [<topic>]

Prints out list of available commands.
%
?about
CtrlProxy was written by Jelmer Vernooij with the help from various other people. See the AUTHORS file in the tarball for details.
The CtrlProxy homepage can be found athttp://www.ctrlproxy.org/.
%
?logging
CtrlProxy has various means for logging conversions to file.
%
?log irssi
By setting log_irssi_path to a directory, ctrlproxy will write log files to that directory in the same format as is default in irssi.
Each channel or nick gets it's own seperate log file, which is located in a directory with the name of the IRC network.
If no directory is specified, data will be logged to $HOME/.ctrlproxy/log_irssi/$NETWORK/$CHANNEL.
%
?log custom
Module that writes logs to one or more files using a defined format.
This module may be used to write out log files that can be parsed by scripts or bots or logs in the same format as your favorite IRC client.
%
?log custom variables
The configuration values define the syntax that is used to write out log file lines. In these configuration values, values beginning with a '%' can be substituted.
The following characters are allowed after a percent sign for all types of lines:
 h - Current time of day, hours field.
 M - Current time of day, number of minutes.
 s - Current time of day, number of seconds.
 n - Nick originating the line (saying the message, doing the kick, quitting, joining, etc).
 u - Hostmask of the user originating the line.
 N - Name of the current IRC network.
 S - Name of the server (as set by the transport).
 % - Percent sign
 0,1,2,3,4,5,6,7,8,9 - Substituted with the respective argument 
						in the IRC line.
 @ - Replaced by channel name if the message 
						is directed to a channel, the nick name to which 
						the message is being sent, or the name of the sender 
						of the message when the receiver is the user 
						running ctrlproxy.

Each type of line also has some variables of it's own that it substitutes.
%
?introduction
%
?whatis
Ctrlproxy is an IRC proxy or BNC (bouncer). It keeps a permanent connection to one or more IRC servers. The user can then connect and disconnect his/her IRC client to the bouncer without actually disconnecting from the 'real' IRC server.
Any conversations (or parts of them) that happen on IRC while the user is disconnected can then be sent when the user connects again or asks for them explicitly.
It is also be possible to log into CtrlProxy from multiple locations simultaneously while using one and the same nick name on IRC.
%
?features
%
?requirements
%
