Merge branch '1.0.x' of gitorious.org:statusnet/mainline into 1.0.x

[quix0rs-gnu-social.git] / plugins / Irc / README

diff --git a/plugins/Irc/README b/plugins/Irc/README
index bed57e1e4580a7b314545aee68197c4242e3ba80..0a5d9ea83f784953ff1265e43459c9ca0cf1514f 100644 (file)
--- a/plugins/Irc/README
+++ b/plugins/Irc/README
@@ -13,15 +13,23 @@ See the StatusNet README for more about queuing and daemons.
 Settings
 ========
 host*: Hostname of IRC server
-port*: Port of IRC server
+port: Port of IRC server (defaults to 6667)
 username*: Username of bot
 realname*: Real name of bot
 nick*: Nickname of bot
 password: Password
 nickservpassword: NickServ password for identification
+nickservidentifyregexp: Override existing regexp matching request for identification from NickServ
 channels: Channels for bot to idle in
-transport: Set to 'ssl' to enable SSL
-encoding: Set to UTF8 to enable UTF8 encoding
+transporttype: Set to 'ssl' to enable SSL
+encoding: Set to change encoding
+pinginterval: Set to change the number of seconds between pings (helps keep the connection open)
+              Defaults to 120 seconds
+regcheck: Check user's nicknames are registered, enabled by default, set to false to disable
+regregexp: Override existing regexp matching response from NickServ if nick checked is registered.
+           Must contain a capturing group catching the nick
+unregregexp: Override existing regexp matching response from NickServ if nick checked is unregistered
+             Must contain a capturing group catching the nick
 
 * required
 
@@ -29,7 +37,6 @@ Example
 =======
 addPlugin('irc', array(
     'host' => '...',
-    'port' => '...',
     'username' => '...',
     'realname' => '...',
     'nick' => '...',