Provided by: ctrlproxy_3.0.5-1_i386 bug

NAME

       ctrlproxy_config - Configuration file for ctrlproxy

DESCRIPTION

       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.

SETTINGS

   [global]
       The [global] section contains some of the most important settings.
       <xi:include></xi:include>.SS "[admin]"

       If the [admin] section is present, ControlProxy will create a fake
       network with a control channel that can be used for administration.

       no_privmsg
           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.

   [log-custom]
       If the [log-custom] section is present, ControlProxy will write a log
       to ~/.ctrlproxy/log-custom/

   [log-irssi]
       If the [log-irssi] section is present, ControlProxy will write
       irssi-style log files to ~/.ctrlproxy/log-irssi/NETWORK/CHANNEL.

       logfile
           Directory in which logs will be written (defaults to
           ~/.ctrlproxy/log-irssi/.

   [auto-away]
       Add this section to automatically change the state of the user to AWAY
       when the user is idle for a specific username.

       message
           Away message to set.

       client_limit
           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.

       time
           Number of seconds of idleness after which the connection should be
           set to away. Default is 10 minutes.

   [socks]
       If the [socks] section is present, ControlProxy will listen for SOCKS
       connections.

       port
           TCP/IP port to listen on for new connections.

       allow
           Semicolon-separeted list of usernames and passwords allowed to
           connect. Separate user name and password by a colon.

   [nickserv]
       learn

   [listener]
       auto
           Automatically start a listener on a new port for each network that
           ctrlproxy connects to.

       autoport
           First port of port range used when adding new listeners.

       password
           Password that the user should specify to log in.

REPLICATION

       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:

       none
           No replication.

       highlight
           Send messages that one of a set of regular expressions. The regular
           expressions should be specified in variable.

       lastdisconnect
           Send all messages since the last client disconnected.

       simple
           Send all messages since the last message said by the user.

SEE ALSO

       ctrlproxy (1), config.example, http://ctrlproxy.vernstok.nl/

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 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

BUGS

       CtrlProxy currently does not warn about unknown configuration
       parameters.

AUTHOR

       Jelmer Vernooij[1]

NOTES

        1. Jelmer Vernooij
           mailto:jelmer@nl.linux.org

                                  12/07/2007               CTRLPROXY_CONFIG(5)