sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Removed the deprecated ircg extension from phpdoc/en

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@255548 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2008-03-20 02:18:10 +00:00
parent ca082c5697
commit d8542ecd5e
38 changed files with 3 additions and 2955 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
appendices/extensions.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.32 $ -->
<!-- $Revision: 1.33 $ -->
<!--
DO NOT TRANSLATE THIS FILE! All the content that is displayed
on the extension categorization page in your translated manual
@ -156,7 +156,6 @@
<listitem><para><xref linkend="book.imagick"/></para></listitem>
<listitem><para><xref linkend="book.imap"/></para></listitem>
<listitem><para><xref linkend="book.ingres"/></para></listitem>
<listitem><para><xref linkend="book.ircg"/></para></listitem>
<listitem><para><xref linkend="book.java"/></para></listitem>
<listitem><para><xref linkend="book.ldap"/></para></listitem>
<listitem><para><xref linkend="book.libxml"/></para></listitem>
@ -257,7 +256,6 @@
<listitem><para><xref linkend="book.iisfunc"/></para></listitem>
<listitem><para><xref linkend="book.imagick"/></para></listitem>
<listitem><para><xref linkend="book.ingres"/></para></listitem>
<listitem><para><xref linkend="book.ircg"/></para></listitem>
<listitem><para><xref linkend="book.java"/></para></listitem>
<listitem><para><xref linkend="book.json"/></para></listitem>
<listitem><para><xref linkend="book.kadm5"/></para></listitem>

4
appendices/migration51.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<appendix xml:id="migration51" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Migrating from PHP 5.0.x to PHP 5.1.x</title>
@ -590,7 +590,7 @@ class test {
<entry>pecl/ingres</entry>
</row>
<row>
<entry><link linkend="ref.ircg">ext/ircg</link></entry>
<entry>ext/ircg</entry>
<entry>Not actively maintained</entry>
</row>
<row>

68
reference/ircg/book.xml
View file

@ -1,68 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- Purpose: remote.other -->
<!-- Membership: pecl, external -->
<book xml:id="book.ircg" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>IRC Gateway</title>
<!-- {{{ preface -->
<preface xml:id="intro.ircg">
&reftitle.intro;
<para>
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>
Up to v4, IRCG runs under these platforms:
<itemizedlist>
<listitem><para>AIX</para></listitem>
<listitem><para>FreeBSD</para></listitem>
<listitem><para>HP-UX</para></listitem>
<listitem><para>Irix</para></listitem>
<listitem><para>Linux</para></listitem>
<listitem><para>Solaris</para></listitem>
<listitem><para>Tru64</para></listitem>
<listitem><para>Windows</para></listitem>
</itemizedlist>
</para>
<note>
<para>
&pecl.moved-ver;5.1.0.
</para>
</note>
</preface>
<!-- }}} -->
&reference.ircg.setup;
&reference.ircg.constants;
&reference.ircg.reference;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

38
reference/ircg/configure.xml
View file

@ -1,38 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<section xml:id="ircg.install" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.install;
<para>
Detailed installation instructions can be found
at <link xlink:href="&url.ircg;">&url.ircg;</link>. We urge you to use
the provided installation script.
</para>
<para>
It is not recommended, but you can try enable IRCG support yourself. Provide
the path to the ircg-config script,
<option role="configure">--with-ircg-config=path/to/irc-config</option>
and in addition add <option role="configure">--with-ircg</option> to your
configure line.
</para>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

29
reference/ircg/constants.xml
View file

@ -1,29 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<appendix xml:id="ircg.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
&no.constants;
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

101
reference/ircg/functions/ircg-channel-mode.xml
View file

@ -1,101 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.ircg-channel-mode" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_channel_mode</refname>
<refpurpose>Set channel mode flags for user</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_channel_mode</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>channel</parameter></methodparam>
<methodparam><type>string</type><parameter>mode_spec</parameter></methodparam>
<methodparam><type>string</type><parameter>nick</parameter></methodparam>
</methodsynopsis>
<para>
Set channel mode flags for <parameter>channel</parameter> on
server connected to by <parameter>connection</parameter>. Mode flags
are passed in <parameter>mode_spec</parameter> and are applied to
the user specified by <parameter>nick</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>channel</parameter></term>
<listitem>
<para>
The channel name as <literal>#name</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode_spec</parameter></term>
<listitem>
<para>
The mode to be applied on <parameter>nick</parameter>.
</para>
<para>
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', as passed as <parameter>mode_spec</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nick</parameter></term>
<listitem>
<para>
The user on which to apply the given mode.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

85
reference/ircg/functions/ircg-disconnect.xml
View file

@ -1,85 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.ircg-disconnect" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_disconnect</refname>
<refpurpose>Close connection to server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_disconnect</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>reason</parameter></methodparam>
</methodsynopsis>
<para>
<function>ircg_disconnect</function> will close a
<parameter>connection</parameter> to a server previously
established with <function>ircg_pconnect</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>reason</parameter></term>
<listitem>
<para>
A message for the disconnection.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ircg_pconnect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

60
reference/ircg/functions/ircg-eval-ecmascript-params.xml
View file

@ -1,60 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.ircg-eval-ecmascript-params" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_eval_ecmascript_params</refname>
<refpurpose>Decodes a list of JS-encoded parameters</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>ircg_eval_ecmascript_params</methodname>
<methodparam><type>string</type><parameter>params</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<screen>
From the ircg_eval_ecmascript_params source file:
/*
* State 0: Looking for ' or digit
* State 1: Assembling parameter inside '..'
* State 2: After escape sign: Copies single char verbatim, go to 1
* State 3: Assembling numeric para, no quotation
* State 4: Looking for ",", skipping whitespace
*/
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ircg_lookup_format_messages</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

91
reference/ircg/functions/ircg-fetch-error-msg.xml
View file

@ -1,91 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.ircg-fetch-error-msg" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_fetch_error_msg</refname>
<refpurpose>Returns the error from previous IRCG operation</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>ircg_fetch_error_msg</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>ircg_fetch_error_msg</function> returns the error from
a failed connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an indexed array where the error code is stored in first element,
and the error text in second.
</para>
<para>
The error code is equivalent to IRC reply codes as defined by
RFC 2812.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ircg_fetch_error_msg</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
if (!ircg_join ($id, "#php")) {
$error = ircg_fetch_error_msg($id);
echo "Can't join channel #php. Error code:
$error[0] Description: $error[1]";
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

66
reference/ircg/functions/ircg-get-username.xml
View file

@ -1,66 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id='function.ircg-get-username' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_get_username</refname>
<refpurpose>Get username for connection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ircg_get_username</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>ircg_get_username</function> returns the username for the
specified connection <parameter>connection</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the username, or &false; on error.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

84
reference/ircg/functions/ircg-html-encode.xml
View file

@ -1,84 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.ircg-html-encode" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_html_encode</refname>
<refpurpose>Encodes HTML preserving output</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ircg_html_encode</methodname>
<methodparam><type>string</type><parameter>html_string</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>auto_links</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>conv_br</parameter></methodparam>
</methodsynopsis>
<para>
Encodes a HTML string <parameter>html_string</parameter> for
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>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>html_string</parameter></term>
<listitem>
<para>
The HTML string to be encoded.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>auto_links</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>conv_br</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the encoded HTML string.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

85
reference/ircg/functions/ircg-ignore-add.xml
View file

@ -1,85 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.ircg-ignore-add" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_ignore_add</refname>
<refpurpose>Add a user to your ignore list on a server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>ircg_ignore_add</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>nick</parameter></methodparam>
</methodsynopsis>
<para>
This function adds user <parameter>nick</parameter> to the ignore list of
the <parameter>connection</parameter>. Afterwards, IRCG will suppress all
messages from this user through the associated connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nick</parameter></term>
<listitem>
<para>
The user to be ignored.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ircg_ignore_del</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

85
reference/ircg/functions/ircg-ignore-del.xml
View file

@ -1,85 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.ircg-ignore-del" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_ignore_del</refname>
<refpurpose>Remove a user from your ignore list on a server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_ignore_del</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>nick</parameter></methodparam>
</methodsynopsis>
<para>
This function removes user <parameter>nick</parameter> from the IRCG
ignore list associated with <parameter>connection</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nick</parameter></term>
<listitem>
<para>
The user nick name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ircg_ignore_add</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

85
reference/ircg/functions/ircg-invite.xml
View file

@ -1,85 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.ircg-invite" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_invite</refname>
<refpurpose>Invites nickname to channel</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_invite</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>channel</parameter></methodparam>
<methodparam><type>string</type><parameter>nickname</parameter></methodparam>
</methodsynopsis>
<para>
<function>ircg_invite</function> will send an invitation to the
user <parameter>nickname</parameter>, prompting him to join the given
<parameter>channel</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>channel</parameter></term>
<listitem>
<para>
The channel name as <literal>#name</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nickname</parameter></term>
<listitem>
<para>
The user nick name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

67
reference/ircg/functions/ircg-is-conn-alive.xml
View file

@ -1,67 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.ircg-is-conn-alive" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_is_conn_alive</refname>
<refpurpose>Check connection status</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_is_conn_alive</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>ircg_is_conn_alive</function> checks the
<parameter>connection</parameter> status.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if <parameter>connection</parameter> is still alive and
working or &false;, if the connection has died for some reason.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

84
reference/ircg/functions/ircg-join.xml
View file

@ -1,84 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.ircg-join" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_join</refname>
<refpurpose>Join a channel on a connected server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_join</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>channel</parameter></methodparam>
<methodparam choice="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>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>channel</parameter></term>
<listitem>
<para>
The channel name as <literal>#name</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
An optional password for the room.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

95
reference/ircg/functions/ircg-kick.xml
View file

@ -1,95 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.ircg-kick" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_kick</refname>
<refpurpose>Kick a user out of a channel on server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_kick</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>channel</parameter></methodparam>
<methodparam><type>string</type><parameter>nick</parameter></methodparam>
<methodparam><type>string</type><parameter>reason</parameter></methodparam>
</methodsynopsis>
<para>
Kick user <parameter>nick</parameter> from
<parameter>channel</parameter> on server connected to by
<parameter>connection</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>channel</parameter></term>
<listitem>
<para>
The channel name as <literal>#name</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nick</parameter></term>
<listitem>
<para>
The user to be kicked.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>reason</parameter></term>
<listitem>
<para>
<parameter>reason</parameter> should give a short message describing
why this action was performed.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

136
reference/ircg/functions/ircg-list.xml
View file

@ -1,136 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.ircg-list" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_list</refname>
<refpurpose>List topic/user count of channel(s)</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_list</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>channel</parameter></methodparam>
</methodsynopsis>
<simpara>
<function>ircg_list</function> will request a list of users in the
<parameter>channel</parameter>. The answer is sent to the output
defined by <function>ircg_set_file</function> or
<function>ircg_set_current</function>.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>channel</parameter></term>
<listitem>
<para>
The channel name as <literal>#name</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ircg_list</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// connect to server
$id = ircg_pconnect($nickname, $ip, $port);
// set to output to a file
ircg_set_file($id, 'irc_output.html');
// try to join a channel
if (!ircg_join($id, $channel)) {
echo "Cannot /join $channel<br />";
}
// send list command
ircg_list($id, $channel);
// wait for output to arrive
sleep(5);
// disconnect
ircg_disconnect($id,'Bye World');
// output everything
readfile('irc_output.html');
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
...
Channel #channel has n users and the topic is 'Topic'
End of LIST
...
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ircg_set_file</function></member>
<member><function>ircg_set_current</function></member>
<member><function>ircg_who</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

76
reference/ircg/functions/ircg-lookup-format-messages.xml
View file

@ -1,76 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.ircg-lookup-format-messages" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_lookup_format_messages</refname>
<refpurpose>Check for the existence of a format message set</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_lookup_format_messages</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
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.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
The format message set name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the set exists, &false; otherwise.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ircg_register_format_messages</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

80
reference/ircg/functions/ircg-lusers.xml
View file

@ -1,80 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.ircg-lusers" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_lusers</refname>
<refpurpose>IRC network statistics</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_lusers</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>ircg_lusers</function> will request a statistical
breakdown of users on the network connected to on
<parameter>connection</parameter>. The answer is sent to the
output defined by <function>ircg_set_file</function> or
<function>ircg_set_current</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ircg_set_file</function></member>
<member><function>ircg_set_current</function></member>
<member><function>ircg_who</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

102
reference/ircg/functions/ircg-msg.xml
View file

@ -1,102 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.ircg-msg" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_msg</refname>
<refpurpose>Send message to channel or user on server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_msg</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>recipient</parameter></methodparam>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>suppress</parameter></methodparam>
</methodsynopsis>
<para>
<function>ircg_msg</function> will send the message to a channel
or user on the server.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>recipient</parameter></term>
<listitem>
<para>
</para>
<para>
A <parameter>recipient</parameter> starting with <literal>#</literal>
or <literal>&amp;</literal> will send the
<parameter>message</parameter> to a channel, anything else will be
interpreted as a username.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
The message to be sent.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>suppress</parameter></term>
<listitem>
<para>
Setting the optional parameter <parameter>suppress</parameter> to
a &true; value will suppress output of your message to your own
<parameter>connection</parameter>. This so-called loopback is
necessary, because the IRC server does not echo PRIVMSG commands
back to us.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

92
reference/ircg/functions/ircg-names.xml
View file

@ -1,92 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.ircg-names" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_names</refname>
<refpurpose>Query visible usernames</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_names</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>channel</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>target</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>channel</parameter></term>
<listitem>
<para>
The channel name as <literal>#name</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>target</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ircg_get_username</function></member>
<member><function>ircg_lusers</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

75
reference/ircg/functions/ircg-nick.xml
View file

@ -1,75 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.ircg-nick" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_nick</refname>
<refpurpose>Change nickname on server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_nick</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>nick</parameter></methodparam>
</methodsynopsis>
<para>
Change your nickname on the given <parameter>connection</parameter> to the
specified one, if possible.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nick</parameter></term>
<listitem>
<para>
The new nick name for the current user.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

74
reference/ircg/functions/ircg-nickname-escape.xml
View file

@ -1,74 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id='function.ircg-nickname-escape' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_nickname_escape</refname>
<refpurpose>Encode special characters in nickname to be IRC-compliant</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ircg_nickname_escape</methodname>
<methodparam><type>string</type><parameter>nick</parameter></methodparam>
</methodsynopsis>
<para>
Function <function>ircg_nickname_escape</function> returns an encoded
nickname specified by <parameter>nick</parameter> which is IRC-compliant.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>nick</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An IRC-compliant nick name.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ircg_nickname_unescape</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

74
reference/ircg/functions/ircg-nickname-unescape.xml
View file

@ -1,74 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id='function.ircg-nickname-unescape' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_nickname_unescape</refname>
<refpurpose>Decodes encoded nickname</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ircg_nickname_unescape</methodname>
<methodparam><type>string</type><parameter>nick</parameter></methodparam>
</methodsynopsis>
<para>
Function <function>ircg_nickname_unescape</function> returns a
decoded nickname, which is specified in <parameter>nick</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>nick</parameter></term>
<listitem>
<para>
The encoded nick name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the decoded nick name.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ircg_nickname_escape</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

87
reference/ircg/functions/ircg-notice.xml
View file

@ -1,87 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.ircg-notice" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_notice</refname>
<refpurpose>Send a notice to a user on server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_notice</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>nick</parameter></methodparam>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
</methodsynopsis>
<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>. IRC servers and other
software will not automatically generate replies to NOTICEs
in contrast to other message types.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nick</parameter></term>
<listitem>
<para>
The destination user.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
The message contents.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

84
reference/ircg/functions/ircg-oper.xml
View file

@ -1,84 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.ircg-oper" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_oper</refname>
<refpurpose>Elevates privileges to IRC OPER</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_oper</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
<function>ircg_oper</function> will authenticate the logged in user
on <parameter>connection</parameter> as an IRC operator.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
The operator account name. Must be a registered IRC account.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password associated with <parameter>name</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

75
reference/ircg/functions/ircg-part.xml
View file

@ -1,75 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.ircg-part" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_part</refname>
<refpurpose>Leave a channel on server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_part</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>channel</parameter></methodparam>
</methodsynopsis>
<para>
Leave the channel <parameter>channel</parameter> on the server
connected to by <parameter>connection</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>channel</parameter></term>
<listitem>
<para>
The channel name as <literal>#name</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

143
reference/ircg/functions/ircg-pconnect.xml
View file

@ -1,143 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.ircg-pconnect" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_pconnect</refname>
<refpurpose>Connect to an IRC server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>ircg_pconnect</methodname>
<methodparam><type>string</type><parameter>username</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>server_ip</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>server_port</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>msg_format</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>ctcp_messages</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>user_settings</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>bailout_on_trivial</parameter></methodparam>
</methodsynopsis>
<para>
<function>ircg_pconnect</function> will try to establish a connection to
an IRC server.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
The initial nickname on the server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>server_ip</parameter></term>
<listitem>
<para>
The IRC server address.
</para>
<para>
<parameter>server_ip</parameter> must be an IP address in numerical
form. DNS lookups are expensive and should be done in the context of
IRCG. Default to <literal>127.0.0.1</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>server_port</parameter></term>
<listitem>
<para>
The server port number. Default to 6667.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>msg_format</parameter></term>
<listitem>
<para>
You can customize the output of IRC messages and events by 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>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ctcp_messages</parameter></term>
<listitem>
<para>
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>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_settings</parameter></term>
<listitem>
<para>
You can define "ident", "password", and "realname" tokens which
are sent to the IRC server by setting these in this associative
array.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>bailout_on_trivial</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a connection resource handle for further use, or &false; on error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ircg_disconnect</function></member>
<member><function>ircg_is_conn_alive</function></member>
<member><function>ircg_register_format_messages</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

129
reference/ircg/functions/ircg-register-format-messages.xml
View file

@ -1,129 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.ircg-register-format-messages" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_register_format_messages</refname>
<refpurpose>Register a format message set</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_register_format_messages</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>array</type><parameter>messages</parameter></methodparam>
</methodsynopsis>
<para>
With <function>ircg_register_format_messages</function> you can
customize the way your IRC output looks like or which script
functions are invoked on the client side.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>messages</parameter></term>
<listitem>
<para>
<itemizedlist>
<listitem><simpara>Plain channel message</simpara></listitem>
<listitem><simpara>Private message received</simpara></listitem>
<listitem><simpara>Private message sent</simpara></listitem>
<listitem><simpara>Some user leaves channel</simpara></listitem>
<listitem><simpara>Some user enters channel</simpara></listitem>
<listitem>
<simpara>Some user was kicked from the channel</simpara>
</listitem>
<listitem><simpara>Topic has been changed</simpara></listitem>
<listitem><simpara>Error</simpara></listitem>
<listitem><simpara>Fatal error</simpara></listitem>
<listitem><simpara>Join list end(?)</simpara></listitem>
<listitem><simpara>Self part(?)</simpara></listitem>
<listitem><simpara>Some user changes his nick</simpara></listitem>
<listitem>
<simpara>Some user quits his connection</simpara>
</listitem>
<listitem><simpara>Mass join begin</simpara></listitem>
<listitem><simpara>Mass join element</simpara></listitem>
<listitem><simpara>Mass join end</simpara></listitem>
<listitem><simpara>Whois user</simpara></listitem>
<listitem><simpara>Whois server</simpara></listitem>
<listitem><simpara>Whois idle</simpara></listitem>
<listitem><simpara>Whois channel</simpara></listitem>
<listitem><simpara>Whois end</simpara></listitem>
<listitem>
<simpara>Voice status change on user</simpara>
</listitem>
<listitem>
<simpara>Operator status change on user</simpara>
</listitem>
<listitem><simpara>Banlist</simpara></listitem>
<listitem><simpara>Banlist end</simpara></listitem>
</itemizedlist>
<itemizedlist>
<listitem><simpara>%f - from</simpara></listitem>
<listitem><simpara>%t - to</simpara></listitem>
<listitem><simpara>%c - channel</simpara></listitem>
<listitem><simpara>%r - plain message</simpara></listitem>
<listitem><simpara>%m - encoded message</simpara></listitem>
<listitem><simpara>%j - js encoded message</simpara></listitem>
</itemizedlist>
<itemizedlist>
<listitem><simpara>1 - mod encode</simpara></listitem>
<listitem><simpara>2 - nickname decode</simpara></listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ircg_lookup_format_messages</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

78
reference/ircg/functions/ircg-set-current.xml
View file

@ -1,78 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.ircg-set-current" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_set_current</refname>
<refpurpose>Set current connection for output</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_set_current</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
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 message set
specified by <function>ircg_register_format_messages</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ircg_register_format_messages</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

75
reference/ircg/functions/ircg-set-file.xml
View file

@ -1,75 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id='function.ircg-set-file' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_set_file</refname>
<refpurpose>Set logfile for connection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_set_file</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
</methodsynopsis>
<para>
<function>ircg_set_file</function> specifies a logfile in which all output
from the current <parameter>connection</parameter> will be logged.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
Path to the logfile.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

106
reference/ircg/functions/ircg-set-on-die.xml
View file

@ -1,106 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id='function.ircg-set-on-die' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_set_on_die</refname>
<refpurpose>Set action to be executed when connection dies</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_set_on_die</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
<methodparam><type>int</type><parameter>port</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
In case of the termination of the <parameter>connection</parameter>, IRCG
will connect to the specified <parameter>host</parameter>, 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>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem>
<para>
This must be an IPv4 address as IRCG does not resolve host-names due
to blocking issues.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem>
<para>
The port number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
The data to be sent before closing the connection.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This feature requires IRCG 3.
</para>
</note>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

83
reference/ircg/functions/ircg-topic.xml
View file

@ -1,83 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.ircg-topic" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_topic</refname>
<refpurpose>Set topic for channel on server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_topic</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>channel</parameter></methodparam>
<methodparam><type>string</type><parameter>new_topic</parameter></methodparam>
</methodsynopsis>
<para>
Change the topic for the <parameter>channel</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>channel</parameter></term>
<listitem>
<para>
The channel name as <literal>#name</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>new_topic</parameter></term>
<listitem>
<para>
The new topic to be set.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

100
reference/ircg/functions/ircg-who.xml
View file

@ -1,100 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.ircg-who" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_who</refname>
<refpurpose>Queries server for WHO information</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_who</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>mask</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>ops_only</parameter></methodparam>
</methodsynopsis>
<para>
<function>ircg_who</function> will request a list of users
whose nickname is matching the given <parameter>mask</parameter>.
</para>
<para>
The answer is sent to the output defined by
<function>ircg_set_file</function> or
<function>ircg_set_current</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mask</parameter></term>
<listitem>
<para>
A mask for the nickname.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ops_only</parameter></term>
<listitem>
<para>
The optional parameter <parameter>ops_only</parameter> will shrink the
list to server operators only.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ircg_set_file</function></member>
<member><function>ircg_set_current</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

74
reference/ircg/functions/ircg-whois.xml
View file

@ -1,74 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.ircg-whois" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ircg_whois</refname>
<refpurpose>Query server for user information</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ircg_whois</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>nick</parameter></methodparam>
</methodsynopsis>
<para>
Sends a query to ask for information about the specified user.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
A connection resource handle returned by
<function>ircg_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nick</parameter></term>
<listitem>
<para>
The user nick name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

30
reference/ircg/reference.xml
View file

@ -1,30 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<reference xml:id="ref.ircg" xmlns="http://docbook.org/ns/docbook">
<title>IRC Gateway &Functions;</title>
&reference.ircg.entities.functions;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

54
reference/ircg/setup.xml
View file

@ -1,54 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<chapter xml:id="ircg.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.setup;
<!-- {{{ Requirements -->
<section xml:id="ircg.requirements">
&reftitle.required;
&no.requirement;
</section>
<!-- }}} -->
<!-- {{{ Installation -->
&reference.ircg.configure;
<!-- }}} -->
<!-- {{{ Configuration -->
<section xml:id="ircg.configuration">
&reftitle.runtime;
&no.config;
</section>
<!-- }}} -->
<!-- {{{ Resources -->
<section xml:id="ircg.resources">
&reftitle.resources;
&no.resource;
</section>
<!-- }}} -->
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->