Merge fix for logging of mode changes by charly.
[jelmer/ctrlproxy.git] / config.example
index 1feb916..98273a3 100644 (file)
@@ -1,66 +1,87 @@
-# Example RC file for ctrlproxy.
-# Read the documentation for more information.
+## Example RC file for ctrlproxy.
+## Read the documentation for more information.
 
 [global]
-# Replication mechanism to use (some other IRC proxies call this backlog)
-# Possible values: none, simple, highlight, lastdisconnect
-# Meanings:
-#      none: No backlog
-#      simple: Send backlog since the user last said something
-#      lastdisconnect: Send backlog since the users' last disconnect
-#      highlight: Send backlog since last connect, but only lines 
-#                         containing 'matches' (see below)
+## Replication mechanism to use (some other IRC proxies call this backlog)
+## Possible values: 
+##     none: No backlog
+##     simple: Send backlog since the user last said something
+##     lastdisconnect: Send backlog since the users' last disconnect
+##     highlight: Send backlog since last connect, but only lines 
+##                        containing 'matches' (see below)
 replication = none
 
-# Prepend all lines in replication with the time a line was received when replicating
-# possible settings: never|always|replication
+## Prepend all lines in replication with the time a line was received when replicating
+## possible settings: never|always|replication
 report-time = never
 
-# What words to look for when remembering lines 
-# (in case "replication = highlight")
-# Seperate using semicolons
+## What words to look for when remembering lines 
+## (in case "replication = highlight")
+## Seperate using semicolons
 # matches=ctrlproxy;foobar
 
-# Port at which CtrlProxy should listen for new connections
-# Connections can be plain IRC connections or using the SOCKS protocol.
-port=6680
+## Port at which CtrlProxy should listen for new connections
+## Connections can be plain IRC connections or using the SOCKS protocol.
+port=57000
 
-# Password for logging in to ctrlproxy
+## Password for logging in to ctrlproxy
 password=secret
 
-# Set "bind" to make ctrlproxy only listen on a specific IP address:
-# Example: bind=192.168.4.3
+## Set "bind" to make ctrlproxy only listen on a specific IP address:
+## Example: bind=192.168.4.3
 
-# Override motd-file location
+## Override motd-file location
 #motd-file = /tmp/my-motd
 
-# Whether or not to automatically connect to a network if a client requests
-# a connection. If disabled, it is only possible to connect to networks 
-# listed in the configuration
-# create-implicit = true
+## Whether or not to automatically connect to a network if a client requests
+## a connection. If disabled, it is only possible to connect to networks 
+## listed in the configuration
+## create-implicit = true
 
-# Save state to configuration file on exit
+## Save state to configuration file on exit
 autosave = true
 
-# Networks to connect to on startup. Seperate by semicolons
+## Networks to connect to on startup. Seperate by semicolons
 autoconnect = admin
 # autoconnect = admin;irc.oftc.net;irc.freenode.net;
 #
-# Automatically set AWAY after a certain period of time
+## Automatically set AWAY after a certain period of time
 #auto-away-enable = true
 #auto-away-message = I'm currently away, sorry!
 #auto-away-time = 300 # in seconds
 
-# Irssi-style logging
-#logging = irssi
-#logfile = /home/jelmer/tmp/ctrlproxy
-#
-#[OFTC]
-#nick = jelmer
-#autojoin = #bitlbee
-#servers = irc.oftc.net
-#
-#[Freenode]
-#nick = jelmer
-#autojoin = #ctrlproxy;#bla
-#servers = irc.freenode.net
+## Irssi-style logging
+logging = irssi
+
+## -------------- Networks -------------------
+
+## The Administration network 
+## This is a virtual network that provides a administration 
+## interface to ctrlproxy.
+[admin]
+virtual = admin
+
+## Example configuration for Freenode
+[Freenode]
+servers = irc://irc.freenode.net/
+autojoin = #ctrlproxy
+
+## Somewhat more complex configuration for OFTC
+[OFTC]
+servers = irc://irc.ipv6.oftc.net/;ircs://irc.freenode.net/
+autojoin = #bitlbee
+## Bind to a specific address locally:
+# bind = 2001::dead:beef:cafe
+## Custom nick, different from default configuration
+# nick = somenick
+## Fullname sent to server
+# fullname=Somebody
+## Username sent to server (used in hostmask)
+# username=myuser
+## How many seconds to wait between tries to reconnect
+## to the server.
+# reconnect-interval=60
+
+## Interfacing with a local inetd-style program
+[BitlBee]
+program = /usr/sbin/bitlbee