diff plugins/perl/common/Gaim.pm @ 6598:2f6850c7d980

[gaim-migrate @ 7122] Added the new Perl Scripting HOWTO. committer: Tailor Script <[e-mail]>

--- a/plugins/perl/common/Gaim.pm	Sun Aug 24 04:08:35 2003 +0000
+++ b/plugins/perl/common/Gaim.pm	Sun Aug 24 04:22:06 2003 +0000
@@ -65,8 +65,8 @@
 
 =head1 ABSTRACT
 
-This module provides the interface for using perl scripts as plugins
-in Gaim.
+  This module provides the interface for using perl scripts as plugins
+  in Gaim.
 
 =head1 DESCRIPTION
 
@@ -79,6 +79,36 @@
 API, which can be viewed at http://gaim.sourceforge.net/api/ or in
 the header files in the Gaim source tree.
 
+=head1 FUNCTIONS
+
+=over
+
+=item @accounts = Gaim::accounts
+
+Returns a list of all accounts, online or offline.
+
+=item @chats = Gaim::chats
+
+Returns a list of all chats currently open.
+
+=item @connections = Gaim:connections
+
+Returns a list of all active connections.
+
+=item @conversations = Gaim::conversations
+
+Returns a list of all conversations, both IM and chat, currently open.
+
+=item @conv_windows = Gaim::conv_windows
+
+Returns a list of all conversation windows currently open.
+
+=item @ims = Gaim::ims
+
+Returns a list of all instant messages currently open.
+
+=back
+
 =head1 SEE ALSO
 
 Gaim C API documentation - http//gaim.sourceforge.net/api/