signals maybe finished!

7 files changed, 1719 insertions, 279 deletions

diff --git a/docs/Guide.pm b/docs/Guide.pm
index 2f71e1c..4f78fc0 100644
--- a/docs/Guide.pm
+++ b/docs/Guide.pm
@@ -42,6 +42,14 @@ necessary code.
 
 =head2 Preamble
 
+=head1 COMMONLY SCRIPTED TASKS
+
+=head2 Modifying an input line before sending
+
+=head2 Responding to a public message
+
+=head2 Responding to a private message
+
 =head1 USEFUL THINGS
 
 =head2 Sharing Code Between Scripts
@@ -66,16 +74,69 @@ Dump perl object (e.g. C</dump Irssi::active_win>):
 
     /alias DUMP script exec use Data::Dumper\; print Data::Dumper->new([\\$0-])->Dump
 
-=head2 Making Script Look Native
+=head2 Making Scripts Act Native
+
+An important part of creating a good script is to make it behave as though it
+were a part of Irssi. Adhering to some of the standard conventions can make this
+easier.
 
 =head3 Provide Help
 
+Scripts commonly store information about how to use them in comments at the top
+of their file.  Whilst better than no documentation at all, a preferable approach
+is to allow that help to be accessed from within Irssi itself, using the C</HELP>
+command.
+
+B<TODO: how>
+
+
 =head3 Use Tab Completion
 
+One of the great features of Irssi is the ability to complete commands,
+subcommands and even certain arguments.
+
 =head3 Use Settings for Customisation
 
+B<TODO: why?>
+
+B<TODO: different types of settings>
+
+B<TODO: register/set/get>
+
+=head3 Use Subcommands to Group Script Functionality
+
+A common theme in Irssi scripts is to define commands with a prefix, such as
+C</myscript_foo>, C<myscript_bar>, etc.  This helps to avoid accidentally clobbering
+native commands and those defined by other scripts, but is a problem better solved
+with I<subcommands>.
+
+Subcommands allow you to bind commands such as C</myscript foo> and C</myscript bar>.
+Completions are automatically handled for both the primary command, and any
+subcommands contained within it.
+
+The following example demonstrates how to use subcommands from within a script:
+
+    Irssi::command_bind("foo bar", \&subcmd_bar);
+    Irssi::command_bind("foo", \&subcmd_handler);
+
+    sub subcmd_handler {
+        my ($data, $server, $item) = @_;
+        $data =~ s/\s+$//g;
+        Irssi::command_runsub('foo', $data, $server, $item);
+    }
+
+    sub subcmd_bar {
+        my ($args) = @_;
+        print "subcommand called with: $args";
+    }
+
 =head1 OTHER RESOURCES
 
+The documentation assembled here and elsewhere on this site has been drawn from
+many different places, and a lot of valuable information is available from the
+following sites.
+
+
 =over
 
 =item L<http://irssi.org/documentation/perl>
diff --git a/docs/Irssi.pm b/docs/Irssi.pm
index 2c93256..11837d4 100644
--- a/docs/Irssi.pm
+++ b/docs/Irssi.pm
@@ -71,6 +71,16 @@ additional pages.
 
 =back
 
+
+=head1 EXPORTS
+
+Nothing by default, but passing a list of function names when C<use>ing the module
+will import them into the current namespace.
+
+For example:
+
+    use Irssi qw/signal_emit signal_add .../;
+
 =head1 METHODS
 
 =head2 Accessors
diff --git a/docs/Irssi/Theme.pm b/docs/Irssi/Theme.pm
index f9efc85..72ab9e1 100644
--- a/docs/Irssi/Theme.pm
+++ b/docs/Irssi/Theme.pm
@@ -1,11 +1,4 @@
 __END__
 
-=head1 NAME
-
-Irssi::Theme
-
-=head1 FIELDS
-
-
-=head1 METHODS
+=head1 Deprecated
 
diff --git a/docs/Irssi/UI/Theme.pm b/docs/Irssi/UI/Theme.pm
new file mode 100644
index 0000000..56e3a3f
--- /dev/null
+++ b/docs/Irssi/UI/Theme.pm
@@ -0,0 +1,8 @@
+=head1 NAME
+
+Irssi::UI::Theme
+
+=head1 FIELDS
+
+=head1 METHODS
+
diff --git a/docs/Irssi/UI/Window.pm b/docs/Irssi/UI/Window.pm
index e69de29..a00827e 100644
--- a/docs/Irssi/UI/Window.pm
+++ b/docs/Irssi/UI/Window.pm
@@ -0,0 +1,116 @@
+__END__
+
+=head1 NAME
+
+Irssi::UI::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.
+
+
+Window::get_active_name()
+  Return active item's name, or if none is active, window's name
+
+Window::item_find(server, name)
+  Find window item that matches best to given arguments.
diff --git a/docs/Irssi/Window.pm b/docs/Irssi/Window.pm
index 540fae2..981a524 100644
--- a/docs/Irssi/Window.pm
+++ b/docs/Irssi/Window.pm
@@ -1,116 +1,3 @@
 __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.
-
-
-Window::get_active_name()
-  Return active item's name, or if none is active, window's name
-
-Window::item_find(server, name)
-  Find window item that matches best to given arguments.
+=head1 DEPRECATED.
diff --git a/docs/Signals.pm b/docs/Signals.pm
index c8f74de..570214c 100644
--- a/docs/Signals.pm
+++ b/docs/Signals.pm
@@ -769,238 +769,1583 @@ B<TODO: are these actual files? .c?>
 
 =back
 
-=head3 ctcp.c:
+=head3 F<ctcp.c>:
 
- "ctcp msg", SERVER_REC, char *args, char *nick, char *addr, char *target
- "ctcp msg "<cmd>, SERVER_REC, char *args, char *nick, char *addr, char *target
- "default ctcp msg", SERVER_REC, char *args, char *nick, char *addr, char *target
- "ctcp reply", SERVER_REC, char *args, char *nick, char *addr, char *target
- "ctcp reply "<cmd>, SERVER_REC, char *args, char *nick, char *addr, char *target
- "default ctcp reply", SERVER_REC, char *args, char *nick, char *addr, char *target
- "ctcp action", SERVER_REC, char *args, char *nick, char *addr, char *target
+=over
+
+=item C<"ctcp msg">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$args>
+
+=item string C<$nick>
+
+=item string C<$addr>
+
+=item string C<$target>
+
+=back
+
+=item C<"ctcp msg "<cmd>>
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$args>
+
+=item string C<$nick>
+
+=item string C<$addr>
+
+=item string C<$target>
+
+=back
+
+=item C<"default ctcp msg">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$args>
+
+=item string C<$nick>
+
+=item string C<$addr>
+
+=item string C<$target>
+
+=back
+
+=item C<"ctcp reply">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$args>
+
+=item string C<$nick>
+
+=item string C<$addr>
+
+=item string C<$target>
+
+=back
+
+=item C<"ctcp reply "<cmd>>
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$args>
+
+=item string C<$nick>
+
+=item string C<$addr>
+
+=item string C<$target>
+
+=back
+
+=item C<"default ctcp reply">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$args>
+
+=item string C<$nick>
+
+=item string C<$addr>
+
+=item string C<$target>
+
+=back
+
+=item C<"ctcp action">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$args>
+
+=item string C<$nick>
+
+=item string C<$addr>
+
+=item string C<$target>
+
+=back
+
+=back
+
+=head3 F<irc-log.c>:
+
+=over
+
+=item C<"awaylog show">
+
+=over
+
+=item L<Irssi::Log> C<$log>
+
+=item int C<$away_msgs>
+
+=item int C<$filepos>
+
+=back
+
+=back
+
+=head3 F<irc-nicklist.c>:
+
+=over
+
+=item C<"server nick changed">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=back
+
+=back
+
+=head3 F<irc-servers.c>:
+
+=over
+
+=item C<"event connected">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=back
+
+=back
+
+=head3 F<irc.c>:
+
+=over
+
+=item C<"server event">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$data>
+
+=item string C<$sender_nick>
+
+=item string C<$sender_addr>
+
+=back
+
+=item C<"event "<cmd>>
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$args>
+
+=item string C<$sender_nick>
+
+=item string C<$sender_addr>
+
+=back
+
+=item C<"default event">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$data>
+
+=item string C<$sender_nick>
+
+=item string C<$sender_addr>
+
+=back
+
+=item C<"whois default event">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$data>
+
+=item string C<$sender_nick>
+
+=item string C<$sender_addr>
+
+=back
+
+=item C<"server incoming">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$data>
+
+=back
+
+=item C<"redir "<cmd>>
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$args>
+
+=item string C<$sender_nick>
+
+=item string C<$sender_addr>
+
+=back
+
+=back
+
+=head3 F<lag.c>:
+
+=over
+
+=item C<"server lag">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=back
+
+=item C<"server lag disconnect">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=back
+
+=back
+
+=head3 F<massjoin.c>:
+
+=over
+
+=item C<"massjoin">
+
+=over
+
+=item L<Irssi::Channel> C<$channel>
+
+=item List of L<Irssi::Nick> C<@nicks>
+
+B<TODO: Check this is actually a perl list (array)>
+
+=back
+
+=back
+
+=head3 F<mode-lists.c>:
+
+=over
+
+=item C<"ban new">
+
+=over
+
+=item L<Irssi::Channel> C<$channel>
+
+=item L<Irssi::Irc::Ban> C<$ban>
+
+=back
+
+=item C<"ban remove">
+
+=over
+
+=item L<Irssi::Channel> C<$channel>
+
+=item L<Irssi::Irc::Ban> C<$ban>
+
+=item string C<$set_by>
+
+=back
+
+=back
+
+=head3 F<modes.c>:
+
+=over
+
+=item C<"channel mode changed">
+
+=over
+
+=item L<Irssi::Channel> C<$channel>
+
+=item string C<$set_by>
+
+=back
+
+=item C<"nick mode changed">
+
+=over
+
+=item L<Irssi::Channel> C<$channel>
+
+=item L<Irssi::Nick> C<$nick>
+
+=item string C<$set_by>
+
+=item string C<$mode>
+
+=item string C<$type>
+
+=back
+
+=item C<"user mode changed">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$old_mode>
+
+=back
+
+=item C<"away mode changed">
+
+=over
 
-=head3 irc-log.c:
+=item L<Irssi::Server> C<$server>
 
- "awaylog show", LOG_REC, int away_msgs, int filepos
+=back
 
-=head3 irc-nicklist.c:
+=back
 
- "server nick changed", SERVER_REC
+=head3 F<netsplit.c>:
 
-=head3 irc-servers.c:
+=over
 
- "event connected", SERVER_REC
+=item C<"netsplit server new">
 
-=head3 irc.c:
+=over
 
- "server event", SERVER_REC, char *data, char *sender_nick, char *sender_address
- "event "<cmd>, SERVER_REC, char *args, char *sender_nick, char *sender_address
- "default event", SERVER_REC, char *data, char *sender_nick, char *sender_address
- "whois default event", SERVER_REC, char *args, char *sender_nick, char *sender_address
+=item L<Irssi::Server> C<$server>
 
- "server incoming", SERVER_REC, char *data
+=item L<Irssi::Irc::Netsplitserver> C<$netsplit_server>
 
-(for perl parser..)
- "redir "<cmd>, SERVER_REC, char *args, char *sender_nick, char *sender_address
+=back
 
-=head3 lag.c:
+=item C<"netsplit server remove">
 
- "server lag", SERVER_REC
- "server lag disconnect", SERVER_REC
+=over
 
-=head3 massjoin.c:
+=item L<Irssi::Server> C<$server>
 
- "massjoin", CHANNEL_REC, GSList of NICK_RECs
+=item L<Irssi::Irc::Netsplitserver> C<$netsplit_server>
 
-=head3 mode-lists.c:
+=back
 
- "ban new", CHANNEL_REC, BAN_REC
- "ban remove", CHANNEL_REC, BAN_REC, char *setby
+=item C<"netsplit new">
 
-=head3 modes.c:
+=over
 
- "channel mode changed", CHANNEL_REC, char *setby
- "nick mode changed", CHANNEL_REC, NICK_REC, char *setby, char *mode, char *type
- "user mode changed", SERVER_REC, char *old
- "away mode changed", SERVER_REC
+=item L<Irssi::Irc::Netsplit> C<$netsplit>
 
-=head3 netsplit.c:
+=back
 
- "netsplit server new", SERVER_REC, NETSPLIT_SERVER_REC
- "netsplit server remove", SERVER_REC, NETSPLIT_SERVER_REC
- "netsplit new", NETSPLIT_REC
- "netsplit remove", NETSPLIT_REC
+=item C<"netsplit remove">
+
+=over
 
+=item L<Irssi::Irc::Netsplit> C<$netsplit>
+
+=back
+
+=back
 
 =head2 IRC Modules
 
 
-=head3 dcc*.c:
+=head3 F<dcc*.c>:
+
+=over
+
+=item C<"dcc ctcp "<cmd>>
+
+=over
+
+=item string C<$args>
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=back
+
+=item C<"default dcc ctcp">
+
+=over
+
+=item string C<$args>
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=back
+
+=item C<"dcc unknown ctcp">
+
+=over
+
+=item string C<$args>
+
+=item string C<$sender>
+
+=item string C<$send_addr>
+
+=back
+
+=item C<"dcc reply "<cmd>>
+
+=over
+
+=item string C<$args>
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=back
+
+=item C<"default dcc reply">
+
+=over
+
+=item string C<$args>
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=back
+
+=item C<"dcc unknown reply">
+
+=over
+
+=item string C<$args>
+
+=item string C<$sender>
+
+=item string C<$send_addr>
+
+=back
+
+=item C<"dcc chat message">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=item string C<$msg>
+
+=back
+
+=item C<"dcc created">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=back
+
+=item C<"dcc destroyed">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=back
+
+=item C<"dcc connected">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=back
+
+=item C<"dcc rejecting">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=back
+
+=item C<"dcc closed">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=back
+
+=item C<"dcc request">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=item string C<$send_addr>
+
+=back
+
+=item C<"dcc request send">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=back
+
+=item C<"dcc chat message">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=item string C<$msg>
+
+=back
+
+=item C<"dcc transfer update">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=back
+
+=item C<"dcc get receive">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=back
+
+=item C<"dcc error connect">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=back
+
+=item C<"dcc error file create">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=item string C<$filename>
+
+=back
+
+=item C<"dcc error file open">
+
+=over
+
+=item string C<$nick>
+
+=item string C<$filename>
+
+=item int C<$errno>
+
+=back
+
+=item C<"dcc error get not found">
+
+=over
+
+=item string C<$nick>
+
+=back
+
+=item C<"dcc error send exists">
+
+=over
+
+=item string C<$nick>
+
+=item string C<$filename>
+
+=back
+
+=item C<"dcc error unknown type">
+
+=over
+
+=item string C<$type>
+
+=back
+
+=item C<"dcc error close not found">
+
+=over
+
+=item string C<$type>
+
+=item string C<$nick>
+
+=item string C<$filename>
+
+=back
+
+=back
+
+=head3 F<autoignore.c>:
+
+=over
+
+=item C<"autoignore new">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item L<Irssi::Irc::Autoignore> C<$autoignore>
+
+=back
+
+=item C<"autoignore remove">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item L<Irssi::Irc::Autoignore> C<$autoignore>
+
+=back
+
+=back
+
+=head3 F<flood.c>:
+
+=over
+
+=item C<"flood">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$nick>
+
+=item string C<$host>
+
+=item int C<$level>
+
+=item string C<$target>
+
+=back
+
+=back
+
+=head3 F<notifylist.c>:
+
+=over
+
+=item C<"notifylist new">
+
+=over
+
+=item L<Irssi::Irc::Notifylist> C<$notify_list>
+
+=back
+
+=item C<"notifylist remove">
+
+=over
+
+=item L<Irssi::Irc::Notifylist> C<$notify_list>
+
+=back
+
+=item C<"notifylist joined">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$nick>
+
+=item string C<$user>
+
+=item string C<$host>
+
+=item string C<$real_name>
+
+=item string C<$away_message>
+
+=back
+
+=item C<"notifylist away changed">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$nick>
+
+=item string C<$user>
+
+=item string C<$host>
+
+=item string C<$real_name>
+
+=item string C<$away_message>
+
+=back
+
+=item C<"notifylist left">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$nick>
+
+=item string C<$user>
+
+=item string C<$host>
+
+=item string C<$real_name>
+
+=item string C<$away_message>
+
+=back
+
+=back
+
+=head3 F<proxy/listen.c>:
+
+=over
+
+=item C<"proxy client connected">
+
+=over
+
+=item L<Irssi::Irc::Client> C<$client>
+
+=back
 
- "dcc ctcp "<cmd>, char *args, DCC_REC
- "default dcc ctcp", char *args, DCC_REC
- "dcc unknown ctcp", char *args, char *sender, char *sendaddr
+=item C<"proxy client disconnected">
 
- "dcc reply "<cmd>, char *args, DCC_REC
- "default dcc reply", char *args, DCC_REC
- "dcc unknown reply", char *args, char *sender, char *sendaddr
+=over
 
- "dcc chat message", DCC_REC, char *msg
+=item L<Irssi::Irc::Client> C<$client>
 
- "dcc created", DCC_REC
- "dcc destroyed", DCC_REC
- "dcc connected", DCC_REC
- "dcc rejecting", DCC_REC
- "dcc closed", DCC_REC
- "dcc request", DCC_REC, char *sendaddr
- "dcc request send", DCC_REC
- "dcc chat message", DCC_REC, char *msg
- "dcc transfer update", DCC_REC
- "dcc get receive", DCC_REC
- "dcc error connect", DCC_REC
- "dcc error file create", DCC_REC, char *filename
- "dcc error file open", char *nick, char *filename, int errno
- "dcc error get not found", char *nick
- "dcc error send exists", char *nick, char *filename
- "dcc error unknown type", char *type
- "dcc error close not found", char *type, char *nick, char *filename
+=back
 
-=head3 autoignore.c:
+=item C<"proxy client command">
 
- "autoignore new", SERVER_REC, AUTOIGNORE_REC
- "autoignore remove", SERVER_REC, AUTOIGNORE_REC
+=over
 
-=head3 flood.c:
+=item L<Irssi::Irc::Client> C<$client>
 
- "flood", SERVER_REC, char *nick, char *host, int level, char *target
+=item string C<$args>
 
-=head3 notifylist.c:
+=item string C<$data>
 
- "notifylist new", NOTIFYLIST_REC
- "notifylist remove", NOTIFYLIST_REC
- "notifylist joined", SERVER_REC, char *nick, char *user, char *host, char *realname, char *awaymsg
- "notifylist away changed", SERVER_REC, char *nick, char *user, char *host, char *realname, char *awaymsg
- "notifylist left", SERVER_REC, char *nick, char *user, char *host, char *realname, char *awaymsg
+=back
 
-=head3 proxy/listen.c:
+=item C<"proxy client dump">
 
- "proxy client connected", CLIENT_REC
- "proxy client disconnected", CLIENT_REC
- "proxy client command", CLIENT_REC, char *args, char *data
- "proxy client dump", CLIENT_REC, char *data
+=over
 
+=item L<Irssi::Irc::Client> C<$client>
+
+=item string C<$data>
+
+=back
+
+=back
 
 =head2 Display (FE) Common
 
 B<Requires to work properly:>
 
- "gui print text", WINDOW_REC, int fg, int bg, int flags, char *text, TEXT_DEST_REC
+=over
+
+=item C<"gui print text">
+
+=over
+
+=item L<Irssi::Window> C<$window>
+
+=item int C<$fg>
+
+=item int C<$bg>
+
+=item int C<$flags>
+
+=item string C<$text>
+
+=item L<Irssi::UI::TextDest> C<$text_dest>
+
+=back
+
+=back
 
 (Can be used to determine when all "gui print text"s are sent (not required))
  "gui print text finished", WINDOW_REC
 
 B<Provides signals:>
 
-=head3 completion.c:
+=head3 F<completion.c>:
+
+=over
+
+=item C<"complete word">
+
+, GList * of char*, WINDOW_REC, char *word, char *linestart, int *want_space
+
+=back
+
+=head3 F<fe-common-core.c>:
+
+=over
+
+=item C<"irssi init read settings">
+
+=over
+
+=item I<None>
+
+=back
+
+=back
+
+=head3 F<fe-exec.c>:
+
+=over
+
+=item C<"exec new">
+
+=over
+
+=item L<Irssi::UI::Process> C<$process>
+
+=back
+
+=item C<"exec remove">
+
+=over
+
+=item L<Irssi::UI::Process> C<$process>
+
+=item int C<$status>
+
+=back
+
+=item C<"exec input">
+
+=over
+
+=item L<Irssi::UI::Process> C<$process>
+
+=item string C<$text>
+
+=back
+
+=back
+
+=head3 F<fe-messages.c>:
+
+=over
+
+=item C<"message public">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$msg>
+
+=item string C<$nick>
+
+=item string C<$address>
+
+=item string C<$target>
+
+=back
+
+=item C<"message private">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$msg>
+
+=item string C<$nick>
+
+=item string C<$address>
+
+=back
+
+=item C<"message own_public">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$msg>
+
+=item string C<$target>
+
+=back
+
+=item C<"message own_private">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$msg>
+
+=item string C<$target>
+
+=item string C<$original_target>
+
+=back
+
+=item C<"message join">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$channel>
+
+=item string C<$nick>
+
+=item string C<$address>
+
+=back
+
+=item C<"message part">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$channel>
+
+=item string C<$nick>
+
+=item string C<$address>
+
+=item string C<$reason>
+
+=back
+
+=item C<"message quit">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$nick>
+
+=item string C<$address>
+
+=item string C<$reason>
+
+=back
+
+=item C<"message kick">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$channel>
+
+=item string C<$nick>
+
+=item string C<$kicker>
+
+=item string C<$address>
+
+=item string C<$reason>
+
+=back
+
+=item C<"message nick">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$new_nick>
+
+=item string C<$old_nick>
+
+=item string C<$address>
+
+=back
+
+=item C<"message own_nick">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$new_nick>
+
+=item string C<$old_nick>
+
+=item string C<$address>
+
+=back
+
+=item C<"message invite">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$channel>
+
+=item string C<$nick>
+
+=item string C<$address>
+
+=back
+
+=item C<"message topic">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$channel>
+
+=item string C<$topic>
+
+=item string C<$nick>
+
+=item string C<$address>
+
+=back
+
+=back
+
+=head3 F<keyboard.c>:
+
+=over
+
+=item C<"keyinfo created">
+
+=over
+
+=item L<Irssi::UI::Keyinfo> C<$key_info>
+
+=back
+
+=item C<"keyinfo destroyed">
+
+=over
+
+=item L<Irssi::UI::Keyinfo> C<$key_info>
+
+=back
+
+=back
+
+=head3 F<printtext.c>:
+
+=over
+
+=item C<"print text">
+
+=over
+
+=item L<Irssi::UI::TextDest> C<$text_dest>
+
+=item string C<$text>
+
+=item string C<$stripped_text>
+
+=back
+
+=back
+
+=head3 F<themes.c>:
+
+=over
+
+=item C<"theme created">
+
+=over
+
+=item L<Irssi::UI::Theme> C<$theme>
+
+=back
+
+=item C<"theme destroyed">
+
+=over
+
+=item L<Irssi::UI::Theme> C<$theme>
+
+=back
+
+=back
+
+=head3 F<window-activity.c>:
+
+=over
+
+=item C<"window hilight">
+
+=over
+
+=item L<Irssi::UI::Window> C<$window>
+
+=back
+
+=item C<"window dehilight">
+
+=over
+
+=item L<Irssi::UI::Window> C<$window>
+
+=back
+
+=item C<"window activity">
+
+=over
+
+=item L<Irssi::UI::Window> C<$window>
+
+=item int C<$old_level>
+
+=back
+
+=item C<"window item hilight">
+
+=over
+
+=item L<Irssi::Windowitem> C<$window_item>
+
+=back
+
+=item C<"window item activity">
+
+=over
+
+=item L<Irssi::Windowitem> C<$window_item>
 
- "complete word", GList * of char*, WINDOW_REC, char *word, char *linestart, int *want_space
+=item int C<$old_level>
 
-=head3 fe-common-core.c:
+=back
 
- "irssi init read settings"
+=back
 
-=head3 fe-exec.c:
+=head3 F<window-items.c>:
 
- "exec new", PROCESS_REC
- "exec remove", PROCESS_REC, int status
- "exec input", PROCESS_REC, char *text
+=over
 
-=head3 fe-messages.c:
+=item C<"window item new">
 
- "message public", SERVER_REC, char *msg, char *nick, char *address, char *target
- "message private", SERVER_REC, char *msg, char *nick, char *address
- "message own_public", SERVER_REC, char *msg, char *target
- "message own_private", SERVER_REC, char *msg, char *target, char *orig_target
- "message join", SERVER_REC, char *channel, char *nick, char *address
- "message part", SERVER_REC, char *channel, char *nick, char *address, char *reason
- "message quit", SERVER_REC, char *nick, char *address, char *reason
- "message kick", SERVER_REC, char *channel, char *nick, char *kicker, char *address, char *reason
- "message nick", SERVER_REC, char *newnick, char *oldnick, char *address
- "message own_nick", SERVER_REC, char *newnick, char *oldnick, char *address
- "message invite", SERVER_REC, char *channel, char *nick, char *address
- "message topic", SERVER_REC, char *channel, char *topic, char *nick, char *address
+=over
 
-=head3 keyboard.c:
+=item L<Irssi::UI::Window> C<$window>
 
- "keyinfo created", KEYINFO_REC
- "keyinfo destroyed", KEYINFO_REC
+=item L<Irssi::Windowitem> C<$window_item>
 
-=head3 printtext.c:
+=back
 
- "print text", TEXT_DEST_REC *dest, char *text, char *stripped
+=item C<"window item remove">
 
-=head3 themes.c:
+=over
 
- "theme created", THEME_REC
- "theme destroyed", THEME_REC
+=item L<Irssi::UI::Window> C<$window>
 
-=head3 window-activity.c:
+=item L<Irssi::Windowitem> C<$window_item>
 
- "window hilight", WINDOW_REC
- "window dehilight", WINDOW_REC
- "window activity", WINDOW_REC, int old_level
- "window item hilight", WI_ITEM_REC
- "window item activity", WI_ITEM_REC, int old_level
+=back
 
-=head3 window-items.c:
+=item C<"window item moved">
 
- "window item new", WINDOW_REC, WI_ITEM_REC
- "window item remove", WINDOW_REC, WI_ITEM_REC
- "window item moved", WINDOW_REC, WI_ITEM_REC, WINDOW_REC
- "window item changed", WINDOW_REC, WI_ITEM_REC
- "window item server changed", WINDOW_REC, WI_ITEM_REC
+B<TODO: Check ordering of arguments from/to here>
 
-=head3 windows.c:
+=over
+
+=item L<Irssi::UI::Window> C<$window_from>
+
+=item L<Irssi::Windowitem> C<$window_item>
+
+=item L<Irssi::UI::Window> C<$window_to>
 
- "window created", WINDOW_REC
- "window destroyed", WINDOW_REC
- "window changed", WINDOW_REC, WINDOW_REC old
- "window changed automatic", WINDOW_REC
- "window server changed", WINDOW_REC, SERVER_REC
- "window refnum changed", WINDOW_REC, int old
- "window name changed", WINDOW_REC
- "window history changed", WINDOW_REC, char *oldname
- "window level changed", WINDOW_REC
+=back
+
+=item C<"window item changed">
+
+=over
+
+=item L<Irssi::UI::Window> C<$window>
+
+=item L<Irssi::Windowitem> C<$window_item>
+
+=back
+
+=item C<"window item server changed">
+
+=over
+
+=item L<Irssi::UI::Window> C<$window>
+
+=item L<Irssi::Windowitem> C<$window_item>
+
+=back
+
+=back
+
+=head3 F<windows.c>:
+
+=over
+
+=item C<"window created">
+
+=over
+
+=item L<Irssi::UI::Window> C<$window>
+
+=back
+
+=item C<"window destroyed">
+
+=over
+
+=item L<Irssi::UI::Window> C<$window>
+
+=back
+
+=item C<"window changed">
+
+=over
+
+=item L<Irssi::UI::Window> C<$window>
+
+=item L<Irssi::UI::Window> C<$old_window>
+
+=back
+
+=item C<"window changed automatic">
+
+=over
+
+=item L<Irssi::UI::Window> C<$window>
+
+=back
+
+=item C<"window server changed">
+
+=over
+
+=item L<Irssi::UI::Window> C<$window>
+
+=item L<Irssi::Server> C<$server>
+
+=back
+
+=item C<"window refnum changed">
+
+=over
+
+=item L<Irssi::UI::Window> C<$window>
+
+=item int C<$old_refnum>
+
+=back
+
+=item C<"window name changed">
+
+=over
+
+=item L<Irssi::UI::Window> C<$window>
+
+=back
+
+=item C<"window history changed">
+
+=over
+
+=item L<Irssi::UI::Window> C<$window>
+
+=item string C<$old_name>
+
+=back
+
+=item C<"window level changed">
+
+=over
+
+=item L<Irssi::UI::Window> C<$window>
+
+=back
+
+=back
 
 =head2 Display (FE) IRC
 
-=head3 fe-events.c:
+=head3 F<fe-events.c>:
+
+=over
+
+=item C<"default event numeric">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$data>
+
+=item string C<$nick>
+
+=item string C<$address>
+
+=back
+
+=back
+
+=head3 F<fe-irc-messages.c>:
+
+=over
+
+=item C<"message irc op_public">
+
+=over
+
+=item L<Irssi::Server C<$server>
+
+=item string C<$msg>
+
+=item string C<$nick>
+
+=item string C<$address>
+
+=item string C<$target>
+
+=back
+
+=item C<"message irc own_wall">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$msg>
+
+=item string C<$target>
+
+=back
+
+=item C<"message irc own_action">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$msg>
+
+=item string C<$target>
+
+=back
+
+=item C<"message irc action">
+
+=over
+
+=item L<Irssi::Server> C<$server>
 
- "default event numeric", SERVER_REC, char *data, char *nick, char *address
+=item string C<$msg>
 
-=head3 fe-irc-messages.c:
+=item string C<$nick>
 
- "message irc op_public", SERVER_REC, char *msg, char *nick, char *address, char *target
- "message irc own_wall", SERVER_REC, char *msg, char *target
- "message irc own_action", SERVER_REC, char *msg, char *target
- "message irc action", SERVER_REC, char *msg, char *nick, char *address, char *target
- "message irc own_notice", SERVER_REC, char *msg, char *target
- "message irc notice", SERVER_REC, char *msg, char *nick, char *address, char *target
- "message irc own_ctcp", SERVER_REC, char *cmd, char *data, char *target
- "message irc ctcp", SERVER_REC, char *cmd, char *data, char *nick, char *address, char *target
+=item string C<$address>
 
-=head3 fe-modes.c:
+=item string C<$target>
+
+=back
 
- "message irc mode", SERVER_REC, char *channel, char *nick, char *addr, char *mode
+=item C<"message irc own_notice">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$msg>
+
+=item string C<$target>
+
+=back
 
-=head3 dcc/fe-dcc-chat-messages.c:
+=item C<"message irc notice">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$msg>
+
+=item string C<$nick>
+
+=item string C<$address>
+
+=item string C<$target>
+
+=back
+
+=item C<"message irc own_ctcp">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$cmd>
 
- "message dcc own", DCC_REC *dcc, char *msg
- "message dcc own_action", DCC_REC *dcc, char *msg
- "message dcc own_ctcp", DCC_REC *dcc, char *cmd, char *data
- "message dcc", DCC_REC *dcc, char *msg
- "message dcc action", DCC_REC *dcc, char *msg
- "message dcc ctcp", DCC_REC *dcc, char *cmd, char *data
+=item string C<$data>
+
+=item string C<$target>
+
+=back
+
+=item C<"message irc ctcp">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$cmd>
+
+=item string C<$data>
+
+=item string C<$nick>
+
+=item string C<$address>
+
+=item string C<$target>
+
+=back
+
+=back
+
+=head3 F<fe-modes.c>:
+
+=over
+
+=item C<"message irc mode">
+
+=over
+
+=item L<Irssi::Server> C<$server>
+
+=item string C<$channel>
+
+=item string C<$nick>
+
+=item string C<$address>
+
+=item string C<$mode>
+
+=back
+
+=back
+
+=head3 F<dcc/fe-dcc-chat-messages.c>:
+
+=over
+
+=item C<"message dcc own">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=item string C<$msg>
+
+=back
+
+=item C<"message dcc own_action">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=item string C<$msg>
+
+=back
+
+=item C<"message dcc own_ctcp">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=item string C<$cmd>
+
+=item string C<$data>
+
+=back
+
+=item C<"message dcc">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=item string C<$msg>
+
+=back
+
+=item C<"message dcc action">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=item string C<$msg>
+
+=back
+
+=item C<"message dcc ctcp">
+
+=over
+
+=item L<Irssi::Dcc> C<$dcc>
+
+=item string C<$cmd>
+
+=item string C<$data>
+
+=back
+
+=back
 
 =head2 Display (FE) Text
 
@@ -1008,7 +2353,13 @@ B<Provides signals:>
 
 =over 4
 
-=item C<"gui key pressed"> int C<$key>
+=item C<"gui key pressed">
+
+=over
+
+=item int C<$key>
+
+=back
 
 =back
 
@@ -1016,7 +2367,13 @@ B<Provides signals:>
 
 =over 4
 
-=item C<"beep"> I<None>
+=item C<"beep">
+
+=over
+
+=item I<None>
+
+=back
 
 =back
 
@@ -1024,7 +2381,15 @@ B<Provides signals:>
 
 =over 4
 
-=item C<"script error"> PERL_SCRIPT_REC, string C<$errormsg>
+=item C<"script error">
+
+=over
+
+=item L<Irssi::Script> C<$script>
+
+=item string C<$error_msg>
+
+=back
 
 =back