didou Fri Jan 30 06:28:36 2004 EDT
Added files:
/phpdoc/en/reference/ircg/functions ircg-invite.xml ircg-lusers.xml
ircg-oper.xml ircg-who.xml
Log:
4 functions documented by David Costa
# great work :)
http://cvs.php.net/co.php/phpdoc/en/reference/ircg/functions/ircg-invite.xml?r=1.1&p=1
Index: phpdoc/en/reference/ircg/functions/ircg-invite.xml
+++ phpdoc/en/reference/ircg/functions/ircg-invite.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.ircg-invite">
<refnamediv>
<refname>ircg_invite</refname>
<refpurpose>Invites nickname to channel</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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
<parameter>channel</parameter>. &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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ircg/functions/ircg-lusers.xml?r=1.1&p=1
Index: phpdoc/en/reference/ircg/functions/ircg-lusers.xml
+++ phpdoc/en/reference/ircg/functions/ircg-lusers.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.ircg-lusers">
<refnamediv>
<refname>ircg_lusers</refname>
<refpurpose>IRC network statistics</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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>.
&return.success;
</para>
<para>
See also: <function>ircg_set_file</function>, and
<function>ircg_set_current</function>.
</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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ircg/functions/ircg-oper.xml?r=1.1&p=1
Index: phpdoc/en/reference/ircg/functions/ircg-oper.xml
+++ phpdoc/en/reference/ircg/functions/ircg-oper.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.ircg-oper">
<refnamediv>
<refname>ircg_oper</refname>
<refpurpose>Elevates privileges to IRC OPER</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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.
<parameter>name</parameter> and <parameter>password</parameter> must
match a registered IRC operator account. &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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ircg/functions/ircg-who.xml?r=1.1&p=1
Index: phpdoc/en/reference/ircg/functions/ircg-who.xml
+++ phpdoc/en/reference/ircg/functions/ircg-who.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.ircg-who">
<refnamediv>
<refname>ircg_who</refname>
<refpurpose>Queries server for WHO information</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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 <parameter>mask</parameter> on connected
network <parameter>connection</parameter>. The optional parameter
<parameter>ops_only</parameter> will shrink the list to server
operators only.
</para>
<para>
The answer is sent to the output defined by
<function>ircg_set_file</function> or
<function>ircg_set_current</function>.
&return.success;
</para>
<para>
See also: <function>ircg_set_file</function>, and
<function>ircg_set_current</function>.
</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
-->
