Add brief documentation for Irssi::signal_register() perl function.

git-svn-id: file:///var/www/svn.irssi.org/SVN/irssi/trunk@4945 dbcabf3a-b0e7-0310-adc4-f8d773084564

1 files changed, 13 insertions, 0 deletions

diff --git a/docs/perl.txt b/docs/perl.txt
index 13ad28d9..1a45596e 100644
--- a/docs/perl.txt
+++ b/docs/perl.txt
@@ -283,6 +283,19 @@ signal_stop()
 signal_stop_by_name(signal)
   Stop the signal with name `signal' that's currently being emitted.
 
+signal_register(hash)
+  Register parameter types for one or more signals.
+  `hash' must map one or more signal names to references to arrays
+  containing 0 to 6 type names. Some recognized type names include
+  int for integers, intptr for references to integers and string for
+  strings. For all standard signals see src/perl/perl-signals-list.h
+  in the source code (this is generated by src/perl/get-signals.pl).
+
+  Any signals that were already registered are unaffected.
+
+  Registration is currently required to get any parameters to
+  signals written in Perl, and may be required in future to emit
+  signals from Perl.
 
   *** timeouts / IO listener / pidwait