From d8542ecd5ec31b456f5d2294bb85d4956101f7e5 Mon Sep 17 00:00:00 2001 From: Philip Olson Date: Thu, 20 Mar 2008 02:18:10 +0000 Subject: [PATCH] Removed the deprecated ircg extension from phpdoc/en git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@255548 c90b9560-bf6c-de11-be94-00142212c4b1 --- appendices/extensions.xml | 4 +- appendices/migration51.xml | 4 +- reference/ircg/book.xml | 68 --------- reference/ircg/configure.xml | 38 ----- reference/ircg/constants.xml | 29 ---- .../ircg/functions/ircg-channel-mode.xml | 101 ------------- reference/ircg/functions/ircg-disconnect.xml | 85 ----------- .../functions/ircg-eval-ecmascript-params.xml | 60 -------- .../ircg/functions/ircg-fetch-error-msg.xml | 91 ----------- .../ircg/functions/ircg-get-username.xml | 66 -------- reference/ircg/functions/ircg-html-encode.xml | 84 ---------- reference/ircg/functions/ircg-ignore-add.xml | 85 ----------- reference/ircg/functions/ircg-ignore-del.xml | 85 ----------- reference/ircg/functions/ircg-invite.xml | 85 ----------- .../ircg/functions/ircg-is-conn-alive.xml | 67 -------- reference/ircg/functions/ircg-join.xml | 84 ---------- reference/ircg/functions/ircg-kick.xml | 95 ------------ reference/ircg/functions/ircg-list.xml | 136 ----------------- .../functions/ircg-lookup-format-messages.xml | 76 ---------- reference/ircg/functions/ircg-lusers.xml | 80 ---------- reference/ircg/functions/ircg-msg.xml | 102 ------------- reference/ircg/functions/ircg-names.xml | 92 ----------- reference/ircg/functions/ircg-nick.xml | 75 --------- .../ircg/functions/ircg-nickname-escape.xml | 74 --------- .../ircg/functions/ircg-nickname-unescape.xml | 74 --------- reference/ircg/functions/ircg-notice.xml | 87 ----------- reference/ircg/functions/ircg-oper.xml | 84 ---------- reference/ircg/functions/ircg-part.xml | 75 --------- reference/ircg/functions/ircg-pconnect.xml | 143 ------------------ .../ircg-register-format-messages.xml | 129 ---------------- reference/ircg/functions/ircg-set-current.xml | 78 ---------- reference/ircg/functions/ircg-set-file.xml | 75 --------- reference/ircg/functions/ircg-set-on-die.xml | 106 ------------- reference/ircg/functions/ircg-topic.xml | 83 ---------- reference/ircg/functions/ircg-who.xml | 100 ------------ reference/ircg/functions/ircg-whois.xml | 74 --------- reference/ircg/reference.xml | 30 ---- reference/ircg/setup.xml | 54 ------- 38 files changed, 3 insertions(+), 2955 deletions(-) delete mode 100644 reference/ircg/book.xml delete mode 100644 reference/ircg/configure.xml delete mode 100644 reference/ircg/constants.xml delete mode 100644 reference/ircg/functions/ircg-channel-mode.xml delete mode 100644 reference/ircg/functions/ircg-disconnect.xml delete mode 100644 reference/ircg/functions/ircg-eval-ecmascript-params.xml delete mode 100644 reference/ircg/functions/ircg-fetch-error-msg.xml delete mode 100644 reference/ircg/functions/ircg-get-username.xml delete mode 100644 reference/ircg/functions/ircg-html-encode.xml delete mode 100644 reference/ircg/functions/ircg-ignore-add.xml delete mode 100644 reference/ircg/functions/ircg-ignore-del.xml delete mode 100644 reference/ircg/functions/ircg-invite.xml delete mode 100644 reference/ircg/functions/ircg-is-conn-alive.xml delete mode 100644 reference/ircg/functions/ircg-join.xml delete mode 100644 reference/ircg/functions/ircg-kick.xml delete mode 100644 reference/ircg/functions/ircg-list.xml delete mode 100644 reference/ircg/functions/ircg-lookup-format-messages.xml delete mode 100644 reference/ircg/functions/ircg-lusers.xml delete mode 100644 reference/ircg/functions/ircg-msg.xml delete mode 100644 reference/ircg/functions/ircg-names.xml delete mode 100644 reference/ircg/functions/ircg-nick.xml delete mode 100644 reference/ircg/functions/ircg-nickname-escape.xml delete mode 100644 reference/ircg/functions/ircg-nickname-unescape.xml delete mode 100644 reference/ircg/functions/ircg-notice.xml delete mode 100644 reference/ircg/functions/ircg-oper.xml delete mode 100644 reference/ircg/functions/ircg-part.xml delete mode 100644 reference/ircg/functions/ircg-pconnect.xml delete mode 100644 reference/ircg/functions/ircg-register-format-messages.xml delete mode 100644 reference/ircg/functions/ircg-set-current.xml delete mode 100644 reference/ircg/functions/ircg-set-file.xml delete mode 100644 reference/ircg/functions/ircg-set-on-die.xml delete mode 100644 reference/ircg/functions/ircg-topic.xml delete mode 100644 reference/ircg/functions/ircg-who.xml delete mode 100644 reference/ircg/functions/ircg-whois.xml delete mode 100644 reference/ircg/reference.xml delete mode 100644 reference/ircg/setup.xml diff --git a/appendices/extensions.xml b/appendices/extensions.xml index d5e25c1365..9ca1c671ee 100644 --- a/appendices/extensions.xml +++ b/appendices/extensions.xml @@ -1,5 +1,5 @@ - + + Migrating from PHP 5.0.x to PHP 5.1.x @@ -590,7 +590,7 @@ class test { pecl/ingres - ext/ircg + ext/ircg Not actively maintained diff --git a/reference/ircg/book.xml b/reference/ircg/book.xml deleted file mode 100644 index 71e7f85e6e..0000000000 --- a/reference/ircg/book.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - IRC Gateway - - - - &reftitle.intro; - - With IRCG you can rapidly stream XML data to thousands of concurrently - connected users. This can be used to build powerful, extensible - interactive platforms such as online games and webchats. - IRCG also features support for a non-streaming mode where a helper - application reformats incoming data and supplies static file snippets in - special formats such as cHTML (i-mode) or WML (WAP). These static files - are then delivered by the high-performance web server. - - - Up to v4, IRCG runs under these platforms: - - AIX - FreeBSD - HP-UX - Irix - Linux - Solaris - Tru64 - Windows - - - - - &pecl.moved-ver;5.1.0. - - - - - - &reference.ircg.setup; - &reference.ircg.constants; - &reference.ircg.reference; - - - - - diff --git a/reference/ircg/configure.xml b/reference/ircg/configure.xml deleted file mode 100644 index 96098d2a04..0000000000 --- a/reference/ircg/configure.xml +++ /dev/null @@ -1,38 +0,0 @@ - - -
- &reftitle.install; - - Detailed installation instructions can be found - at &url.ircg;. We urge you to use - the provided installation script. - - - It is not recommended, but you can try enable IRCG support yourself. Provide - the path to the ircg-config script, - - and in addition add to your - configure line. - -
- - diff --git a/reference/ircg/constants.xml b/reference/ircg/constants.xml deleted file mode 100644 index c326f58fd3..0000000000 --- a/reference/ircg/constants.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &reftitle.constants; - &no.constants; - - - - diff --git a/reference/ircg/functions/ircg-channel-mode.xml b/reference/ircg/functions/ircg-channel-mode.xml deleted file mode 100644 index 8b16380239..0000000000 --- a/reference/ircg/functions/ircg-channel-mode.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - ircg_channel_mode - Set channel mode flags for user - - - - &reftitle.description; - - boolircg_channel_mode - resourceconnection - stringchannel - stringmode_spec - stringnick - - - Set channel mode flags for channel on - server connected to by connection. Mode flags - are passed in mode_spec and are applied to - the user specified by nick. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - channel - - - The channel name as #name. - - - - - mode_spec - - - The mode to be applied on nick. - - - 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 mode_spec. - - - - - nick - - - The user on which to apply the given mode. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ircg/functions/ircg-disconnect.xml b/reference/ircg/functions/ircg-disconnect.xml deleted file mode 100644 index e54c5d55f1..0000000000 --- a/reference/ircg/functions/ircg-disconnect.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - ircg_disconnect - Close connection to server - - - - &reftitle.description; - - boolircg_disconnect - resourceconnection - stringreason - - - ircg_disconnect will close a - connection to a server previously - established with ircg_pconnect. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - reason - - - A message for the disconnection. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ircg_pconnect - - - - - - - diff --git a/reference/ircg/functions/ircg-eval-ecmascript-params.xml b/reference/ircg/functions/ircg-eval-ecmascript-params.xml deleted file mode 100644 index 2e5d9eafda..0000000000 --- a/reference/ircg/functions/ircg-eval-ecmascript-params.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - ircg_eval_ecmascript_params - Decodes a list of JS-encoded parameters - - - - &reftitle.description; - - arrayircg_eval_ecmascript_params - stringparams - - - &warn.undocumented.func; - - - From the ircg_eval_ecmascript_params source file: - /* - * State 0: Looking for ' or digit - * State 1: Assembling parameter inside '..' - * State 2: After escape sign: Copies single char verbatim, go to 1 - * State 3: Assembling numeric para, no quotation - * State 4: Looking for ",", skipping whitespace - */ - - - - - &reftitle.seealso; - - - ircg_lookup_format_messages - - - - - - - diff --git a/reference/ircg/functions/ircg-fetch-error-msg.xml b/reference/ircg/functions/ircg-fetch-error-msg.xml deleted file mode 100644 index 2eb6871482..0000000000 --- a/reference/ircg/functions/ircg-fetch-error-msg.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - ircg_fetch_error_msg - Returns the error from previous IRCG operation - - - - &reftitle.description; - - arrayircg_fetch_error_msg - resourceconnection - - - ircg_fetch_error_msg returns the error from - a failed connection. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - - - - - &reftitle.returnvalues; - - Returns an indexed array where the error code is stored in first element, - and the error text in second. - - - The error code is equivalent to IRC reply codes as defined by - RFC 2812. - - - - - &reftitle.examples; - - - <function>ircg_fetch_error_msg</function> example - - -]]> - - - - - - - - diff --git a/reference/ircg/functions/ircg-get-username.xml b/reference/ircg/functions/ircg-get-username.xml deleted file mode 100644 index 728fc9be5c..0000000000 --- a/reference/ircg/functions/ircg-get-username.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - ircg_get_username - Get username for connection - - - - &reftitle.description; - - stringircg_get_username - resourceconnection - - - ircg_get_username returns the username for the - specified connection connection. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - - - - - &reftitle.returnvalues; - - Returns the username, or &false; on error. - - - - - - diff --git a/reference/ircg/functions/ircg-html-encode.xml b/reference/ircg/functions/ircg-html-encode.xml deleted file mode 100644 index 5683b16ada..0000000000 --- a/reference/ircg/functions/ircg-html-encode.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - ircg_html_encode - Encodes HTML preserving output - - - - &reftitle.description; - - stringircg_html_encode - stringhtml_string - boolauto_links - boolconv_br - - - Encodes a HTML string html_string for - output. This exposes the interface which the IRCG extension - uses internally to reformat data coming from an IRC link. - The function causes IRC color/font codes to be encoded in - HTML and escapes certain entities. - - - - - &reftitle.parameters; - - - - html_string - - - The HTML string to be encoded. - - - - - auto_links - - - - - - - conv_br - - - - - - - - - - - &reftitle.returnvalues; - - Returns the encoded HTML string. - - - - - - diff --git a/reference/ircg/functions/ircg-ignore-add.xml b/reference/ircg/functions/ircg-ignore-add.xml deleted file mode 100644 index 6e6d496c56..0000000000 --- a/reference/ircg/functions/ircg-ignore-add.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - ircg_ignore_add - Add a user to your ignore list on a server - - - - &reftitle.description; - - voidircg_ignore_add - resourceconnection - stringnick - - - This function adds user nick to the ignore list of - the connection. Afterwards, IRCG will suppress all - messages from this user through the associated connection. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - nick - - - The user to be ignored. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - ircg_ignore_del - - - - - - - diff --git a/reference/ircg/functions/ircg-ignore-del.xml b/reference/ircg/functions/ircg-ignore-del.xml deleted file mode 100644 index fd73ee3882..0000000000 --- a/reference/ircg/functions/ircg-ignore-del.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - ircg_ignore_del - Remove a user from your ignore list on a server - - - - &reftitle.description; - - boolircg_ignore_del - resourceconnection - stringnick - - - This function removes user nick from the IRCG - ignore list associated with connection. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - nick - - - The user nick name. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - &reftitle.seealso; - - - ircg_ignore_add - - - - - - - diff --git a/reference/ircg/functions/ircg-invite.xml b/reference/ircg/functions/ircg-invite.xml deleted file mode 100644 index 90f0e68c67..0000000000 --- a/reference/ircg/functions/ircg-invite.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - ircg_invite - Invites nickname to channel - - - - &reftitle.description; - - boolircg_invite - resourceconnection - stringchannel - stringnickname - - - ircg_invite will send an invitation to the - user nickname, prompting him to join the given - channel. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - channel - - - The channel name as #name. - - - - - nickname - - - The user nick name. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ircg/functions/ircg-is-conn-alive.xml b/reference/ircg/functions/ircg-is-conn-alive.xml deleted file mode 100644 index 6652c4d04c..0000000000 --- a/reference/ircg/functions/ircg-is-conn-alive.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - ircg_is_conn_alive - Check connection status - - - - &reftitle.description; - - boolircg_is_conn_alive - resourceconnection - - - ircg_is_conn_alive checks the - connection status. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; if connection is still alive and - working or &false;, if the connection has died for some reason. - - - - - - diff --git a/reference/ircg/functions/ircg-join.xml b/reference/ircg/functions/ircg-join.xml deleted file mode 100644 index 263491b1d9..0000000000 --- a/reference/ircg/functions/ircg-join.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - ircg_join - Join a channel on a connected server - - - - &reftitle.description; - - boolircg_join - resourceconnection - stringchannel - stringkey - - - Join the channel channel on the server - connected to by connection. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - channel - - - The channel name as #name. - - - - - key - - - An optional password for the room. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ircg/functions/ircg-kick.xml b/reference/ircg/functions/ircg-kick.xml deleted file mode 100644 index 403608c0bd..0000000000 --- a/reference/ircg/functions/ircg-kick.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - ircg_kick - Kick a user out of a channel on server - - - - &reftitle.description; - - boolircg_kick - resourceconnection - stringchannel - stringnick - stringreason - - - Kick user nick from - channel on server connected to by - connection. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - channel - - - The channel name as #name. - - - - - nick - - - The user to be kicked. - - - - - reason - - - reason should give a short message describing - why this action was performed. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ircg/functions/ircg-list.xml b/reference/ircg/functions/ircg-list.xml deleted file mode 100644 index 8d080196ba..0000000000 --- a/reference/ircg/functions/ircg-list.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - ircg_list - List topic/user count of channel(s) - - - - &reftitle.description; - - boolircg_list - resourceconnection - stringchannel - - - ircg_list will request a list of users in the - channel. The answer is sent to the output - defined by ircg_set_file or - ircg_set_current. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - channel - - - The channel name as #name. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>ircg_list</function> example - -"; -} - -// send list command -ircg_list($id, $channel); - -// wait for output to arrive -sleep(5); - -// disconnect -ircg_disconnect($id,'Bye World'); - -// output everything -readfile('irc_output.html'); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - ircg_set_file - ircg_set_current - ircg_who - - - - - - - diff --git a/reference/ircg/functions/ircg-lookup-format-messages.xml b/reference/ircg/functions/ircg-lookup-format-messages.xml deleted file mode 100644 index 4cd53c9f3d..0000000000 --- a/reference/ircg/functions/ircg-lookup-format-messages.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - ircg_lookup_format_messages - Check for the existence of a format message set - - - - &reftitle.description; - - boolircg_lookup_format_messages - stringname - - - Check for the existence of the format message set - name. Sets may be registered with - ircg_register_format_messages, a default set - named ircg is always available. - - - - - &reftitle.parameters; - - - - name - - - The format message set name. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the set exists, &false; otherwise. - - - - - &reftitle.seealso; - - - ircg_register_format_messages - - - - - - - diff --git a/reference/ircg/functions/ircg-lusers.xml b/reference/ircg/functions/ircg-lusers.xml deleted file mode 100644 index 23377476ec..0000000000 --- a/reference/ircg/functions/ircg-lusers.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - ircg_lusers - IRC network statistics - - - - &reftitle.description; - - boolircg_lusers - resourceconnection - - - ircg_lusers will request a statistical - breakdown of users on the network connected to on - connection. The answer is sent to the - output defined by ircg_set_file or - ircg_set_current. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ircg_set_file - ircg_set_current - ircg_who - - - - - - - diff --git a/reference/ircg/functions/ircg-msg.xml b/reference/ircg/functions/ircg-msg.xml deleted file mode 100644 index 885163b152..0000000000 --- a/reference/ircg/functions/ircg-msg.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - ircg_msg - Send message to channel or user on server - - - - &reftitle.description; - - boolircg_msg - resourceconnection - stringrecipient - stringmessage - boolsuppress - - - ircg_msg will send the message to a channel - or user on the server. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - recipient - - - - - A recipient starting with # - or & will send the - message to a channel, anything else will be - interpreted as a username. - - - - - message - - - The message to be sent. - - - - - suppress - - - Setting the optional parameter suppress to - a &true; value will suppress output of your message to your own - connection. This so-called loopback is - necessary, because the IRC server does not echo PRIVMSG commands - back to us. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ircg/functions/ircg-names.xml b/reference/ircg/functions/ircg-names.xml deleted file mode 100644 index 55beb01de1..0000000000 --- a/reference/ircg/functions/ircg-names.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - ircg_names - Query visible usernames - - - - &reftitle.description; - - boolircg_names - intconnection - stringchannel - stringtarget - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - channel - - - The channel name as #name. - - - - - target - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ircg_get_username - ircg_lusers - - - - - - - diff --git a/reference/ircg/functions/ircg-nick.xml b/reference/ircg/functions/ircg-nick.xml deleted file mode 100644 index 0b82777d42..0000000000 --- a/reference/ircg/functions/ircg-nick.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - ircg_nick - Change nickname on server - - - - &reftitle.description; - - boolircg_nick - resourceconnection - stringnick - - - Change your nickname on the given connection to the - specified one, if possible. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - nick - - - The new nick name for the current user. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ircg/functions/ircg-nickname-escape.xml b/reference/ircg/functions/ircg-nickname-escape.xml deleted file mode 100644 index 7b70c0dbbc..0000000000 --- a/reference/ircg/functions/ircg-nickname-escape.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - ircg_nickname_escape - Encode special characters in nickname to be IRC-compliant - - - - &reftitle.description; - - stringircg_nickname_escape - stringnick - - - Function ircg_nickname_escape returns an encoded - nickname specified by nick which is IRC-compliant. - - - - - &reftitle.parameters; - - - - nick - - - - - - - - - - - &reftitle.returnvalues; - - An IRC-compliant nick name. - - - - - - &reftitle.seealso; - - - ircg_nickname_unescape - - - - - - - diff --git a/reference/ircg/functions/ircg-nickname-unescape.xml b/reference/ircg/functions/ircg-nickname-unescape.xml deleted file mode 100644 index fe4622bcef..0000000000 --- a/reference/ircg/functions/ircg-nickname-unescape.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - ircg_nickname_unescape - Decodes encoded nickname - - - - &reftitle.description; - - stringircg_nickname_unescape - stringnick - - - Function ircg_nickname_unescape returns a - decoded nickname, which is specified in nick. - - - - - &reftitle.parameters; - - - - nick - - - The encoded nick name. - - - - - - - - - &reftitle.returnvalues; - - Returns the decoded nick name. - - - - - &reftitle.seealso; - - - ircg_nickname_escape - - - - - - - diff --git a/reference/ircg/functions/ircg-notice.xml b/reference/ircg/functions/ircg-notice.xml deleted file mode 100644 index 9a61776d08..0000000000 --- a/reference/ircg/functions/ircg-notice.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - ircg_notice - Send a notice to a user on server - - - - &reftitle.description; - - boolircg_notice - resourceconnection - stringnick - stringmessage - - - This function will send the message text - to the user nick on the server connected - to by connection. IRC servers and other - software will not automatically generate replies to NOTICEs - in contrast to other message types. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - nick - - - The destination user. - - - - - message - - - The message contents. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ircg/functions/ircg-oper.xml b/reference/ircg/functions/ircg-oper.xml deleted file mode 100644 index 135e47c145..0000000000 --- a/reference/ircg/functions/ircg-oper.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - ircg_oper - Elevates privileges to IRC OPER - - - - &reftitle.description; - - boolircg_oper - resourceconnection - stringname - stringpassword - - - ircg_oper will authenticate the logged in user - on connection as an IRC operator. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - name - - - The operator account name. Must be a registered IRC account. - - - - - password - - - The password associated with name. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ircg/functions/ircg-part.xml b/reference/ircg/functions/ircg-part.xml deleted file mode 100644 index ebdfc63ad5..0000000000 --- a/reference/ircg/functions/ircg-part.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - ircg_part - Leave a channel on server - - - - &reftitle.description; - - boolircg_part - resourceconnection - stringchannel - - - Leave the channel channel on the server - connected to by connection. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - channel - - - The channel name as #name. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ircg/functions/ircg-pconnect.xml b/reference/ircg/functions/ircg-pconnect.xml deleted file mode 100644 index 5a2f8b4fce..0000000000 --- a/reference/ircg/functions/ircg-pconnect.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - ircg_pconnect - Connect to an IRC server - - - - &reftitle.description; - - resourceircg_pconnect - stringusername - stringserver_ip - intserver_port - stringmsg_format - arrayctcp_messages - arrayuser_settings - boolbailout_on_trivial - - - ircg_pconnect will try to establish a connection to - an IRC server. - - - - - &reftitle.parameters; - - - - username - - - The initial nickname on the server. - - - - - server_ip - - - The IRC server address. - - - server_ip must be an IP address in numerical - form. DNS lookups are expensive and should be done in the context of - IRCG. Default to 127.0.0.1. - - - - - server_port - - - The server port number. Default to 6667. - - - - - msg_format - - - You can customize the output of IRC messages and events by selecting a - format message set previously created with - ircg_register_format_messages by specifying - the set's name in msg_format. - - - - - ctcp_messages - - - 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 - ctcp_messages. The keys of the array - are the CTCP type and the respective value is the format message. - - - - - user_settings - - - You can define "ident", "password", and "realname" tokens which - are sent to the IRC server by setting these in this associative - array. - - - - - bailout_on_trivial - - - - - - - - - - - &reftitle.returnvalues; - - Returns a connection resource handle for further use, or &false; on error. - - - - - &reftitle.seealso; - - - ircg_disconnect - ircg_is_conn_alive - ircg_register_format_messages - - - - - - - diff --git a/reference/ircg/functions/ircg-register-format-messages.xml b/reference/ircg/functions/ircg-register-format-messages.xml deleted file mode 100644 index 6b03acd529..0000000000 --- a/reference/ircg/functions/ircg-register-format-messages.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - ircg_register_format_messages - Register a format message set - - - - &reftitle.description; - - boolircg_register_format_messages - stringname - arraymessages - - - With ircg_register_format_messages you can - customize the way your IRC output looks like or which script - functions are invoked on the client side. - - - - - &reftitle.parameters; - - - - name - - - - - - - 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 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 - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ircg_lookup_format_messages - - - - - - - diff --git a/reference/ircg/functions/ircg-set-current.xml b/reference/ircg/functions/ircg-set-current.xml deleted file mode 100644 index 5467c89c91..0000000000 --- a/reference/ircg/functions/ircg-set-current.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - ircg_set_current - Set current connection for output - - - - &reftitle.description; - - boolircg_set_current - resourceconnection - - - Select the current HTTP 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 formatting or a format message set - specified by ircg_register_format_messages. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ircg_register_format_messages - - - - - - - diff --git a/reference/ircg/functions/ircg-set-file.xml b/reference/ircg/functions/ircg-set-file.xml deleted file mode 100644 index 7125d2debc..0000000000 --- a/reference/ircg/functions/ircg-set-file.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - ircg_set_file - Set logfile for connection - - - - &reftitle.description; - - boolircg_set_file - resourceconnection - stringpath - - - ircg_set_file specifies a logfile in which all output - from the current connection will be logged. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - path - - - Path to the logfile. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ircg/functions/ircg-set-on-die.xml b/reference/ircg/functions/ircg-set-on-die.xml deleted file mode 100644 index ac388c3709..0000000000 --- a/reference/ircg/functions/ircg-set-on-die.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - ircg_set_on_die - Set action to be executed when connection dies - - - - &reftitle.description; - - boolircg_set_on_die - resourceconnection - stringhost - intport - stringdata - - - In case of the termination of the connection, IRCG - will connect to the specified host, send - data 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. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - host - - - This must be an IPv4 address as IRCG does not resolve host-names due - to blocking issues. - - - - - port - - - The port number. - - - - - data - - - The data to be sent before closing the connection. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - - - This feature requires IRCG 3. - - - - - - - diff --git a/reference/ircg/functions/ircg-topic.xml b/reference/ircg/functions/ircg-topic.xml deleted file mode 100644 index a8346da1e0..0000000000 --- a/reference/ircg/functions/ircg-topic.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - ircg_topic - Set topic for channel on server - - - - &reftitle.description; - - boolircg_topic - resourceconnection - stringchannel - stringnew_topic - - - Change the topic for the channel. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - channel - - - The channel name as #name. - - - - - new_topic - - - The new topic to be set. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ircg/functions/ircg-who.xml b/reference/ircg/functions/ircg-who.xml deleted file mode 100644 index 08b641cc5f..0000000000 --- a/reference/ircg/functions/ircg-who.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - ircg_who - Queries server for WHO information - - - - &reftitle.description; - - boolircg_who - resourceconnection - stringmask - boolops_only - - - ircg_who will request a list of users - whose nickname is matching the given mask. - - - The answer is sent to the output defined by - ircg_set_file or - ircg_set_current. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - mask - - - A mask for the nickname. - - - - - ops_only - - - The optional parameter ops_only will shrink the - list to server operators only. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - ircg_set_file - ircg_set_current - - - - - - - diff --git a/reference/ircg/functions/ircg-whois.xml b/reference/ircg/functions/ircg-whois.xml deleted file mode 100644 index 3650c42e58..0000000000 --- a/reference/ircg/functions/ircg-whois.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - ircg_whois - Query server for user information - - - - &reftitle.description; - - boolircg_whois - resourceconnection - stringnick - - - Sends a query to ask for information about the specified user. - - - - - &reftitle.parameters; - - - - connection - - - A connection resource handle returned by - ircg_pconnect. - - - - - nick - - - The user nick name. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/ircg/reference.xml b/reference/ircg/reference.xml deleted file mode 100644 index a4368041e0..0000000000 --- a/reference/ircg/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - IRC Gateway &Functions; - -&reference.ircg.entities.functions; - - - - diff --git a/reference/ircg/setup.xml b/reference/ircg/setup.xml deleted file mode 100644 index 775974d37a..0000000000 --- a/reference/ircg/setup.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - &reftitle.setup; - - -
- &reftitle.required; - &no.requirement; -
- - - - &reference.ircg.configure; - - - -
- &reftitle.runtime; - &no.config; -
- - - -
- &reftitle.resources; - &no.resource; -
- - - - - -