Add header for IRC python module.

[jelmer/ctrlproxy.git] / config.example

diff --git a/config.example b/config.example
index eb6b8b5cf7edc00f341b7daad36bd6ca07132a33..9f86fc65060a65bdbab2153cc549ee5cad350235 100644 (file)
--- a/config.example
+++ b/config.example
@@ -1,58 +1,56 @@
-# Example RC file for ctrlproxy
-# (C) 2003-2006 Jelmer Vernooij <jelmer@vernstok.nl>
-# 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, 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 = none
 
-# Override motd-file location
-#motd-file = /tmp/my-motd
-
-#Disable autosave on exit
-#autosave = False
-
-# Support for interfacing to ctrlproxy 
-# using /MSG ctrlproxy or /CTRLPROXY -->
-[admin]
+## 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 comma's 
-matches=ctrlproxy, foobar
+## What words to look for when remembering lines 
+## (in case "replication = highlight")
+## Seperate using semicolons
+# matches=ctrlproxy;foobar
 
-# Prepend all lines with the time a line was received when replicating
-report-time=False
+## Port at which CtrlProxy should listen for new connections
+## Connections can be plain IRC connections or using the SOCKS protocol.
+port=57000
 
-autoconnect=irc.oftc.net;irc.freenode.net;
+## Password for logging in to ctrlproxy
+password=secret
 
-# Irssi-style logging
-[log-irssi]
-logfile = /home/jelmer/tmp/ctrlproxy
+## Set "bind" to make ctrlproxy only listen on a specific IP address:
+## Example: bind=192.168.4.3
 
-# Work as a socks proxy
-#[socks]
-#port = 8800
-#allow = jelmer:secret, foo:bar
-
-# Make sure messages are not sent too fast after each other 
-# (prevents being kicked by the server for 'Excess flooding'
-#[antiflood]
-
-# Automatically set AWAY after a certain period of time
-#[auto-away]
-#message = I'm currently away, sorry!
-#time = 300 # in seconds
-
-#[nickserv]
-# Learn new nickserv user/password combinations by interpreting traffic to server
-#learn = true
+## Override motd-file location
+#motd-file = /tmp/my-motd
 
-[listener]
-# Listen for network connections start port 6667
-# auto = true
-# autoport = 6667
-password = secret
+## 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
+autosave = true
+
+## 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
+
+## Irssi-style logging
+#logging = irssi
+#logfile = /home/jelmer/tmp/ctrlproxy