]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/Irc/README
Localisation updates from http://translatewiki.net.
[quix0rs-gnu-social.git] / plugins / Irc / README
index f3d18977794268b10f8a7f31286c1055f686cc39..0a5d9ea83f784953ff1265e43459c9ca0cf1514f 100644 (file)
@@ -12,14 +12,24 @@ See the StatusNet README for more about queuing and daemons.
 
 Settings
 ========
-host*: => Hostname of IRC server
-port*: => Port of IRC server
-username*: => Username of bot
-realname*: => Real name of bot
-nick*: => Nickname of bot
+host*: Hostname 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
-transport: Set to 'ssl' to enable SSL
-encoding: Set to UTF8 to enable UTF8 encoding
+nickservpassword: NickServ password for identification
+nickservidentifyregexp: Override existing regexp matching request for identification from NickServ
+channels: Channels for bot to idle in
+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
 
@@ -27,9 +37,9 @@ Example
 =======
 addPlugin('irc', array(
     'host' => '...',
-    'port' => '...',
     'username' => '...',
     'realname' => '...',
-    'nick' => '...'
+    'nick' => '...',
+    'channels' => array('#channel1', '#channel2')
 ));