sas Wed Nov 27 11:50:10 2002 EDT
Modified files:
/phpdoc/en/reference/ircg reference.xml
/phpdoc/en/reference/ircg/functions ircg-channel-mode.xml
ircg-disconnect.xml
ircg-fetch-error-msg.xml
ircg-get-username.xml
ircg-html-encode.xml
ircg-ignore-add.xml
ircg-ignore-del.xml
ircg-is-conn-alive.xml
ircg-join.xml
ircg-lookup-format-messages.xml
ircg-msg.xml ircg-nick.xml
ircg-nickname-escape.xml
ircg-notice.xml
ircg-pconnect.xml
ircg-register-format-messages.xml
ircg-set-current.xml
ircg-set-on-die.xml
ircg-whois.xml
Log:
some improvements here and there
Index: phpdoc/en/reference/ircg/reference.xml
diff -u phpdoc/en/reference/ircg/reference.xml:1.3
phpdoc/en/reference/ircg/reference.xml:1.4
--- phpdoc/en/reference/ircg/reference.xml:1.3 Sun Jul 21 12:17:16 2002
+++ phpdoc/en/reference/ircg/reference.xml Wed Nov 27 11:50:10 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<reference id="ref.ircg">
<title>IRC Gateway Functions</title>
<titleabbrev>IRC Gateway</titleabbrev>
@@ -8,11 +8,16 @@
<section id="ircg.intro">
&reftitle.intro;
<para>
- With ircg you can build powerful, fast and scalable webchat
- solutions in conjunction with dedicated or public IRC servers.
+ With IRCG you can rapidly stream XML data to thousands of concurrently
+ connected users. This can be used to build powerful, extensible
+ interactive platforms such as online games and webchats.
+ IRCG also features support for a non-streaming mode where a helper
+ application reformats incoming data and supplies static file snippets in
+ special formats such as cHTML (i-mode) or WML (WAP). These static files
+ are then delivered by the high-performance web server.
</para>
<para>
- IRCG runs under tis platforms:
+ Up to v3, IRCG runs under these platforms:
<itemizedlist>
<listitem><para>AIX</para></listitem>
<listitem><para>FreeBSD</para></listitem>
@@ -25,35 +30,12 @@
</para>
</section>
- <section id="ircg.requirements">
- &reftitle.required;
- <para>
- To install and use IRCG you need the following software:
- <orderedlist>
- <listitem>
- <para>
- <ulink url="&url.ircg;">IRCG-Library</ulink> from Sascha Schumann.
- </para>
- </listitem>
- <listitem>
- <para>
- <ulink url="&url.st-threads;">SGI Static Threads Library</ulink>
- </para>
- </listitem>
- <listitem>
- <para>
- <ulink url="&url.thttpd;">thttpd</ulink> webserver
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
<section id="ircg.install">
&reftitle.install;
<para>
- A detailed installation instruction can be found
- <ulink url="&url.ircg-install;">here</ulink>.
+ Detailed installation instructions can be found
+ <ulink url="&url.ircg-install;">here</ulink>. We urge you to use
+ the provided installation script.
</para>
</section>
Index: phpdoc/en/reference/ircg/functions/ircg-channel-mode.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-channel-mode.xml:1.2
phpdoc/en/reference/ircg/functions/ircg-channel-mode.xml:1.3
--- phpdoc/en/reference/ircg/functions/ircg-channel-mode.xml:1.2 Wed Apr 17
02:39:33 2002
+++ phpdoc/en/reference/ircg/functions/ircg-channel-mode.xml Wed Nov 27 11:50:10
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
<refentry id="function.ircg-channel-mode">
<refnamediv>
@@ -24,10 +24,10 @@
the user specified by <parameter>nick</parameter>.
</para>
<para>
- Mode flags are set or cleared by specifind a mode character and
- prepending it with a plus or minus character
+ Mode flags are set or cleared by specifying a mode character and
+ prepending it with a plus or minus character,
respectively. E.g. operator mode is granted by '+o' and revoked
- by '-o' passed as <parameter>mode_spec</parameter>.
+ by '-o', as passed as <parameter>mode_spec</parameter>.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/ircg/functions/ircg-disconnect.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-disconnect.xml:1.2
phpdoc/en/reference/ircg/functions/ircg-disconnect.xml:1.3
--- phpdoc/en/reference/ircg/functions/ircg-disconnect.xml:1.2 Wed Apr 17 02:39:34
2002
+++ phpdoc/en/reference/ircg/functions/ircg-disconnect.xml Wed Nov 27 11:50:10
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
<refentry id="function.ircg-disconnect">
<refnamediv>
@@ -18,7 +18,7 @@
<para>
<function>ircg_disconnect</function> will close a
<parameter>connection</parameter> to a server previously
- established with <function>ircg-pconnect</function>.
+ established with <function>ircg_pconnect</function>.
</para>
<para>
See also: <function>ircg_pconnect</function>.
Index: phpdoc/en/reference/ircg/functions/ircg-fetch-error-msg.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-fetch-error-msg.xml:1.2
phpdoc/en/reference/ircg/functions/ircg-fetch-error-msg.xml:1.3
--- phpdoc/en/reference/ircg/functions/ircg-fetch-error-msg.xml:1.2 Wed Apr 17
02:39:34 2002
+++ phpdoc/en/reference/ircg/functions/ircg-fetch-error-msg.xml Wed Nov 27 11:50:10
+2002
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.7 -->
<refentry id="function.ircg-fetch-error-msg">
<refnamediv>
<refname>ircg_fetch_error_msg</refname>
<refpurpose>
- Returns the error from previous ircg operation
+ Returns the error from previous IRCG operation
</refpurpose>
</refnamediv>
<refsect1>
@@ -16,11 +16,13 @@
</methodsynopsis>
<para>
<function>ircg_fetch_error_msg</function> returns the error from
- the last called ircg function.
+ a failed connection.
</para>
<note>
<para>
- Errorcode is stored in first array element, errortext in second.
+ Error code is stored in first array element, error text in second.
+ The error code is equivalent to IRC reply codes as defined by
+ RFC 2812.
</para>
</note>
<para>
@@ -30,7 +32,7 @@
<![CDATA[
if (!ircg_join ($id, "#php")) {
$error = ircg_fetch_error_msg($id);
- print ("Can't join channel #php. Errorcode:
+ print ("Can't join channel #php. Error code:
$error[0] Description: $error[1]");
}
]]>
Index: phpdoc/en/reference/ircg/functions/ircg-get-username.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-get-username.xml:1.3
phpdoc/en/reference/ircg/functions/ircg-get-username.xml:1.4
--- phpdoc/en/reference/ircg/functions/ircg-get-username.xml:1.3 Sun Jul 21
12:16:49 2002
+++ phpdoc/en/reference/ircg/functions/ircg-get-username.xml Wed Nov 27 11:50:10
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.17 -->
<refentry id='function.ircg-get-username'>
<refnamediv>
@@ -16,7 +16,7 @@
</methodsynopsis>
<para>
Function <function>ircg_get_username</function> returns the
- username for specified connection <parameter>connection</parameter>.
+ username for the specified connection <parameter>connection</parameter>.
Returns &false; if <parameter>connection</parameter> died or is
not valid.
</para>
Index: phpdoc/en/reference/ircg/functions/ircg-html-encode.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-html-encode.xml:1.2
phpdoc/en/reference/ircg/functions/ircg-html-encode.xml:1.3
--- phpdoc/en/reference/ircg/functions/ircg-html-encode.xml:1.2 Wed Apr 17 02:39:34
2002
+++ phpdoc/en/reference/ircg/functions/ircg-html-encode.xml Wed Nov 27 11:50:10
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
<refentry id="function.ircg-html-encode">
<refnamediv>
@@ -16,8 +16,10 @@
</methodsynopsis>
<para>
Encodes a HTML string <parameter>html_string</parameter> for
- output. This feature could be usable, e.g. if someone wants to
- discuss about an html problem.
+ output. This exposes the interface which the IRCG extension
+ uses internally to reformat data coming from an IRC link.
+ The function causes IRC color/font codes to be encoded in
+ HTML and escapes certain entities.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/ircg/functions/ircg-ignore-add.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-ignore-add.xml:1.2
phpdoc/en/reference/ircg/functions/ircg-ignore-add.xml:1.3
--- phpdoc/en/reference/ircg/functions/ircg-ignore-add.xml:1.2 Wed Apr 17 02:39:35
2002
+++ phpdoc/en/reference/ircg/functions/ircg-ignore-add.xml Wed Nov 27 11:50:10
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
<refentry id="function.ircg-ignore-add">
<refnamediv>
@@ -16,10 +16,10 @@
<methodparam><type>string</type><parameter>nick</parameter></methodparam>
</methodsynopsis>
<para>
- This function will add user <parameter>nick</parameter> to your
- ignore list on the server connected to by
- <parameter>connection</parameter>. By doing so you will suppress
- all messages from this user from being send to you.
+ This function adds user <parameter>nick</parameter> to the
+ ignore list of connection
+ <parameter>connection</parameter>. Afterwards, IRCG will suppress
+ all messages from this user through the associated connection.
</para>
<para>
See also: <function>ircg_ignore_del</function>.
Index: phpdoc/en/reference/ircg/functions/ircg-ignore-del.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-ignore-del.xml:1.2
phpdoc/en/reference/ircg/functions/ircg-ignore-del.xml:1.3
--- phpdoc/en/reference/ircg/functions/ircg-ignore-del.xml:1.2 Wed Apr 17 02:39:35
2002
+++ phpdoc/en/reference/ircg/functions/ircg-ignore-del.xml Wed Nov 27 11:50:10
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
<refentry id="function.ircg-ignore-del">
<refnamediv>
@@ -16,9 +16,8 @@
<methodparam><type>string</type><parameter>nick</parameter></methodparam>
</methodsynopsis>
<para>
- This function remove user <parameter>nick</parameter> from your
- ignore list on the server connected to by
- <parameter>connection</parameter>.
+ This function removes user <parameter>nick</parameter> from the IRCG
+ ignore list associated with <parameter>connection</parameter>.
</para>
<para>
See also: <function>ircg_ignore_add</function>.
Index: phpdoc/en/reference/ircg/functions/ircg-is-conn-alive.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-is-conn-alive.xml:1.2
phpdoc/en/reference/ircg/functions/ircg-is-conn-alive.xml:1.3
--- phpdoc/en/reference/ircg/functions/ircg-is-conn-alive.xml:1.2 Wed Apr 17
02:39:35 2002
+++ phpdoc/en/reference/ircg/functions/ircg-is-conn-alive.xml Wed Nov 27 11:50:10
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
<refentry id="function.ircg-is-conn-alive">
<refnamediv>
@@ -17,7 +17,7 @@
<para>
<function>ircg_is_conn_alive</function> returns &true; if
<parameter>connection</parameter> is still alive and working or
- &false; if the server no longer talks to us.
+ &false;, if the connection has died for some reason.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/ircg/functions/ircg-join.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-join.xml:1.2
phpdoc/en/reference/ircg/functions/ircg-join.xml:1.3
--- phpdoc/en/reference/ircg/functions/ircg-join.xml:1.2 Wed Apr 17 02:39:35
2002
+++ phpdoc/en/reference/ircg/functions/ircg-join.xml Wed Nov 27 11:50:10 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
<refentry id="function.ircg-join">
<refnamediv>
@@ -14,10 +14,12 @@
<type>boolean</type><methodname>ircg_join</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>channel</parameter></methodparam>
+ <methodparam
+type="opt"><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
Join the channel <parameter>channel</parameter> on the server
- connected to by <parameter>connection</parameter>.
+ connected to by <parameter>connection</parameter>. IRCG will
+ optionally pass the room key <parameter>key</parameter>.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/ircg/functions/ircg-lookup-format-messages.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-lookup-format-messages.xml:1.2
phpdoc/en/reference/ircg/functions/ircg-lookup-format-messages.xml:1.3
--- phpdoc/en/reference/ircg/functions/ircg-lookup-format-messages.xml:1.2 Wed
Apr 17 02:39:35 2002
+++ phpdoc/en/reference/ircg/functions/ircg-lookup-format-messages.xml Wed Nov 27
+11:50:10 2002
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
<refentry id="function.ircg-lookup-format-messages">
<refnamediv>
<refname>ircg_lookup_format_messages</refname>
<refpurpose>
- Select a set of format strings for display of IRC messages
+ Check for the existence of a format message set
</refpurpose>
</refnamediv>
<refsect1>
@@ -15,10 +15,11 @@
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
- Select the set of format strings to use for display of IRC
- messages and events. Sets may be registered with
+ Check for the existence of the format message set
+ <parameter>name</parameter>. Sets may be registered with
<function>ircg_register_format_messages</function>, a default set
- named <literal>ircg</literal> is always available.
+ named <literal>ircg</literal> is always available. Returns &true;,
+ if the set exists and &false; otherwise.
</para>
<para>
See also: <function>ircg_register_format_messages</function>
Index: phpdoc/en/reference/ircg/functions/ircg-msg.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-msg.xml:1.2
phpdoc/en/reference/ircg/functions/ircg-msg.xml:1.3
--- phpdoc/en/reference/ircg/functions/ircg-msg.xml:1.2 Wed Apr 17 02:39:35 2002
+++ phpdoc/en/reference/ircg/functions/ircg-msg.xml Wed Nov 27 11:50:10 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
<refentry id="function.ircg-msg">
<refnamediv>
@@ -29,7 +29,9 @@
<para>
Setting the optional parameter <parameter>suppress</parameter> to
a &true; value will suppress output of your message to your own
- <parameter>connection</parameter>.
+ <parameter>connection</parameter>. This so-called loopback is
+ necessary, because the IRC server does not echo PRIVMSG commands
+ back to us.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/ircg/functions/ircg-nick.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-nick.xml:1.2
phpdoc/en/reference/ircg/functions/ircg-nick.xml:1.3
--- phpdoc/en/reference/ircg/functions/ircg-nick.xml:1.2 Wed Apr 17 02:39:35
2002
+++ phpdoc/en/reference/ircg/functions/ircg-nick.xml Wed Nov 27 11:50:10 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
<refentry id="function.ircg-nick">
<refnamediv>
@@ -18,7 +18,7 @@
<para>
Change your nickname on the given
<parameter>connection</parameter> to the one given in
- <parameter>nick</parameter> if possible.
+ <parameter>nick</parameter>, if possible.
</para>
<para>
Will return &true; on success and &false; on failure.
Index: phpdoc/en/reference/ircg/functions/ircg-nickname-escape.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-nickname-escape.xml:1.2
phpdoc/en/reference/ircg/functions/ircg-nickname-escape.xml:1.3
--- phpdoc/en/reference/ircg/functions/ircg-nickname-escape.xml:1.2 Wed Apr 17
02:39:36 2002
+++ phpdoc/en/reference/ircg/functions/ircg-nickname-escape.xml Wed Nov 27 11:50:10
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.17 -->
<refentry id='function.ircg-nickname-escape'>
<refnamediv>
@@ -15,7 +15,7 @@
<methodparam><type>string</type><parameter>nick</parameter></methodparam>
</methodsynopsis>
<para>
- Function <function>ircg_nickname_escape</function> returns a decoded
+ Function <function>ircg_nickname_escape</function> returns an encoded
nickname specified by <parameter>nick</parameter> wich is IRC-compliant.
</para>
<para>
Index: phpdoc/en/reference/ircg/functions/ircg-notice.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-notice.xml:1.2
phpdoc/en/reference/ircg/functions/ircg-notice.xml:1.3
--- phpdoc/en/reference/ircg/functions/ircg-notice.xml:1.2 Wed Apr 17 02:39:36
2002
+++ phpdoc/en/reference/ircg/functions/ircg-notice.xml Wed Nov 27 11:50:10 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
<refentry id="function.ircg-notice">
<refnamediv>
@@ -19,9 +19,9 @@
<para>
This function will send the <parameter>message</parameter> text
to the user <parameter>nick</parameter> on the server connected
- to by <parameter>connection</parameter>. Query your IRC
- documentation of choice for the exact difference between a MSG
- and a NOTICE.
+ to by <parameter>connection</parameter>. IRC servers and other
+ software will not automatically generate replies to NOTICEs
+ in contrast to other message types.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/ircg/functions/ircg-pconnect.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-pconnect.xml:1.2
phpdoc/en/reference/ircg/functions/ircg-pconnect.xml:1.3
--- phpdoc/en/reference/ircg/functions/ircg-pconnect.xml:1.2 Wed Apr 17 02:39:36
2002
+++ phpdoc/en/reference/ircg/functions/ircg-pconnect.xml Wed Nov 27 11:50:10
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
<refentry id="function.ircg-pconnect">
<refnamediv>
@@ -34,25 +34,28 @@
<para>
For now parameter <parameter>server_ip</parameter> will not do
any hostname lookups and will only accept IP addresses in
- numerical form.
- </para>
- <para>
- Currently <function>ircg_pconnect</function> always returns a valid
- handle, even if the connection failed.
+ numerical form. DNS lookups are expensive and should be done in the
+ context of IRCG.
</para>
</note>
</para>
<para>
You can customize the output of IRC messages and events by
- selection a format string set previously created with
- <function>ircg_register_format_messages</function> by specifing
- the sets name in <parameter>msg_format</parameter>.
+ selecting a format message set previously created with
+ <function>ircg_register_format_messages</function> by specifying
+ the set's name in <parameter>msg_format</parameter>.
</para>
<para>
- <parameter>ctcp_messages</parameter>
+ If you want to handle CTCP messages such as ACTION (/me), you need to
+ define a mapping from CTCP type (e.g. ACTION) to a custom format
+ string. Do this by passing an associative array as
+ <parameter>ctcp_messages</parameter>. The keys of the array
+ are the CTCP type and the respective value is the format message.
</para>
<para>
- <parameter>user_settings</parameter>
+ You can define "ident", "password", and "realname" tokens which
+ are sent to the IRC server by setting these in an associative
+ array. Pass that array as <parameter>user_settings</parameter>.
</para>
<para>
See also: <function>ircg_disconnect</function>,
Index: phpdoc/en/reference/ircg/functions/ircg-register-format-messages.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-register-format-messages.xml:1.2
phpdoc/en/reference/ircg/functions/ircg-register-format-messages.xml:1.3
--- phpdoc/en/reference/ircg/functions/ircg-register-format-messages.xml:1.2 Wed
Apr 17 02:39:36 2002
+++ phpdoc/en/reference/ircg/functions/ircg-register-format-messages.xml Wed
+Nov 27 11:50:10 2002
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.17 -->
<refentry id="function.ircg-register-format-messages">
<refnamediv>
<refname>ircg_register_format_messages</refname>
<refpurpose>
- Register a set of format strings for display of IRC messages
+ Register a format message set
</refpurpose>
</refnamediv>
<refsect1>
@@ -17,9 +17,8 @@
</methodsynopsis>
<para>
With <function>ircg_register_format_messages</function> you can
- customize the way your IRC output looks like. You can even
- register different format string sets and switch between them on
- the fly with <function>ircg_lookup_format_messages</function>.
+ customize the way your IRC output looks like or which script
+ functions are invoked on the client side.
</para>
<para>
<itemizedlist>
Index: phpdoc/en/reference/ircg/functions/ircg-set-current.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-set-current.xml:1.2
phpdoc/en/reference/ircg/functions/ircg-set-current.xml:1.3
--- phpdoc/en/reference/ircg/functions/ircg-set-current.xml:1.2 Wed Apr 17 02:39:38
2002
+++ phpdoc/en/reference/ircg/functions/ircg-set-current.xml Wed Nov 27 11:50:10
+2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
<refentry id="function.ircg-set-current">
<refnamediv>
@@ -15,16 +15,14 @@
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
- Select the current connection for output in this execution
+ Select the current HTTP connection for output in this execution
context. Every output sent from the server connected to by
<parameter>connection</parameter> will be copied to standard
- output while using default formatting or a format string set
- specified by <function>ircg_register_format_messages</function>
- and selected by <function>ircg_lookup_format_messages</function>.
+ output while using default formatting or a format message set
+ specified by <function>ircg_register_format_messages</function>.
</para>
<para>
- See also: <function>ircg_register_format_messages</function> and
- <function>ircg_lookup_format_messages</function>.
+ See also: <function>ircg_register_format_messages</function>.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/ircg/functions/ircg-set-on-die.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-set-on-die.xml:1.3
phpdoc/en/reference/ircg/functions/ircg-set-on-die.xml:1.4
--- phpdoc/en/reference/ircg/functions/ircg-set-on-die.xml:1.3 Sun Jul 21 12:16:50
2002
+++ phpdoc/en/reference/ircg/functions/ircg-set-on-die.xml Wed Nov 27 11:50:10
+2002
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.17 -->
<refentry id='function.ircg-set-on-die'>
<refnamediv>
<refname>ircg_set_on_die</refname>
<refpurpose>
- Set hostaction to be execute when connection dies
+ Set action to be executed when connection dies
</refpurpose>
</refnamediv>
<refsect1>
@@ -24,7 +24,10 @@
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.
+ trigger a PHP script for example.
+ </para>
+ <para>
+ This feature requires IRCG 3.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/ircg/functions/ircg-whois.xml
diff -u phpdoc/en/reference/ircg/functions/ircg-whois.xml:1.2
phpdoc/en/reference/ircg/functions/ircg-whois.xml:1.3
--- phpdoc/en/reference/ircg/functions/ircg-whois.xml:1.2 Wed Apr 17 02:39:40
2002
+++ phpdoc/en/reference/ircg/functions/ircg-whois.xml Wed Nov 27 11:50:10 2002
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
<refentry id="function.ircg-whois">
<refnamediv>
<refname>ircg_whois</refname>
<refpurpose>
- Query user information for nick on server
+ Query server for user information
</refpurpose>
</refnamediv>
<refsect1>
@@ -17,7 +17,7 @@
</methodsynopsis>
<para>
Sends a query to the connected server
- <parameter>connection</parameter> to send information for the
+ <parameter>connection</parameter> to ask for information about the
specified user <parameter>nick</parameter>.
</para>
</refsect1>
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
