.\" Title: ctrlproxy_config .\" Author: .\" Generator: DocBook XSL Stylesheets v1.72.0 .\" Date: 07/22/2007 .\" Manual: .\" Source: .\" .TH "CTRLPROXY_CONFIG" "5" "07/22/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .SH "NAME" ctrlproxy_config \- Configuration file for ctrlproxy .SH "DESCRIPTION" .PP Ctrlproxy uses a configuration directory called \fI.ctrlproxy\fR that lives inside the users' home directory. The main configuration file lives in this directory and is called \fIconfig\fR. It is an ini\-style configuration file with sections and key\-value pairs. .PP This manpage discusses the variables that can be set in this file in a standard ControlProxy installation. .SH "SETTINGS" .SS "[global]" .PP The [global] section contains some of the most important settings. .PP replication .RS 4 Replication backend to use. See the section about replication below for details. .RE .PP report\-time .RS 4 Set to \fItrue\fR to prefix replicated lines with the time the line was sent. .RE .PP autosave .RS 4 Automatically save configuration on exit .RE .PP autoconnect .RS 4 Semi\-colon separated list of networks or servers to connect to on startup. .RE .PP motd\-file .RS 4 Path to the message of the day file that is sent to clients upon connect. .RE .PP match .RS 4 If the replication backend is set to \fIhighlight\fR, this variable should contain a semicolon\-separated list of words to search for. .RE .SS "[admin]" .PP If the [admin] section is present, ControlProxy will create a fake network with a control channel that can be used for administration. .PP no_privmsg .RS 4 Don't interpret messages to the user \fIctrlproxy\fR as administration commands. .sp This option would be needed if you want to be able to send messages to an actual user with the nickname \fIctrlproxy\fR. .RE .SS "[log\-custom]" .PP If the [log\-custom] section is present, ControlProxy will write a log to \fI~/.ctrlproxy/log\-custom/\fR .SS "[log\-irssi]" .PP If the [log\-irssi] section is present, ControlProxy will write irssi\-style log files to \fI~/.ctrlproxy/log\-irssi/NETWORK/CHANNEL\fR. .PP logfile .RS 4 Directory in which logs will be written (defaults to \fI~/.ctrlproxy/log\-irssi/\fR. .RE .SS "[auto\-away]" .PP Add this section to automatically change the state of the user to AWAY when the user is idle for a specific username. .PP message .RS 4 Away message to set. .RE .PP only_noclient .RS 4 Boolean variable. If set to true, then the connection will only be changed to away if there are no clients connected. .RE .PP time .RS 4 Number of seconds of idleness after which the connection should be set to away. Default is 10 minutes. .RE .SS "[socks]" .PP If the [socks] section is present, ControlProxy will listen for SOCKS connections. .PP port .RS 4 TCP/IP port to listen on for new connections. .RE .PP allow .RS 4 Semicolon\-separeted list of usernames and passwords allowed to connect. Separate user name and password by a colon. .RE .SS "[nickserv]" .PP learn .RS 4 .RE .SS "[listener]" .PP auto .RS 4 Automatically start a listener on a new port for each network that ctrlproxy connects to. .RE .PP autoport .RS 4 First port of port range used when adding new listeners. .RE .PP password .RS 4 Password that the user should specify to log in. .RE .SH "REPLICATION" .PP 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). .PP The \fIreplication\fR variable determines what kind of replication is used. At the moment, the following values are supported: .PP none .RS 4 No replication. .RE .PP highlight .RS 4 Send messages that one of a set of regular expressions. The regular expressions should be specified in variable. .RE .PP lastdisconnect .RS 4 Send all messages since the last client disconnected. .RE .PP simple .RS 4 Send all messages since the last message said by the user. .RE .SH "SEE ALSO" .PP ctrlproxy (1), config.example, http://ctrlproxy.vernstok.nl/ .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 \fIWITHOUT ANY WARRANTY\fR 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 "BUGS" .PP CtrlProxy currently does not warn about unknown configuration parameters. .SH "AUTHOR" .PP \fIJelmer Vernooij\fR\&[1] .SH "REFERENCES" .IP " 1." 4 Jelmer Vernooij .RS 4 \%mailto:jelmer@nl.linux.org .RE