From b047244ab77bce56d84d988e977c2d8a0540adeb Mon Sep 17 00:00:00 2001
From: Georg Richter <georg@php.net>
Date: Mon, 31 Dec 2001 14:51:54 +0000
Subject: [PATCH] documentation for function ircg_set_on_die
 /en/functions/ircg.xml is complete now (until sascha has new ideas :-)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@66583 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/ircg.xml | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/functions/ircg.xml b/functions/ircg.xml
index e9a270d165..446b9a8753 100644
--- a/functions/ircg.xml
+++ b/functions/ircg.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.19 $ -->
+<!-- $Revision: 1.20 $ -->
  <reference id="ref.ircg">
   <title>IRC Gateway Functions</title>
   <titleabbrev>IRC Gateway</titleabbrev>
@@ -639,7 +639,7 @@ if (!ircg_join ($id, "#php")) {
    <refnamediv>
     <refname>ircg_set_on_die</refname>
     <refpurpose>
-     Set hostaction to be execute when connection dies */
+     Set hostaction to be execute when connection dies 
     </refpurpose>
    </refnamediv>
    <refsect1>
@@ -654,7 +654,13 @@ if (!ircg_join ($id, "#php")) {
      </funcprototype>
     </funcsynopsis>
     <para>
-     &warn.undocumented.func;
+     In case of the termination of connection <parameter>connection</parameter>
+     IRCG will connect to <parameter>host</parameter> at
+     <parameter>port</parameter> (Note: host must be an IPv4 address,
+     IRCG does not resolve host-names due to blocking issues), send
+     <parameter>data</parameter> to the new host connection and will
+     wait until the remote part closes connection. This can be used to
+     trigger a php script for example.
     </para>
    </refsect1>
   </refentry>