diff --git a/doc/modules/irc.html b/doc/modules/irc.html
index 3c066ac..4d416cb 100644
--- a/doc/modules/irc.html
+++ b/doc/modules/irc.html
@@ -63,7 +63,7 @@
- irc:connect (server, port, timeout) |
+ irc:connect (server, port, host) |
Connect irc to an IRC server. |
@@ -145,6 +145,11 @@
Tables
+
+ Connection |
+ Table with connection information. |
+
+
Hooks |
List of hooks you can use with irc:hook. |
@@ -169,7 +174,7 @@
-irc:connect (server, port, timeout)
+irc:connect (server, port, host)
Connect irc
to an IRC server.
@@ -178,7 +183,7 @@ Connect irc
to an IRC server.
-
- server: Server address.
+ server:
-
@@ -186,7 +191,7 @@ Connect
irc
to an IRC server.
-
- timeout: Connection timeout value in seconds. [default 30]
+ host: Host address.
@@ -610,8 +615,16 @@ Returns a new irc
object.
Tables
+- Connection
+- Table with connection information.
host
- Server host name. port
- Server port. [defaults to 6667
] timeout
- Connect timeout. [defaults to 30
] password
- Server password. secure
- Boolean to enable TLS connection, pass a params table (described, [luasec]) to control
[luasec]: http://www.inf.puc-rio.br/~brunoos/luasec/reference.html
+
+
+
+
+
+
- Hooks
-- List of hooks you can use with irc:hook. The parameter list describes the parameters passed to the callback function.
OnDisconnect(message, errorOccurred)
OnChat(user, channel, message)
OnNotice(user, channel, message)
OnJoin(user, channel)
* OnPart(user, channel)
* OnQuit(user, message)
NickChange(user, newnick, channel)
*† NameList(channel, names)
OnTopic(channel, topic)
OnTopicInfo(channel, creator, timeCreated)
OnKick(channel, nick, kicker, reason)
* (kicker is a user
table)
* Event also invoked for yourself. † Channel passed only when user tracking is enabled
+- List of hooks you can use with irc:hook. The parameter list describes the parameters passed to the callback function.
OnRaw(line) - (any non false/nil return value assumes line handled and will not be further processed)
OnDisconnect(message, errorOccurred)
OnChat(user, channel, message)
OnNotice(user, channel, message)
OnJoin(user, channel)
* OnPart(user, channel)
* OnQuit(user, message)
NickChange(user, newnick, channel)
*† NameList(channel, names)
OnTopic(channel, topic)
OnTopicInfo(channel, creator, timeCreated)
OnKick(channel, nick, kicker, reason)
* (kicker is a user
table) OnUserModeIs(modes)
OnChannelModeIs(user, channel, modes)
OnModeChange(user, target, modes)
*
* Event also invoked for yourself. † Channel passed only when user tracking is enabled