From 011c65a31356c33a8f3b406f6cf57da41e21756e Mon Sep 17 00:00:00 2001
From: Tom Feist <shabble@cowu.be>
Date: Wed, 4 Aug 2010 18:52:35 +0100
Subject: some stuff with colour popups

---
 docs/Irssi.pod   | 65 ++++++++++++++++++++++++++++++--------------------------
 docs/Signals.pod |  3 +++
 2 files changed, 38 insertions(+), 30 deletions(-)

(limited to 'docs')

diff --git a/docs/Irssi.pod b/docs/Irssi.pod
index 5fa8413..eba846e 100644
--- a/docs/Irssi.pod
+++ b/docs/Irssi.pod
@@ -2,7 +2,7 @@ __END__
 
 =head1 NAME
 
-Irssi.pm
+Irssi
 
 =head1 DESCRIPTION
 
@@ -83,7 +83,6 @@ For example:
 
 =head1 METHODS
 
-
 =head2 Accessors
 
 =head3 C<active_win>
@@ -100,8 +99,12 @@ returns the currently active L<Irssi::Server> in active window.
 
 =head3 C<windows>
 
+C<my @windows = Irssi::windows();>
 returns a list of all L<windows|Irssi::UI::Window>.
 
+When called in scalar context C<my $win = Irssi::windows();>, only the first
+window is returned.
+
 =head3 C<servers>
 
 returns a list of all L<servers|Irssi::Server>.
@@ -383,33 +386,6 @@ Settings are a way to permanently store values that your script may wish to use.
 They are also easily manipulable by the user through the C</SET> command, making
 them a good way to allow configuration of your script.
 
-=head3 Creating New Settings
-
-If a setting does not currently exist, it must first be registered with Irssi
-using one of the C<settings_add> functions.
-
-=head4 C<settings_add_str $section, $key, $def>
-
-=head4 C<settings_add_int $section, $key, $def>
-
-=head4 C<settings_add_bool $section, $key, $def>
-
-=head4 C<settings_add_time $section, $key, $def>
-
-=head4 C<settings_add_level $section, $key, $def>
-
-=head4 C<settings_add_size $section, $key, $def>
-
-Each of the above functions operates in the same way, but creates a different
-data type.  For each function, C<$section> is a string describing the
-group the entry falls into, C<$key> is the name of the setting.  The key must
-be a single string, and typically multiple words are separated by underscores.
-
-The final parameter, C<$def>, is the default value of this setting.  It should
-correspond to the type of the setting being created.
-
-B<TODO: move this list to another section?>
-
 The following list summarises the data types available:
 
 =over
@@ -444,9 +420,10 @@ B<TODO: can different specifiers be combined?>
 
 The value is stored internally as a number of milliseconds.  Since it is stored
 as an C<signed int>, it will overflow at 2^31 ms, or approximately 24 days.
-
 Times longer than this are considered invalid.
 
+The default specifier if none are specified is I<seconds>.
+
 =item C<level>
 
 An irssi Messagelevel. See C</HELP LEVELS> for a full list and description, or
@@ -461,6 +438,34 @@ scheme, rather than the decimal C<$x * 1000> system.
 
 =back
 
+=head3 Creating New Settings
+
+If a setting does not currently exist, it must first be registered with Irssi
+using one of the C<settings_add> functions.
+
+=head4 C<settings_add_str $section, $key, $def>
+
+=head4 C<settings_add_int $section, $key, $def>
+
+=head4 C<settings_add_bool $section, $key, $def>
+
+=head4 C<settings_add_time $section, $key, $def>
+
+=head4 C<settings_add_level $section, $key, $def>
+
+=head4 C<settings_add_size $section, $key, $def>
+
+Each of the above functions operates in the same way, but creates a different
+data type.  For each function, C<$section> is a string describing the
+group the entry falls into, C<$key> is the name of the setting.  The key must
+be a single string, and typically multiple words are separated by underscores.
+
+The final parameter, C<$def>, is the default value of this setting.  It should
+correspond to the type of the setting being created.
+
+B<TODO: move this list to another section?>
+
+
 =head3 Retrieving Settings
 
 =head4 C<settings_get_str $key>
diff --git a/docs/Signals.pod b/docs/Signals.pod
index f3d18b9..f12dd7f 100644
--- a/docs/Signals.pod
+++ b/docs/Signals.pod
@@ -2089,6 +2089,9 @@ B<TODO: Check ordering of arguments from/to here>
 
 =back
 
+B<TODO: does this fire if you dont' change windows? (eg: send a switch commandf
+for the window you're already on)
+
 =item C<"window changed automatic">
 
 =over
-- 
cgit v1.2.3