summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTimo Sirainen <cras@irssi.org>2000-03-20 00:45:09 +0000
committercras <cras@dbcabf3a-b0e7-0310-adc4-f8d773084564>2000-03-20 00:45:09 +0000
commit35c126ccb1dfd2c9fad2e4cd482a18ec43330b33 (patch)
treea3af5aeb71216775dc2896e75a3801d6d34b2f33 /docs
parent7f4eac0dd431c8b03fde53d3c8e3ccc9a6159a07 (diff)
downloadirssi-35c126ccb1dfd2c9fad2e4cd482a18ec43330b33.zip
Irssi::Connect = SERVER_CONNECT_REC
Several fixes to make it work git-svn-id: http://svn.irssi.org/repos/irssi/trunk@161 dbcabf3a-b0e7-0310-adc4-f8d773084564
Diffstat (limited to 'docs')
-rw-r--r--docs/PERL51
-rw-r--r--docs/SIGNALS2
2 files changed, 40 insertions, 13 deletions
diff --git a/docs/PERL b/docs/PERL
index a96f768a..37442426 100644
--- a/docs/PERL
+++ b/docs/PERL
@@ -182,22 +182,45 @@ Server::irc_send_cmd_split(cmd, arg, max_nicks)
"KICK #channel nick3 :byebye" to server.
+ *** Server Connects
+
+This is a record where we keep connection information. All Servers and
+Reconnects records have pointer to one of these.
+
+Connect::values()
+ Get some information about connect. This function returns a reference to
+ hash table. Hash table has keys:
+ "address" - Address where we connected (irc.blah.org)
+ "port" - Port where we connected
+ "password" - Password we used in connection.
+
+ "ircnet" - IRC network
+ "wanted_nick" - Nick which we would prefer to use
+ "alternate_nick" - Alternate nick which we would prefer to use
+ "username" - User name
+ "realname" - Real name
+
+Connect server_create_conn(address, [port=6667, [password='', [nick='', [channels='']]]])
+ Create new server connection.
+
*** Server functions
Server::values()
Get some information about server. This function returns a reference to
hash table. Hash table has keys:
"address" - Address where we connected (irc.blah.org)
- "real_address" - Who the server thinks it is (irc1.blah.org)
"port" - Port where we connected
- "tag" - Unique server tag.
- "ircnet" - IRC network
"password" - Password we used in connection.
- "nick" - Current nick
+ "ircnet" - IRC network
"wanted_nick" - Nick which we would prefer to use
+ "alternate_nick" - Alternate nick which we would prefer to use
"username" - User name
"realname" - Real name
+
+ "tag" - Unique server tag.
+ "real_address" - Who the server thinks it is (irc1.blah.org)
+ "nick" - Current nick
"usermode" - Current user mode
"usermode_away" - Are we marked as away? 1|0
"away_reason" - Away reason
@@ -208,8 +231,8 @@ Server::values()
%server_info = %{Irssi::cur_server->values()};
Irssi::print("Current server = ".$server_info{'address'});
-Server server_connect(address, [port=6667, [password='', [nick='', [channels='']]]])
- Create new server connection.
+Server Connect::connect()
+ Connect to server.
Server::disconnect()
Disconnect from server.
@@ -454,14 +477,18 @@ Reconnect::values()
Get some information about reconnect. This function returns a reference to
hash table. Hash table has keys:
"tag" - Unique numeric tag
- "address" - Address where we're going to connect
- "password" - Password we use in connection
- "port" - Port where we're going to connect
- "ircnet" - IRC network
- "nick" - Nick we want to use
- "channels" - Join to these channels once connected
"next_connect" - Unix time stamp when the next connection occurs
+ "address" - Address where we connected (irc.blah.org)
+ "port" - Port where we connected
+ "password" - Password we used in connection.
+
+ "ircnet" - IRC network
+ "wanted_nick" - Nick which we would prefer to use
+ "alternate_nick" - Alternate nick which we would prefer to use
+ "username" - User name
+ "realname" - Real name
+
*** Netsplits
diff --git a/docs/SIGNALS b/docs/SIGNALS
index 070f480a..6d92ddb8 100644
--- a/docs/SIGNALS
+++ b/docs/SIGNALS
@@ -83,7 +83,7 @@ nicklist.c:
"nick gone changed", CHANNEL_REC, NICK_REC
"nick ircop changed", CHANNEL_REC, NICK_REC
"server nick changed", SERVER_REC
- "massjoin", CHANNEL_REC, GList of NICK_RECs
+ "massjoin", CHANNEL_REC, GSList of NICK_RECs
rawlog.c: