From 3a09637b0081e03edbdfa3c76a0a026881d71baf Mon Sep 17 00:00:00 2001 From: Egon Schmid Date: Mon, 27 Aug 2001 00:20:57 +0000 Subject: [PATCH] Only whitespace. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@56025 c90b9560-bf6c-de11-be94-00142212c4b1 --- functions/ircg.xml | 447 ++++++++++++++++++++++++--------------------- 1 file changed, 236 insertions(+), 211 deletions(-) diff --git a/functions/ircg.xml b/functions/ircg.xml index 518669ef52..1f1b15e88f 100644 --- a/functions/ircg.xml +++ b/functions/ircg.xml @@ -1,22 +1,22 @@ - + IRC Gateway Functions IRC Gateway - - Internet Relay Chat Gateway ... - - - Based on IRCG, from Sascha Schumann. - + + Internet Relay Chat Gateway ... + + + Based on IRCG, from Sascha Schumann. + ircg_pconnect - Connect to an IRC server + Connect to an IRC server @@ -25,48 +25,58 @@ resource ircg_pconnect string username - string server_ip - int server_port - string msg_format - array ctcp_messages - array user_settings + string + server_ip + + int + server_port + + string + msg_format + + array + ctcp_messages + + array + user_settings + - ircg_pconnect will try to establish a connection to - an IRC server and return a connection resource handle for further - use. + ircg_pconnect will try to establish a + connection to an IRC server and return a connection resource + handle for further use. + + + The only mandatory parameter is username, + this will set your initial nickname on the + server. server_ip and + server_port are optional and default to + 127.0.0.1 and 6667. + + + For now parameter server_ip will not do + any hostname lookups and will only accept IP addresses in + numerical form. + + + + + You can customize the output of IRC messages and events by + selection a format string set previously created with + ircg_register_format_messages by specifing + the sets name in msg_format. + + + ctcp_messages + + + user_settings - - The only mandatory parameter is username, - this will set your initial nickname on the - server. server_ip and - server_port are optional and default to - 127.0.0.1 and 6667. - - - For now parameter server_ip will not do - any hostname lookups and will only accept IP addresses in - numerical form. - - - - - You can customize the output of IRC messages and events by - selection a format string set previously created with - ircg_register_format_messages - by specifing the sets name in msg_format. - - - ctcp_messages - - - user_settings - See also: ircg_disconnect, - ircg_is_conn_alive, - ircg_register_format_messages. + ircg_is_conn_alive, + ircg_register_format_messages. @@ -74,7 +84,7 @@ ircg_fetch_error_msg - Returns the error from previous ircg operation + Returns the error from previous ircg operation @@ -86,32 +96,33 @@ - ircg_fetch_error_msg - returns the error from the last called ircg function. + ircg_fetch_error_msg returns the error from + the last called ircg function. - - - Errorcode is stored in first array element, errortext in second. - - + + + Errorcode is stored in first array element, errortext in second. + + - <function>ircg_fetch_error_msg</function> example - + <function>ircg_fetch_error_msg</function> example + if (!ircg_join ($id, "#php")){ $error = ircg_fetch_error_msg($id); - print ("Can't join channel #php. Errorcode: $error[0] Description: $error[1]"); + print ("Can't join channel #php. Errorcode: + $error[0] Description: $error[1]"); } - - - + + + ircg_set_current - Set current connection for output + Set current connection for output @@ -120,20 +131,20 @@ if (!ircg_join ($id, "#php")){ boolean ircg_set_current resource - connection + connection - Select the current connection for output in this execution - context. Every output sent from the server connected to by - connection will be copied to standard - output while using default formating or a formar string set - specified by ircg_register_format_messages - and selected by ircg_lookup_format_messages. + Select the current connection for output in this execution + context. Every output sent from the server connected to by + connection will be copied to standard + output while using default formating or a formar string set + specified by ircg_register_format_messages + and selected by ircg_lookup_format_messages. See also: ircg_register_format_messages and - ircg_lookup_format_messages. + ircg_lookup_format_messages. @@ -142,7 +153,7 @@ if (!ircg_join ($id, "#php")){ ircg_join - Join a channel on a connected server + Join a channel on a connected server @@ -151,12 +162,12 @@ if (!ircg_join ($id, "#php")){ boolean ircg_join resource connection - string channel + string channel - Join the channel channel on the server - connected to by connection. + Join the channel channel on the server + connected to by connection. See also: @@ -168,7 +179,7 @@ if (!ircg_join ($id, "#php")){ ircg_part - Leave a channel on server + Leave a channel on server @@ -177,12 +188,12 @@ if (!ircg_join ($id, "#php")){ boolean ircg_part resource connection - string channel + string channel - Leave the channel channel on the server - connected to by connection. + Leave the channel channel on the server + connected to by connection. See also: @@ -194,7 +205,7 @@ if (!ircg_join ($id, "#php")){ ircg_msg - Send message to channel or user on server + Send message to channel or user on server @@ -203,24 +214,26 @@ if (!ircg_join ($id, "#php")){ boolean ircg_msg resource connection - string recipient - string message - boolean suppress + string recipient + string message + boolean + suppress + - ircg_msg will send the message to a channel - or user on the server connected to by - connection. A - recipient starting with - # or & will send the - message to a channel, anything else will - be interpreted as a username. + ircg_msg will send the message to a channel + or user on the server connected to by + connection. A + recipient starting with + # or & will send the + message to a channel, anything else will + be interpreted as a username. - Setting the optional parameter suppress to - a &true; value will suppress output of your message to your own - connection. + Setting the optional parameter suppress to + a &true; value will suppress output of your message to your own + connection. @@ -229,7 +242,7 @@ if (!ircg_join ($id, "#php")){ ircg_notice - Send a notice to a user on server + Send a notice to a user on server @@ -238,19 +251,19 @@ if (!ircg_join ($id, "#php")){ boolean ircg_notice resource connection - string - string message + string + string message - This function will send the message text - to the user nick on the server connected - to by connection. Query your IRC - documentation of choice for the exact difference between a MSG - and a NOTICE. + This function will send the message text + to the user nick on the server connected + to by connection. Query your IRC + documentation of choice for the exact difference between a MSG + and a NOTICE. - See also: + See also : @@ -259,7 +272,7 @@ if (!ircg_join ($id, "#php")){ ircg_nick - Change nickname on server + Change nickname on server @@ -268,16 +281,16 @@ if (!ircg_join ($id, "#php")){ boolean ircg_nick resource connection - string nick + string nick - Change your nickname on the given - connection to the one given in - nick if possible. + Change your nickname on the given + connection to the one given in + nick if possible. - Will return &true; on success and &false; on failure. + Will return &true; on success and &false; on failure. @@ -286,7 +299,7 @@ if (!ircg_join ($id, "#php")){ ircg_topic - Set topic for channel on server + Set topic for channel on server @@ -295,14 +308,14 @@ if (!ircg_join ($id, "#php")){ boolean ircg_topic resource connection - string channel - string new_topic + string channel + string new_topic - Change the topic for channel channel on - the server connected to by connection to - new_topic. + Change the topic for channel channel on + the server connected to by connection to + new_topic. @@ -311,7 +324,7 @@ if (!ircg_join ($id, "#php")){ ircg_channel_mode - Set channel mode flags for user + Set channel mode flags for user @@ -320,23 +333,22 @@ if (!ircg_join ($id, "#php")){ boolean ircg_channel_mode resource connection - string channel - string mode_spec - string nick + string channel + string mode_spec + string nick - Set channel mode flags for channel on - server connected to by channel. Mode flags - are passed in mode_spec and are applied to - the user specified by nick. + Set channel mode flags for channel on + server connected to by channel. Mode flags + are passed in mode_spec and are applied to + the user specified by nick. - - Mode flags are set or cleared by specifind a mode character and - prepending it with a plus or minus character - respectively. E.g. operator mode is granted by '+o' and revoked - by '-o' passed as mode_spec. - + + Mode flags are set or cleared by specifind a mode character and + prepending it with a plus or minus character + respectively. E.g. operator mode is granted by '+o' and revoked + by '-o' passed as mode_spec. See also: @@ -347,7 +359,7 @@ if (!ircg_join ($id, "#php")){ ircg_html_encode - Encode HTML preserving output modes as ... + Encode HTML preserving output modes as ... @@ -355,14 +367,14 @@ if (!ircg_join ($id, "#php")){ boolean ircg_html_encode - string html_string + string html_string ... - See also: + See also: @@ -371,7 +383,7 @@ if (!ircg_join ($id, "#php")){ ircg_whois - Query user information for nick on server + Query user information for nick on server @@ -380,7 +392,7 @@ if (!ircg_join ($id, "#php")){ boolean ircg_whois resource connection - string nick + string nick @@ -396,7 +408,7 @@ if (!ircg_join ($id, "#php")){ ircg_kick - Kick a user out of a channel on server + Kick a user out of a channel on server @@ -405,16 +417,17 @@ if (!ircg_join ($id, "#php")){ boolean ircg_kick resource connection - string channel - string nick - string reason + string channel + string nick + string reason - Kick user nick from - channel on server connected to by - connection. reason - should give a short message describing why this action was performed. + Kick user nick from + channel on server connected to by + connection. reason + should give a short message describing why this action was + performed. @@ -423,7 +436,7 @@ if (!ircg_join ($id, "#php")){ ircg_ignore_add - Add a user to your ignore list on a server + Add a user to your ignore list on a server @@ -432,14 +445,14 @@ if (!ircg_join ($id, "#php")){ boolean ircg_ignore_add resource connection - string nick + string nick - This function will add user nick to your - ignore list on the server connected to by - connection. By doing so you will suppress - all messages from this user from being send to you. + This function will add user nick to your + ignore list on the server connected to by + connection. By doing so you will suppress + all messages from this user from being send to you. See also: ircg_ignore_del . @@ -451,7 +464,7 @@ if (!ircg_join ($id, "#php")){ ircg_ignore_del - Remove a user from your ignore list on a server + Remove a user from your ignore list on a server @@ -460,13 +473,13 @@ if (!ircg_join ($id, "#php")){ boolean ircg_ignore_del resource connection - string nick + string nick - This function remove user nick to your - ignore list on the server connected to by - connection. + This function remove user nick to your + ignore list on the server connected to by + connection. See also: ircg_ignore_add. @@ -478,7 +491,7 @@ if (!ircg_join ($id, "#php")){ ircg_disconnect - Close connection to server + Close connection to server @@ -487,13 +500,13 @@ if (!ircg_join ($id, "#php")){ boolean ircg_disconnect resource connection - string reason + string reason - ircg_disconnect will close a - connection to a server previously - established with ircg-pconnect. + ircg_disconnect will close a + connection to a server previously + established with ircg-pconnect. See also: ircg_pconnect. @@ -505,7 +518,7 @@ if (!ircg_join ($id, "#php")){ ircg_is_conn_alive - Check connection status + Check connection status @@ -517,9 +530,9 @@ if (!ircg_join ($id, "#php")){ - ircg_is_conn_alive returns &true; if - connection is still alive and working or - &false; if the server no longer talks to us. + ircg_is_conn_alive returns &true; if + connection is still alive and working or + &false; if the server no longer talks to us. @@ -528,22 +541,24 @@ if (!ircg_join ($id, "#php")){ ircg_lookup_format_messages - Select a set of format strings for display of IRC messages + Select a set of format strings for display of IRC messages Description - boolean ircg_lookup_format_messages + boolean + ircg_lookup_format_messages + string name - Select the set of format strings to use for display of IRC - messages and events. Sets may be registered with - ircg_register_format_messages, a default set - named ircg is always available. + Select the set of format strings to use for display of IRC + messages and events. Sets may be registered with + ircg_register_format_messages, a default set + named ircg is always available. See also: ircg_register_format_messages @@ -555,66 +570,76 @@ if (!ircg_join ($id, "#php")){ ircg_register_format_messages - Register a set of format strings for display of IRC messages + Register a set of format strings for display of IRC messages Description - boolean ircg_register_format_messages + boolean + ircg_register_format_messages + string name array messages - With ircg_register_format_messages you can - customize the way your IRC output looks like. You can even - register different format string sets and switch between them on - the fly with ircg_lookup_format_messages. + With ircg_register_format_messages you can + customize the way your IRC output looks like. You can even + register different format string sets and switch between them on + the fly with ircg_lookup_format_messages. + + + + Plain channel message + Private message received + Private message sent + Some user leaves channel + Some user enters channel + + Some user was kicked from the channel + + Topic has been changed + Error + Fatal error + Join list end(?) + Self part(?) + Some user changes his nick + + Some user quits his connection + + Mass join begin + Mass join element + Mass join end + Whois user + Whois server + Whois server + Whois idle + Whois channel + Whois end + + Voice status change on user + + + Operator status change on user + + Banlist + Banlist end + + + %f - from + %t - to + %c - channel + %r - plain message + %m - encoded message + %j - js encoded message + + + 1 - mod encode + 2 - nickname decode + - - - Plain channel message - Private message received - Private message sent - Some user leaves channel - Some user enters channel - Some user was kicked from the channel - Topic has been changed - Error - Fatal error - Join list end(?) - Self part(?) - Some user changes his nick - Some user quits his connection - Mass join begin - Mass join element - Mass join end - Whois user - Whois server - Whois server - Whois idle - Whois channel - Whois end - Voice status change on user - Operator status change on user - Banlist - Banlist end - - - %f - from - %t - to - %c - channel - %r - plain message - %m - encoded message - %j - js encoded message - - - 1 - mod encode - 2 - nickname decode - - See also: ircg_lookup_format_messages.