11 files changed, 382 insertions, 0 deletions
diff --git a/docs/Irssi/Channel.pm b/docs/Irssi/Channel.pm
new file mode 100644
index 0000000..10e82f1
--- /dev/null
+++ b/docs/Irssi/Channel.pm
@@ -0,0 +1,55 @@
+__END__
+
+=head1 NAME
+
+Irssi::Channel
+
+=head1 FIELDS
+
+Channel->{}
+  type - "CHANNEL" text
+  chat_type - String ID of chat protocol, for example "IRC"
+
+  (..contains all the same data as Windowitem above..)
+
+  topic - Channel topic
+  topic_by - Nick who set the topic
+  topic_time - Timestamp when the topic was set
+
+  no_modes - Channel is modeless
+  mode - Channel mode
+  limit - Max. users in channel (+l mode)
+  key - Channel key (password)
+
+  chanop - You are channel operator
+  names_got - /NAMES list has been received
+  wholist - /WHO list has been received
+  synced - Channel is fully synchronized
+
+  joined - JOIN event for this channel has been received
+  left - You just left the channel (for "channel destroyed" event)
+  kicked - You was just kicked out of the channel (for
+           "channel destroyed" event)
+
+=head1 METHODS
+
+
+
+Server::channels_join(channels, automatic)
+  Join to channels in server. `channels' may also contain keys for
+  channels just like with /JOIN command. `automatic' specifies if this
+  channel was joined "automatically" or if it was joined because join
+  was requested by user. If channel join is "automatic", irssi doesn't
+  jump to the window where the channel was joined.
+
+
+Channel::destroy()
+  Destroy channel.
+
+Channel
+channel_find(channel)
+  Find channel from any server.
+
+Channel
+Server::channel_find(channel)
+  Find channel from specified server.
diff --git a/docs/Irssi/Command.pm b/docs/Irssi/Command.pm
new file mode 100644
index 0000000..d777794
--- /dev/null
+++ b/docs/Irssi/Command.pm
@@ -0,0 +1,12 @@
+__END__
+
+=head1 NAME
+
+=head1 FIELDS
+
+  Command->{}
+     cmd - Command name
+     category - Category
+
+=head1 METHODS
+
diff --git a/docs/Irssi/Log.pm b/docs/Irssi/Log.pm
new file mode 100644
index 0000000..6787f85
--- /dev/null
+++ b/docs/Irssi/Log.pm
@@ -0,0 +1,10 @@
+__END__
+
+=head1 NAME
+
+Irssi::Log
+
+=head1 FIELDS
+
+=head1 METHODS
+
diff --git a/docs/Irssi/Logitem.pm b/docs/Irssi/Logitem.pm
new file mode 100644
index 0000000..21ec401
--- /dev/null
+++ b/docs/Irssi/Logitem.pm
@@ -0,0 +1,10 @@
+__END__
+
+=head1 NAME
+
+Irssi::Logitem
+
+=head1 FIELDS
+
+=head1 METHODS
+
diff --git a/docs/Irssi/Nick.pm b/docs/Irssi/Nick.pm
new file mode 100644
index 0000000..b20d43a
--- /dev/null
+++ b/docs/Irssi/Nick.pm
@@ -0,0 +1,24 @@
+__END__
+
+=head1 NAME
+
+Irssi::Nick
+
+=head1 FIELDS
+
+Nick->{}
+  type - "NICK" text
+  chat_type - String ID of chat protocol, for example "IRC"
+
+  nick - Plain nick
+  host - Host address
+  realname - Real name
+  hops - Hop count to the server the nick is using
+
+  gone, serverop - User status, 1 or 0
+  op, voice, halfop - Channel status, 1 or 0
+
+  last_check - timestamp when last checked gone/ircop status.
+  send_massjoin - Waiting to be sent in a "massjoin" signal, 1 or 0
+
+=head1 METHODS
diff --git a/docs/Irssi/Query.pm b/docs/Irssi/Query.pm
new file mode 100644
index 0000000..953c179
--- /dev/null
+++ b/docs/Irssi/Query.pm
@@ -0,0 +1,21 @@
+__END__
+
+=head1 NAME
+
+Irssi::Query
+
+=head1 FIELDS
+
+Query->{}
+  type - "QUERY" text
+  chat_type - String ID of chat protocol, for example "IRC"
+
+  (..contains all the same data as Windowitem above..)
+
+  address - Host address of the queries nick
+  server_tag - Server tag used for this nick (doesn't get erased if
+               server gets disconnected)
+  unwanted - 1 if the other side closed or some error occured (DCC chats)
+
+
+=head1 METHODS
diff --git a/docs/Irssi/Reconnect.pm b/docs/Irssi/Reconnect.pm
new file mode 100644
index 0000000..4085eec
--- /dev/null
+++ b/docs/Irssi/Reconnect.pm
@@ -0,0 +1,20 @@
+__END__
+
+=head1 NAME
+
+Irssi::Reconnect
+
+=head1 FIELDS
+
+Reconnect->{}
+  type - "RECONNECT" text
+  chat_type - String ID of chat protocol, for example "IRC"
+
+  (..contains all the same data as Connect above..)
+
+  tag - Unique numeric tag
+  next_connect - Unix time stamp when the next connection occurs
+
+
+=head1 METHODS
+
diff --git a/docs/Irssi/Script.pm b/docs/Irssi/Script.pm
new file mode 100644
index 0000000..9f8b07b
--- /dev/null
+++ b/docs/Irssi/Script.pm
@@ -0,0 +1,10 @@
+__END__
+
+=head1 NAME
+
+Irssi::Script
+
+=head1 FIELDS
+
+=head1 METHODS
+
diff --git a/docs/Irssi/Server.pm b/docs/Irssi/Server.pm
new file mode 100644
index 0000000..bb93d20
--- /dev/null
+++ b/docs/Irssi/Server.pm
@@ -0,0 +1,69 @@
+__END__
+
+=head1 NAME
+
+Irssi::Server
+
+=head1 FIELDS
+
+Server->{}
+  type - "SERVER" text
+  chat_type - String ID of chat protocol, for example "IRC"
+
+  (..contains all the same data as Connect above..)
+
+  connect_time - Time when connect() to server finished
+  real_connect_time - Time when server sent "connected" message
+
+  tag - Unique server tag
+  nick - Current nick
+
+  connected - Is connection finished? 1|0
+  connection_lost - Did we lose the connection (1) or was
+                    the connection just /DISCONNECTed (0)
+
+  rawlog - Rawlog object for the server
+
+  version - Server version
+  last_invite - Last channel we were invited to
+  server_operator - Are we server operator (IRC op) 1|0
+  usermode_away - Are we marked as away? 1|0
+  away_reason - Away reason message
+  banned - Were we banned from this server? 1|0
+  lag - Current lag to server in milliseconds
+
+=head1 METHODS
+
+Server::channels() - return list of channels in server
+Server::queries() - return list of queries in server
+Server::print(channel, str[, level])
+Server::command(cmd)
+
+
+Server
+Connect::connect()
+  Connect to server.
+
+Server::disconnect()
+  Disconnect from server.
+
+Server
+server_find_tag(tag)
+  Find server with tag
+
+Server
+server_find_chatnet(chatnet)
+  Find first server that is in `chatnet'
+
+Server::isnickflag(flag)
+  Returns 1 if flag is a nick mode flag (@, + or % in IRC)
+
+Server::ischannel(data)
+  Returns 1 if start of `data' seems to mean channel.
+
+Server::get_nick_flags()
+  Returns nick flag characters in order: op, voice, halfop ("@+%" in IRC).
+
+Server::send_message(target, msg, target_type)
+  Sends a message to nick/channel. target_type 0 = channel, 1 = nick
+
diff --git a/docs/Irssi/Window.pm b/docs/Irssi/Window.pm
new file mode 100644
index 0000000..77b880c
--- /dev/null
+++ b/docs/Irssi/Window.pm
@@ -0,0 +1,110 @@
+__END__
+
+=head1 NAME
+
+Irssi::Window
+
+=head1 FIELDS
+
+UI::Window->{}
+  refnum - Reference number
+  name - Name
+
+  width - Width
+  height - Height
+
+  history_name - Name of named historylist for this window
+
+  active - Active window item
+  active_server - Active server
+
+  servertag - active_server must be either undef or have this same tag
+              (unless there's items in this window). This is used by
+	      /WINDOW SERVER -sticky
+  level - Current window level
+
+  sticky_refnum - 1 if reference number is sticky
+
+  data_level - Current data level
+  hilight_color - Current activity hilight color
+
+  last_timestamp - Last time timestamp was written in window
+  last_line - Last time text was written in window
+
+  theme_name - Active theme in window, undef = default
+
+UI::TextDest->{}
+  window - Window where the text will be written
+  server - Target server
+  target - Target channel/query/etc name
+  level - Text level
+
+  hilight_priority - Priority for the hilighted text
+  hilight_color - Color for the hilighted text
+
+
+=head1 METHODS
+
+Window::command(cmd)
+Window::print(str[, level])
+
+
+Window::items()
+  Return a list of items in window.
+
+Window
+window_create(automatic)
+Windowitem::window_create(automatic)
+  Create a new window.
+
+Window::destroy()
+  Destroy the window.
+
+Irssi::Window
+Windowitem::window()
+  Returns parent window for window item.
+
+Window
+window_find_name(name)
+  Find window with name.
+
+Window
+window_find_refnum(refnum)
+  Find window with reference number.
+
+Window
+window_find_level(level)
+Server::window_find_level(level)
+  Find window with level.
+
+Window
+window_find_closest(name, level)
+Server::window_find_closest(name, level)
+  Find window that matches best to given arguments. `name' can be either
+  window name or name of one of the window items.
+
+Window
+window_find_item(name)
+Server::window_find_item(name)
+  Find window which contains window item with specified name/server.
+
+
+Window::item_add(item, automatic)
+Window::item_remove(item)
+Window::item_destroy(item)
+  Add/remove/destroy window item
+
+
+Window::set_active()
+  Set window active.
+
+Window::change_server(server)
+Window::set_refnum(refnum)
+Window::set_name(name)
+Window::set_history(name)
+Window::set_level(level)
+  Change server/refnum/name/history/level in window.
+
+Window::item_prev()
+Window::item_next()
+  Change to previous/next window item.
diff --git a/docs/Irssi/Windowitem.pm b/docs/Irssi/Windowitem.pm
new file mode 100644
index 0000000..78919cc
--- /dev/null
+++ b/docs/Irssi/Windowitem.pm
@@ -0,0 +1,41 @@
+__END__
+
+=head1 NAME
+
+Irssi::Windowitem
+
+=head1 DESCRIPTION
+
+
+The meaning of "window" should be pretty clear, but "window item" is something I
+couldn't really figure out a better name for :) They're simply something that's
+inside a window, a channel or a query usually.  Windows can have multiple items
+inside them. It's possible to create non-channel/query window items too,
+currently the third possible window item is created by /EXEC -interactive.
+
+In scripts, I think you can quite safely assume that the window item is
+query or channel if the script is intended to be run in one of them.
+Stupid users won't probably have other window items, and smart users
+know where to run the script, or at least later figure out why it
+didn't work :)
+
+=head1 FIELDS
+
+Windowitem->{}
+  type - Type of the window item, for example "CHANNEL" or "QUERY"
+  chat_type - String ID of chat protocol, for example "IRC"
+
+  server - Active server for item
+  name - Name of the item
+
+  createtime - Time the window item was created
+  data_level - 0=no new data, 1=text, 2=msg, 3=highlighted text
+  hilight_color - Color of the last highlighted text
+
+=head1 METHODS
+
+Windowitem::print(str[, level])
+
+Windowitem::command(cmd)
+
+