Merge fix for logging of mode changes by charly.
[jelmer/ctrlproxy.git] / config.example
index ef9d50a..98273a3 100644 (file)
@@ -1,57 +1,87 @@
-# Example RC file for ctrlproxy
-# Read the documentation for more information about specifics
-# Please adapt to your needs!
+## Example RC file for ctrlproxy.
+## Read the documentation for more information.
 
 [global]
-
-# Replication mechanism to use
-# Possible values: none, simple, highlight, disconnect
+## 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
 
-# Override motd-file location
-#motd-file = /tmp/my-motd
+## Prepend all lines in replication with the time a line was received when replicating
+## possible settings: never|always|replication
+report-time = never
 
-#Disable autosave on exit
-#autosave = False
+## What words to look for when remembering lines 
+## (in case "replication = highlight")
+## Seperate using semicolons
+# matches=ctrlproxy;foobar
 
-# Support for interfacing to ctrlproxy 
-# using /MSG ctrlproxy or /CTRLPROXY -->
-[admin]
+## 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=secret
 
-# What words to look for when remembering lines 
-# (in case "replication = highlight")
-# Seperate using comma's 
-matches=ctrlproxy, foobar
+## Set "bind" to make ctrlproxy only listen on a specific IP address:
+## Example: bind=192.168.4.3
 
-# Prepend all lines with the time a line was received when replicating
-report-time=False
+## 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
 
-autoconnect=irc.oftc.net;irc.freenode.net;
+## Save state to configuration file on exit
+autosave = true
 
-# Irssi-style logging
-[log-irssi]
-logfile = /home/jelmer/tmp/ctrlproxy
+## 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
+#auto-away-enable = true
+#auto-away-message = I'm currently away, sorry!
+#auto-away-time = 300 # in seconds
 
-# Work as a socks proxy
-#[socks]
-#port = 8800
-#allow = jelmer:secret, foo:bar
+## Irssi-style logging
+logging = irssi
 
-# Make sure messages are not sent too fast after each other 
-# (prevents being kicked by the server for 'Excess flooding'
-#[antiflood]
+## -------------- Networks -------------------
+
+## The Administration network 
+## This is a virtual network that provides a administration 
+## interface to ctrlproxy.
+[admin]
+virtual = admin
 
-# Automatically set AWAY after a certain period of time
-#[auto-away]
-#message = I'm currently away, sorry!
-#time = 300 # in seconds
+## Example configuration for Freenode
+[Freenode]
+servers = irc://irc.freenode.net/
+autojoin = #ctrlproxy
 
-#[nickserv]
-# Learn new nickserv user/password combinations by interpreting traffic to server
-#learn = true
+## 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
 
-[listener]
-# Listen for network connections start port 6667
-# auto = true
-# autoport = 6667
-password = secret
+## Interfacing with a local inetd-style program
+[BitlBee]
+program = /usr/sbin/bitlbee