mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
ref.ircg: switch to new doc style
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237371 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
parent
6a7bf552bd
commit
ed249509ed
31 changed files with 1449 additions and 318 deletions
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry id="function.ircg-channel-mode">
|
||||
<refnamediv>
|
||||
<refname>ircg_channel_mode</refname>
|
||||
<refpurpose>Set channel mode flags for user</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_channel_mode</methodname>
|
||||
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -21,13 +21,62 @@
|
|||
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>
|
||||
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>.
|
||||
<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
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry id="function.ircg-disconnect">
|
||||
<refnamediv>
|
||||
<refname>ircg_disconnect</refname>
|
||||
<refpurpose>Close connection to server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_disconnect</methodname>
|
||||
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -18,10 +18,49 @@
|
|||
<parameter>connection</parameter> to a server previously
|
||||
established with <function>ircg_pconnect</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
See also: <function>ircg_pconnect</function>.
|
||||
<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
|
||||
|
|
|
@ -1,12 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<refentry id="function.ircg-eval-ecmascript-params">
|
||||
<refnamediv>
|
||||
<refname>ircg_eval_ecmascript_params</refname>
|
||||
<refpurpose>Decodes a list of JS-encoded parameters</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>ircg_eval_ecmascript_params</methodname>
|
||||
<methodparam><type>string</type><parameter>params</parameter></methodparam>
|
||||
|
@ -24,12 +25,17 @@
|
|||
* State 4: Looking for ",", skipping whitespace
|
||||
*/
|
||||
</screen>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
See also
|
||||
<function>ircg_lookup_format_messages</function>.
|
||||
<simplelist>
|
||||
<member><function>ircg_lookup_format_messages</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.7 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry id="function.ircg-fetch-error-msg">
|
||||
<refnamediv>
|
||||
<refname>ircg_fetch_error_msg</refname>
|
||||
<refpurpose>Returns the error from previous IRCG operation</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>ircg_fetch_error_msg</methodname>
|
||||
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -16,13 +16,39 @@
|
|||
<function>ircg_fetch_error_msg</function> returns the error from
|
||||
a failed connection.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
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>
|
||||
</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>
|
||||
|
@ -40,6 +66,7 @@ if (!ircg_join ($id, "#php")) {
|
|||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
|
|
@ -1,24 +1,47 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.17 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry id='function.ircg-get-username'>
|
||||
<refnamediv>
|
||||
<refname>ircg_get_username</refname>
|
||||
<refpurpose>Get username for connection</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<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 <function>ircg_get_username</function> returns the
|
||||
username for the specified connection <parameter>connection</parameter>.
|
||||
Returns &false; if <parameter>connection</parameter> died or is
|
||||
not valid.
|
||||
<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
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.ircg-html-encode">
|
||||
<refnamediv>
|
||||
<refname>ircg_html_encode</refname>
|
||||
<refpurpose>Encodes HTML preserving output</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>ircg_html_encode</methodname>
|
||||
<methodparam><type>string</type><parameter>html_string</parameter></methodparam>
|
||||
|
@ -22,6 +22,44 @@
|
|||
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
|
||||
|
|
|
@ -1,28 +1,66 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry id="function.ircg-ignore-add">
|
||||
<refnamediv>
|
||||
<refname>ircg_ignore_add</refname>
|
||||
<refpurpose>Add a user to your ignore list on a server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<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 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>.
|
||||
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
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry id="function.ircg-ignore-del">
|
||||
<refnamediv>
|
||||
<refname>ircg_ignore_del</refname>
|
||||
<refpurpose>Remove a user from your ignore list on a server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_ignore_del</methodname>
|
||||
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -17,10 +17,50 @@
|
|||
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>
|
||||
See also: <function>ircg_ignore_add</function>.
|
||||
<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
|
||||
|
|
|
@ -1,12 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<refentry id="function.ircg-invite">
|
||||
<refnamediv>
|
||||
<refname>ircg_invite</refname>
|
||||
<refpurpose>Invites nickname to channel</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_invite</methodname>
|
||||
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -15,10 +16,51 @@
|
|||
</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;
|
||||
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
|
||||
|
|
|
@ -1,23 +1,48 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry id="function.ircg-is-conn-alive">
|
||||
<refnamediv>
|
||||
<refname>ircg_is_conn_alive</refname>
|
||||
<refpurpose>Check connection status</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<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> returns &true; if
|
||||
<parameter>connection</parameter> is still alive and working or
|
||||
&false;, if the connection has died for some reason.
|
||||
<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
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry id="function.ircg-join">
|
||||
<refnamediv>
|
||||
<refname>ircg_join</refname>
|
||||
<refpurpose>Join a channel on a connected server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_join</methodname>
|
||||
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -16,10 +16,50 @@
|
|||
</methodsynopsis>
|
||||
<para>
|
||||
Join the channel <parameter>channel</parameter> on the server
|
||||
connected to by <parameter>connection</parameter>. IRCG will
|
||||
optionally pass the room key <parameter>key</parameter>.
|
||||
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
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<refentry id="function.ircg-kick">
|
||||
<refnamediv>
|
||||
<refname>ircg_kick</refname>
|
||||
<refpurpose>Kick a user out of a channel on server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_kick</methodname>
|
||||
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -18,11 +18,58 @@
|
|||
<para>
|
||||
Kick user <parameter>nick</parameter> from
|
||||
<parameter>channel</parameter> on server connected to by
|
||||
<parameter>connection</parameter>. <parameter>reason</parameter>
|
||||
should give a short message describing why this action was
|
||||
performed.
|
||||
<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>
|
||||
<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
|
||||
|
|
|
@ -1,12 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<refentry id="function.ircg-list">
|
||||
<refnamediv>
|
||||
<refname>ircg_list</refname>
|
||||
<refpurpose>List topic/user count of channel(s)</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_list</methodname>
|
||||
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -17,8 +18,43 @@
|
|||
<parameter>channel</parameter>. The answer is sent to the output
|
||||
defined by <function>ircg_set_file</function> or
|
||||
<function>ircg_set_current</function>.
|
||||
&return.success;
|
||||
</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>
|
||||
|
@ -52,9 +88,7 @@ readfile('irc_output.html');
|
|||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
<para>
|
||||
This example will output something similar to:
|
||||
</para>
|
||||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
...
|
||||
|
@ -65,12 +99,19 @@ End of LIST
|
|||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
<simpara>
|
||||
See also: <function>ircg_set_file</function>,
|
||||
<function>ircg_set_current</function>, and
|
||||
<function>ircg_who</function>.
|
||||
</simpara>
|
||||
</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
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry id="function.ircg-lookup-format-messages">
|
||||
<refnamediv>
|
||||
<refname>ircg_lookup_format_messages</refname>
|
||||
<refpurpose>Check for the existence of a format message set</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_lookup_format_messages</methodname>
|
||||
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
||||
|
@ -16,13 +16,42 @@
|
|||
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. Returns &true;,
|
||||
if the set exists and &false; otherwise.
|
||||
</para>
|
||||
<para>
|
||||
See also: <function>ircg_register_format_messages</function>
|
||||
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
|
||||
|
|
|
@ -1,12 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.ircg-lusers">
|
||||
<refnamediv>
|
||||
<refname>ircg_lusers</refname>
|
||||
<refpurpose>IRC network statistics</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_lusers</methodname>
|
||||
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -17,13 +18,44 @@
|
|||
<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>
|
||||
|
||||
<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
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<refentry id="function.ircg-msg">
|
||||
<refnamediv>
|
||||
<refname>ircg_msg</refname>
|
||||
<refpurpose>Send message to channel or user on server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_msg</methodname>
|
||||
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -17,21 +17,67 @@
|
|||
</methodsynopsis>
|
||||
<para>
|
||||
<function>ircg_msg</function> will send the message to a channel
|
||||
or user on the server connected to by
|
||||
<parameter>connection</parameter>. A
|
||||
<parameter>recipient</parameter> starting with
|
||||
<literal>#</literal> or <literal>&</literal> will send the
|
||||
<parameter>message</parameter> to a channel, anything else will
|
||||
be interpreted as a username.
|
||||
</para>
|
||||
<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.
|
||||
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>&</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
|
||||
|
|
|
@ -1,12 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<refentry id="function.ircg-names">
|
||||
<refnamediv>
|
||||
<refname>ircg_names</refname>
|
||||
<refpurpose>Query visible usernames</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_names</methodname>
|
||||
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -14,16 +15,59 @@
|
|||
<methodparam choice="opt"><type>string</type><parameter>target</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
|
||||
&warn.undocumented.func;
|
||||
|
||||
</para>
|
||||
<para>
|
||||
See also
|
||||
<function>ircg_get_username</function> and
|
||||
<function>ircg_lusers</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>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
|
||||
|
|
|
@ -1,27 +1,56 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry id="function.ircg-nick">
|
||||
<refnamediv>
|
||||
<refname>ircg_nick</refname>
|
||||
<refpurpose>Change nickname on server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<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 one given in
|
||||
<parameter>nick</parameter>, if possible.
|
||||
</para>
|
||||
<para>
|
||||
Will return &true; on success and &false; on failure.
|
||||
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
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.17 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry id='function.ircg-nickname-escape'>
|
||||
<refnamediv>
|
||||
<refname>ircg_nickname_escape</refname>
|
||||
<refpurpose>Encode special characters in nickname to be IRC-compliant</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>ircg_nickname_escape</methodname>
|
||||
<methodparam><type>string</type><parameter>nick</parameter></methodparam>
|
||||
|
@ -16,10 +16,40 @@
|
|||
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>
|
||||
See also: <function>ircg_nickname_unescape</function>
|
||||
<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
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<refentry id='function.ircg-nickname-unescape'>
|
||||
<refnamediv>
|
||||
<refname>ircg_nickname_unescape</refname>
|
||||
<refpurpose>Decodes encoded nickname</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>ircg_nickname_unescape</methodname>
|
||||
<methodparam><type>string</type><parameter>nick</parameter></methodparam>
|
||||
|
@ -16,10 +16,40 @@
|
|||
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>
|
||||
See also: <function>ircg_nickname_escape</function>
|
||||
<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
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.ircg-notice">
|
||||
<refnamediv>
|
||||
<refname>ircg_notice</refname>
|
||||
<refpurpose>Send a notice to a user on server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_notice</methodname>
|
||||
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -22,6 +22,47 @@
|
|||
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
|
||||
|
|
|
@ -1,12 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.ircg-oper">
|
||||
<refnamediv>
|
||||
<refname>ircg_oper</refname>
|
||||
<refpurpose>Elevates privileges to IRC OPER</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_oper</methodname>
|
||||
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -16,10 +17,49 @@
|
|||
<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>
|
||||
|
||||
<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
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<refentry id="function.ircg-part">
|
||||
<refnamediv>
|
||||
<refname>ircg_part</refname>
|
||||
<refpurpose>Leave a channel on server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_part</methodname>
|
||||
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -18,6 +18,39 @@
|
|||
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
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry id="function.ircg-pconnect">
|
||||
<refnamediv>
|
||||
<refname>ircg_pconnect</refname>
|
||||
<refpurpose>Connect to an IRC server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>resource</type><methodname>ircg_pconnect</methodname>
|
||||
<methodparam><type>string</type><parameter>username</parameter></methodparam>
|
||||
|
@ -19,49 +19,106 @@
|
|||
<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 and return a connection resource
|
||||
handle for further use.
|
||||
</para>
|
||||
<para>
|
||||
The only mandatory parameter is <parameter>username</parameter>,
|
||||
this will set your initial nickname on the
|
||||
server. <parameter>server_ip</parameter> and
|
||||
<parameter>server_port</parameter> are optional and default to
|
||||
<literal>127.0.0.1</literal> and <literal>6667</literal>.
|
||||
<note>
|
||||
<para>
|
||||
For now parameter <parameter>server_ip</parameter> will not do
|
||||
any hostname lookups and will only accept IP addresses in
|
||||
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
|
||||
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>
|
||||
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>
|
||||
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>,
|
||||
<function>ircg_is_conn_alive</function>,
|
||||
<function>ircg_register_format_messages</function>.
|
||||
<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
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.17 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry id="function.ircg-register-format-messages">
|
||||
<refnamediv>
|
||||
<refname>ircg_register_format_messages</refname>
|
||||
<refpurpose>Register a format message set</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_register_format_messages</methodname>
|
||||
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
||||
|
@ -18,59 +18,93 @@
|
|||
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>
|
||||
<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>
|
||||
<para>
|
||||
See also: <function>ircg_lookup_format_messages</function>.
|
||||
<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
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry id="function.ircg-set-current">
|
||||
<refnamediv>
|
||||
<refname>ircg_set_current</refname>
|
||||
<refpurpose>Set current connection for output</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_set_current</methodname>
|
||||
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -19,10 +19,41 @@
|
|||
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>
|
||||
See also: <function>ircg_register_format_messages</function>.
|
||||
<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
|
||||
|
|
|
@ -1,25 +1,56 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.17 -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<refentry id='function.ircg-set-file'>
|
||||
<refnamediv>
|
||||
<refname>ircg_set_file</refname>
|
||||
<refpurpose>Set logfile for connection</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<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 <function>ircg_set_file</function> specifies a logfile
|
||||
<parameter>path</parameter> in which all output from connection
|
||||
<parameter>connection</parameter> will be logged.
|
||||
Returns &true; on success, otherwise &false;.
|
||||
<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
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.17 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry id='function.ircg-set-on-die'>
|
||||
<refnamediv>
|
||||
<refname>ircg_set_on_die</refname>
|
||||
<refpurpose>Set action to be executed when connection dies</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_set_on_die</methodname>
|
||||
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -16,18 +16,72 @@
|
|||
<methodparam><type>string</type><parameter>data</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
In case of the termination of connection <parameter>connection</parameter>
|
||||
IRCG will connect to <parameter>host</parameter> at
|
||||
<parameter>port</parameter> (Note: host must be an IPv4 address,
|
||||
IRCG does not resolve host-names due to blocking issues), send
|
||||
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>
|
||||
This feature requires IRCG 3.
|
||||
<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
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<refentry id="function.ircg-topic">
|
||||
<refnamediv>
|
||||
<refname>ircg_topic</refname>
|
||||
<refpurpose>Set topic for channel on server</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_topic</methodname>
|
||||
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -15,11 +15,50 @@
|
|||
<methodparam><type>string</type><parameter>new_topic</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Change the topic for channel <parameter>channel</parameter> on
|
||||
the server connected to by <parameter>connection</parameter> to
|
||||
<parameter>new_topic</parameter>.
|
||||
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
|
||||
|
|
|
@ -1,12 +1,13 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry id="function.ircg-who">
|
||||
<refnamediv>
|
||||
<refname>ircg_who</refname>
|
||||
<refpurpose>Queries server for WHO information</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>ircg_who</methodname>
|
||||
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||||
|
@ -15,22 +16,66 @@
|
|||
</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.
|
||||
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>.
|
||||
&return.success;
|
||||
</para>
|
||||
<para>
|
||||
See also: <function>ircg_set_file</function>, and
|
||||
<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
|
||||
|
|
|
@ -1,24 +1,55 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry id="function.ircg-whois">
|
||||
<refnamediv>
|
||||
<refname>ircg_whois</refname>
|
||||
<refpurpose>Query server for user information</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<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 the connected server
|
||||
<parameter>connection</parameter> to ask for information about the
|
||||
specified user <parameter>nick</parameter>.
|
||||
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
|
||||
|
|
Loading…
Reference in a new issue