ctrlproxy_config — Configuration file for ctrlproxy
Ctrlproxy uses a configuration directory called .ctrlproxy
that lives inside the users' home directory. The main configuration
file lives in this directory and is called config. It
is an ini-style configuration file with sections and key-value pairs.
This manpage discusses the variables that can be set in this file in a standard ControlProxy installation.
The [global] section contains some of the most important settings.
Replication backend to use. See the section about replication below for details.
Set to true to prefix replicated lines with the time the line was sent.
Automatically save configuration on exit
Semi-colon separated list of networks or servers to connect to on startup.
Path to the message of the day file that is sent to clients upon connect.
If the replication backend is set to highlight, this variable should contain a semicolon-separated list of words to search for.
Port at which CtrlProxy should listen for new connections Connections can be plain IRC connections or using the SOCKS protocol.
Password for logging in to ctrlproxy.
If the [admin] section is present, ControlProxy will create a fake network with a control channel that can be used for administration.
Don't interpret messages to the user ctrlproxy as administration commands.
This option would be needed if you want to be able to send messages to an actual user with the nickname ctrlproxy.
If the [log-custom] section is present, ControlProxy
will write a log to ~/.ctrlproxy/log-custom/
If the [log-irssi] section is present, ControlProxy
will write irssi-style log files to ~/.ctrlproxy/log-irssi/NETWORK/CHANNEL.
Directory in which logs will be written (defaults
to ~/.ctrlproxy/log-irssi/.
Add this section to automatically change the state of the user to AWAY when the user is idle for a specific username.
Away message to set.
Integer variable. After idle for the specified time, the connection will only be changed to away if there are not more than client_limit connected. The default is -1 (always set idle no matter how many clients there are). To achive the behavior of the old variable <term>only_noclient</term>, set client_limit to 0.
Number of seconds of idleness after which the connection should be set to away. Default is 10 minutes.
When a client connects, ctrlproxy will send information about the channels the user is on. Optionally, it can also send some of the messages that were received before the client connected (replication).
The replication variable determines what
kind of replication is used. At the moment, the following
values are supported:
No replication.
Send messages that one of a set of regular expressions. The regular expressions should be specified in variable.
Send all messages since the last client disconnected.
Send all messages since the last message said by the user.
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 3 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