georg Wed Mar 20 15:12:22 2002 EDT
Modified files:
/phpdoc/de/functions ircg.xml
Log:
Inserted ucn for ircg_pconnect, reformatting and typos
Index: phpdoc/de/functions/ircg.xml
diff -u phpdoc/de/functions/ircg.xml:1.9 phpdoc/de/functions/ircg.xml:1.10
--- phpdoc/de/functions/ircg.xml:1.9 Wed Feb 13 16:54:16 2002
+++ phpdoc/de/functions/ircg.xml Wed Mar 20 15:12:20 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
<reference id="ref.ircg">
<title>IRC Gateway Funktionen</title>
<titleabbrev>IRC Gateway</titleabbrev>
@@ -45,7 +45,8 @@
<section id="ircg.install">
<title>Installation</title>
<para>
- Eine ausführliche Installationsanleitung befindet sich <ulink
url="&url.ircg-install;">hier</ulink>.
+ Eine ausführliche Installationsanleitung befindet sich <ulink
+ url="&url.ircg-install;">hier</ulink>.
</para>
</section>
</partintro>
@@ -54,7 +55,7 @@
<refnamediv>
<refname>ircg_pconnect</refname>
<refpurpose>
- Verbindung zum IRC-Server aufbauen
+ Verbindung zum IRC-Server aufbauen
</refpurpose>
</refnamediv>
<refsect1>
@@ -69,32 +70,43 @@
<methodparam
choice="opt"><type>array</type><parameter>user_settings</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ircg_pconnect</function>
-
- Stellt eine Verbindung zum einem IRC Server her, und liefert eine
Verbindunskennung.
- </para>
- <para>
- Der Parameter <parameter>username</parameter> muss angeben werden, er
legt den Benutzernamen auf dem Server fest.
- <parameter>server_ip</parameter> und
<parameter>server_port</parameter> sind optional. Werden diese nicht angegben wird für
<parameter>server_ip</parameter> der Wert 127.0.0.1 (localhost) und für
<parameter>server_port</parameter> der Wert 6667 gesetzt.
- <note>
- <para>
- Der Parameter <parameter>server_ip</parameter> muss aus einer
IP-Adresse in numerischer Form bestehen.
- </para>
- </note>
- </para>
- <para>
- Die Ausgabe der IRC Meldungen und Ereignisse wird mit einem
formatierten String, der vor dem Aufruf mit der Funktion
<function>ircg_register_format_messages</function> im Parameter
<parameter>msg_format</parameter> definiert.
- </para>
- <para>
- <parameter>ctcp_messages</parameter>
- </para>
- <para>
- <parameter>user_settings</parameter>
- </para>
+ <function>ircg_pconnect</function>
+ Stellt eine Verbindung zum einem IRC Server her, und liefert eine
+Verbindunskennung.
+ </para>
+ <para>
+ Der Parameter <parameter>username</parameter> muss angeben
+ werden, er legt den Benutzernamen auf dem Server
+ fest. <parameter>server_ip</parameter> und
+ <parameter>server_port</parameter> sind optional. Werden diese
+ nicht angegben wird für <parameter>server_ip</parameter> der
+ Wert 127.0.0.1 (localhost) und für
+ <parameter>server_port</parameter> der Wert 6667 gesetzt.
+ <note>
+ <para>
+ Der Parameter <parameter>server_ip</parameter> muss aus einer IP-Adresse in
+numerischer Form bestehen.
+ </para>
+ <para>
+ Momentan gibt die Funktion <function>ircg_pconnect</function>
+ unabhängig davon, ob eine Verbindung zu Stande kam oder nicht,
+ einen gültigen Wert zurück.
+ </note>
+ </para>
+ <para>
+ Die Ausgabe der IRC Meldungen und Ereignisse wird mit einem
+ formatierten String, der vor dem Aufruf mit der Funktion
+ <function>ircg_register_format_messages</function> im Parameter
+ <parameter>msg_format</parameter> definiert.
+ </para>
+ <para>
+ <parameter>ctcp_messages</parameter>
+ </para>
+ <para>
+ <parameter>user_settings</parameter>
+ </para>
<para>
Siehe auch: <function>ircg_disconnect</function>,
- <function>ircg_is_conn_alive</function>,
- <function>ircg_register_format_messages</function>.
+ <function>ircg_is_conn_alive</function>,
+ <function>ircg_register_format_messages</function>.
</para>
</refsect1>
</refentry>
@@ -102,7 +114,7 @@
<refnamediv>
<refname>ircg_fetch_error_msg</refname>
<refpurpose>
- Liefert den Fehler des letzten ircg Funktionsaufrufes.
+ Liefert den Fehler des letzten ircg Funktionsaufrufes.
</refpurpose>
</refnamediv>
<refsect1>
@@ -112,14 +124,14 @@
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ircg_fetch_error_msg</function>
+ <function>ircg_fetch_error_msg</function>
Liefet den Fehler der Verbindung <parameter>connection</parameter> der letzten
aufgerufenen ircg Funktion zurück.
</para>
- <note>
- <para>
- Die Fehlernummer wird im ersten Element des Arrays zurückgeliefert,
der Fehlertext im zweiten Parameter.
- </para>
- </note>
+ <note>
+ <para>
+ Die Fehlernummer wird im ersten Element des Arrays zurückgeliefert, der Fehlertext
+im zweiten Parameter.
+ </para>
+ </note>
<para>
<example>
<title><function>ircg_fetch_error_msg</function> Beispiel</title>
@@ -137,7 +149,7 @@
<refnamediv>
<refname>ircg_set_current</refname>
<refpurpose>
- Setzt die Verbindung für die Ausgabe der IRC-Server Meldungen
+ Setzt die Verbindung für die Ausgabe der IRC-Server Meldungen
</refpurpose>
</refnamediv>
<refsect1>
@@ -147,11 +159,16 @@
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
- Setzt die Verbindung für die Ausgabe. Alle Meldungen des verbundenen
IRC-Servers, der über den Parameter <parameter>connection</parameter> spezifiziert
wurde, werden über die in der Funktion
<function>ircg_register_format_messages</function> angegebenen Formatierungen
ausgegeben.
+ Setzt die Verbindung für die Ausgabe. Alle Meldungen des
+ verbundenen IRC-Servers, der über den Parameter
+ <parameter>connection</parameter> spezifiziert wurde, werden über
+ die in der Funktion
+ <function>ircg_register_format_messages</function> angegebenen
+ Formatierungen ausgegeben.
</para>
<para>
- Siehe auch: <function>ircg_register_format_messages</function> and
- <function>ircg_lookup_format_messages</function>.
+ Siehe auch: <function>ircg_register_format_messages</function>
+ and <function>ircg_lookup_format_messages</function>.
</para>
</refsect1>
</refentry>
@@ -160,7 +177,7 @@
<refnamediv>
<refname>ircg_join</refname>
<refpurpose>
- Einen Channel auf dem verbundenen IRC-Server betreten
+ Einen Channel auf dem verbundenen IRC-Server betreten
</refpurpose>
</refnamediv>
<refsect1>
@@ -168,10 +185,10 @@
<methodsynopsis>
<type>boolean</type><methodname>ircg_join</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
-
<methodparam><type>string</type><parameter>channel</parameter></methodparam>
+ <methodparam><type>string</type><parameter>channel</parameter></methodparam>
</methodsynopsis>
<para>
- Betritt den Channel <parameter>channel</parameter> auf dem IRC-Server
<parameter>connection</parameter>.
+ Betritt den Channel <parameter>channel</parameter> auf dem IRC-Server
+<parameter>connection</parameter>.
</para>
<para>
Siehe auch:
@@ -183,7 +200,7 @@
<refnamediv>
<refname>ircg_part</refname>
<refpurpose>
- Einen Channel auf dem IRC-Server verlassen
+ Einen Channel auf dem IRC-Server verlassen
</refpurpose>
</refnamediv>
<refsect1>
@@ -191,10 +208,11 @@
<methodsynopsis>
<type>boolean</type><methodname>ircg_part</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
-
<methodparam><type>string</type><parameter>channel</parameter></methodparam>
+ <methodparam><type>string</type><parameter>channel</parameter></methodparam>
</methodsynopsis>
<para>
- Verlässt den Channel <parameter>channel</parameter> auf dem IRC-Server
<parameter>connection</parameter>.
+ Verlässt den Channel <parameter>channel</parameter> auf dem
+ IRC-Server <parameter>connection</parameter>.
</para>
<para>
Siehe auch:
@@ -206,7 +224,7 @@
<refnamediv>
<refname>ircg_msg</refname>
<refpurpose>
- Sendet eine Nachricht an einen Channel oder Benutzer
+ Sendet eine Nachricht an einen Channel oder Benutzer
</refpurpose>
</refnamediv>
<refsect1>
@@ -214,15 +232,23 @@
<methodsynopsis>
<type>boolean</type><methodname>ircg_msg</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
-
<methodparam><type>string</type><parameter>recipient</parameter></methodparam>
-
<methodparam><type>string</type><parameter>message</parameter></methodparam>
- <methodparam
choice="opt"><type>boolean</type><parameter>suppress</parameter></methodparam>
- </methodsynopsis>
- <para>
- <function>ircg_msg</function> sendet eine Nachricht an einen Channel oder
Benutzer auf dem IRC-Server <parameter>connection</parameter>. Der Parameter
<parameter>recipient</parameter>, beginnend mit einem <literal>#</literal> oder
<literal>&</literal> sendet die Nachricht an einen Channel, andere Angaben werden
als Benutzername interpretiert.
- </para>
- <para>
- Wird der optionale Parameter <parameter>suppress</parameter> auf
&true; gesetzt, wird die Ausgabe der Nachricht auf der eigenen Verbindung unterbunden.
+ <methodparam><type>string</type><parameter>recipient</parameter></methodparam>
+ <methodparam><type>string</type><parameter>message</parameter></methodparam>
+ <methodparam
+choice="opt"><type>boolean</type><parameter>suppress</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>ircg_msg</function> sendet eine Nachricht an einen
+ Channel oder Benutzer auf dem IRC-Server
+ <parameter>connection</parameter>. Der Parameter
+ <parameter>recipient</parameter>, beginnend mit einem
+ <literal>#</literal> oder <literal>&</literal> sendet die
+ Nachricht an einen Channel, andere Angaben werden als Benutzername
+ interpretiert.
+ </para>
+ <para>
+ Wird der optionale Parameter <parameter>suppress</parameter> auf
+ &true; gesetzt, wird die Ausgabe der Nachricht auf der eigenen
+ Verbindung unterbunden.
</para>
</refsect1>
</refentry>
@@ -231,7 +257,7 @@
<refnamediv>
<refname>ircg_notice</refname>
<refpurpose>
- Sendet eine Notiz zu einem anderen Benutzer
+ Sendet eine Notiz zu einem anderen Benutzer
</refpurpose>
</refnamediv>
<refsect1>
@@ -239,14 +265,14 @@
<methodsynopsis>
<type>boolean</type><methodname>ircg_notice</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
- <methodparam><type>string</type><parameter/></methodparam>
-
<methodparam><type>string</type><parameter>message</parameter></methodparam>
+ <methodparam><type>string</type><parameter/></methodparam>
+ <methodparam><type>string</type><parameter>message</parameter></methodparam>
</methodsynopsis>
<para>
- Sendet eine Nachricht <parameter>message</parameter> zum angegebenen
- Benutzer <parameter>nick</parameter> auf dem verbunden IRC-Server
- <parameter>connection</parameter>. Der genaue Unterschied
- zwischen einer Nachricht und einer Notiz ist dem IRC-Manual zu
entnehmen.
+ Sendet eine Nachricht <parameter>message</parameter> zum angegebenen
+ Benutzer <parameter>nick</parameter> auf dem verbunden IRC-Server
+ <parameter>connection</parameter>. Der genaue Unterschied
+ zwischen einer Nachricht und einer Notiz ist dem IRC-Manual zu entnehmen.
</para>
<para>
Siehe auch:
@@ -258,7 +284,7 @@
<refnamediv>
<refname>ircg_nick</refname>
<refpurpose>
- ändert den Benutzernamen auf dem IRC-Server
+ ändert den Benutzernamen auf dem IRC-Server
</refpurpose>
</refnamediv>
<refsect1>
@@ -266,13 +292,13 @@
<methodsynopsis>
<type>boolean</type><methodname>ircg_nick</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
- <methodparam><type>string</type><parameter>nick</parameter></methodparam>
+ <methodparam><type>string</type><parameter>nick</parameter></methodparam>
</methodsynopsis>
<para>
- Ändert den Benutzernamen auf dem IRC-Server
<parameter>connection</parameter> auf den neuen Benutzernamen
<parameter>nick</parameter>.
+ Ändert den Benutzernamen auf dem IRC-Server <parameter>connection</parameter> auf
+den neuen Benutzernamen <parameter>nick</parameter>.
</para>
<para>
- liefert bei erfolgreicher Änderung &true; oder &false; falls der name
nicht geändert werden konnte.
+ liefert bei erfolgreicher Änderung &true; oder &false; falls der name nicht
+geändert werden konnte.
</para>
</refsect1>
</refentry>
@@ -281,7 +307,7 @@
<refnamediv>
<refname>ircg_topic</refname>
<refpurpose>
- Setzt das Thema für einen Channel
+ Setzt das Thema für einen Channel
</refpurpose>
</refnamediv>
<refsect1>
@@ -289,13 +315,13 @@
<methodsynopsis>
<type>boolean</type><methodname>ircg_topic</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
-
<methodparam><type>string</type><parameter>channel</parameter></methodparam>
-
<methodparam><type>string</type><parameter>new_topic</parameter></methodparam>
+ <methodparam><type>string</type><parameter>channel</parameter></methodparam>
+ <methodparam><type>string</type><parameter>new_topic</parameter></methodparam>
</methodsynopsis>
<para>
- Ändert das Thema (Topic) für den Channel <parameter>channel</parameter> des
- verbundenen IRC-Servers <parameter>connection</parameter> in
- <parameter>new_topic</parameter>.
+ Ändert das Thema (Topic) für den Channel <parameter>channel</parameter> des
+ verbundenen IRC-Servers <parameter>connection</parameter> in
+ <parameter>new_topic</parameter>.
</para>
</refsect1>
</refentry>
@@ -304,7 +330,7 @@
<refnamediv>
<refname>ircg_channel_mode</refname>
<refpurpose>
- Setzt die Channel Attribute für einen Benutzer
+ Setzt die Channel Attribute für einen Benutzer
</refpurpose>
</refnamediv>
<refsect1>
@@ -312,17 +338,17 @@
<methodsynopsis>
<type>boolean</type><methodname>ircg_channel_mode</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
-
<methodparam><type>string</type><parameter>channel</parameter></methodparam>
-
<methodparam><type>string</type><parameter>mode_spec</parameter></methodparam>
- <methodparam><type>string</type><parameter>nick</parameter></methodparam>
+ <methodparam><type>string</type><parameter>channel</parameter></methodparam>
+ <methodparam><type>string</type><parameter>mode_spec</parameter></methodparam>
+ <methodparam><type>string</type><parameter>nick</parameter></methodparam>
</methodsynopsis>
<para>
- Setzt die Attribute <parameter>mode_spec</parameter> in einem Channel
<parameter>channel</parameter>
+ Setzt die Attribute <parameter>mode_spec</parameter> in einem Channel
+<parameter>channel</parameter>
auf dem verbundenen Server <parameter>connection</parameter> für den
Benutzer <parameter>nick</parameter>.
</para>
- <para>
- Die Attribute werden gesetzt oder gelöscht durch Angabe eines Zeichen
verbunden mit einem Plus oder Minuszeichen. Ein Operator-Attribut beispielsweise wird
mittels '+o' gesetzt oder durch '-o' entfernt.
- </para>
+ <para>
+ Die Attribute werden gesetzt oder gelöscht durch Angabe eines Zeichen verbunden
+mit einem Plus oder Minuszeichen. Ein Operator-Attribut beispielsweise wird mittels
+'+o' gesetzt oder durch '-o' entfernt.
+ </para>
<para>
Siehe auch:
</para>
@@ -343,7 +369,9 @@
<methodparam><type>string</type><parameter>html_string</parameter></methodparam>
</methodsynopsis>
<para>
- Wandelt den HTML-String <parameter>html_string</parameter> für die Ausgabe
um. Dies ist beispielsweise sinnvoll, wenn in einem Channel über HTML oder Beispiele
diskutiert wird.
+ Wandelt den HTML-String <parameter>html_string</parameter> für
+ die Ausgabe um. Dies ist beispielsweise sinnvoll, wenn in einem
+ Channel über HTML oder Beispiele diskutiert wird.
</para>
<para>
Siehe auch: <!-- what -->
@@ -355,7 +383,7 @@
<refnamediv>
<refname>ircg_whois</refname>
<refpurpose>
- Liefert die Information über einen bestimmten Benutzer
+ Liefert die Information über einen bestimmten Benutzer
</refpurpose>
</refnamediv>
<refsect1>
@@ -363,10 +391,12 @@
<methodsynopsis>
<type>boolean</type><methodname>ircg_whois</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
- <methodparam><type>string</type><parameter>nick</parameter></methodparam>
+ <methodparam><type>string</type><parameter>nick</parameter></methodparam>
</methodsynopsis>
<para>
- Weist den verbunden IRC-Server <parameter>connection</parameter> an,
Informationen über den Benutzer <parameter>nick</parameter> anzuzeigen.
+ Weist den verbunden IRC-Server <parameter>connection</parameter>
+ an, Informationen über den Benutzer <parameter>nick</parameter>
+ anzuzeigen.
</para>
<para>
Siehe auch:
@@ -378,7 +408,7 @@
<refnamediv>
<refname>ircg_kick</refname>
<refpurpose>
- Entfernt einen Benutzer aus einem Channel
+ Entfernt einen Benutzer aus einem Channel
</refpurpose>
</refnamediv>
<refsect1>
@@ -386,12 +416,15 @@
<methodsynopsis>
<type>boolean</type><methodname>ircg_kick</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
-
<methodparam><type>string</type><parameter>channel</parameter></methodparam>
- <methodparam><type>string</type><parameter>nick</parameter></methodparam>
- <methodparam><type>string</type><parameter>reason</parameter></methodparam>
+ <methodparam><type>string</type><parameter>channel</parameter></methodparam>
+ <methodparam><type>string</type><parameter>nick</parameter></methodparam>
+ <methodparam><type>string</type><parameter>reason</parameter></methodparam>
</methodsynopsis>
<para>
- Entfernt den Benutzer <parameter>nick</parameter> vom Channel
<parameter>channel</parameter> auf dem verbundenen IRC-Server
<parameter>connection</parameter>. <parameter>reason</parameter> gibt den Grund an,
warum der User aus dem Channel geworfen wird.
+ Entfernt den Benutzer <parameter>nick</parameter> vom Channel
+ <parameter>channel</parameter> auf dem verbundenen IRC-Server
+ <parameter>connection</parameter>. <parameter>reason</parameter>
+ gibt den Grund an, warum der User aus dem Channel geworfen wird.
</para>
</refsect1>
</refentry>
@@ -400,7 +433,7 @@
<refnamediv>
<refname>ircg_ignore_add</refname>
<refpurpose>
- Fügt einen Benutzer an die Liste der zu ignorierenden Personen an.
+ Fügt einen Benutzer an die Liste der zu ignorierenden Personen an.
</refpurpose>
</refnamediv>
<refsect1>
@@ -408,10 +441,13 @@
<methodsynopsis>
<type>boolean</type><methodname>ircg_ignore_add</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
- <methodparam><type>string</type><parameter>nick</parameter></methodparam>
+ <methodparam><type>string</type><parameter>nick</parameter></methodparam>
</methodsynopsis>
<para>
- Die Function fügt den Benutzer <parameter>nick</parameter> zur persönlichen
Liste der ignorierten Benutzer auf dem verbundenen IRC-Server
<parameter>connection</parameter> hinzu. Dadurch werden von diesem Benutzer keine
Nachrichten mehr angezeigt.
+ Die Function fügt den Benutzer <parameter>nick</parameter> zur
+ persönlichen Liste der ignorierten Benutzer auf dem verbundenen
+ IRC-Server <parameter>connection</parameter> hinzu. Dadurch
+ werden von diesem Benutzer keine Nachrichten mehr angezeigt.
</para>
<para>
Siehe auch: <function>ircg_ignore_del</function> .
@@ -423,7 +459,7 @@
<refnamediv>
<refname>ircg_ignore_del</refname>
<refpurpose>
- Entfernt einen Benutzer von der Liste ignorierter Personen
+ Entfernt einen Benutzer von der Liste ignorierter Personen
</refpurpose>
</refnamediv>
<refsect1>
@@ -431,11 +467,12 @@
<methodsynopsis>
<type>boolean</type><methodname>ircg_ignore_del</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
- <methodparam><type>string</type><parameter>nick</parameter></methodparam>
+ <methodparam><type>string</type><parameter>nick</parameter></methodparam>
</methodsynopsis>
<para>
- Diese Funktion entfernt den Benutzer <parameter>nick</parameter> von
der Liste der ignorierten Personen auf dem verbunden IRC-Server
- <parameter>connection</parameter>.
+ Diese Funktion entfernt den Benutzer <parameter>nick</parameter>
+ von der Liste der ignorierten Personen auf dem verbunden IRC-Server
+ <parameter>connection</parameter>.
</para>
<para>
Siehe auch: <function>ircg_ignore_add</function>.
@@ -447,7 +484,7 @@
<refnamediv>
<refname>ircg_disconnect</refname>
<refpurpose>
- Beendet die Verbindung zum IRC-Server
+ Beendet die Verbindung zum IRC-Server
</refpurpose>
</refnamediv>
<refsect1>
@@ -455,11 +492,13 @@
<methodsynopsis>
<type>boolean</type><methodname>ircg_disconnect</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
- <methodparam><type>string</type><parameter>reason</parameter></methodparam>
+ <methodparam><type>string</type><parameter>reason</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ircg_disconnect</function> beendet die Verbindung
- <parameter>connection</parameter> zu einem IRC-Server, die mittels
der Funktion <function>ircg-pconnect</function> hergestellt wurde
+ <function>ircg_disconnect</function> beendet die Verbindung
+ <parameter>connection</parameter> zu einem IRC-Server, die
+ mittels der Funktion <function>ircg-pconnect</function>
+ hergestellt wurde
</para>
<para>
Siehe auch: <function>ircg_pconnect</function>.
@@ -471,7 +510,7 @@
<refnamediv>
<refname>ircg_is_conn_alive</refname>
<refpurpose>
- Check connection status
+ Check connection status
</refpurpose>
</refnamediv>
<refsect1>
@@ -481,8 +520,10 @@
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ircg_is_conn_alive</function> gibt den Wert &true; zurück,
-wenn die Verbindung <parameter>connection</parameter> zum IRC-Server besteht, oder
&false; falls keine gültige Verbindung mehr besteht.
+ <function>ircg_is_conn_alive</function> gibt den Wert &true;
+ zurück, wenn die Verbindung <parameter>connection</parameter> zum
+ IRC-Server besteht, oder &false; falls keine gültige Verbindung
+ mehr besteht.
</para>
</refsect1>
</refentry>
@@ -491,7 +532,7 @@
<refnamediv>
<refname>ircg_lookup_format_messages</refname>
<refpurpose>
- Wählt ein Format für die Ausgabe von IRC-Nachrichten und Ereignissen aus.
+ Wählt ein Format für die Ausgabe von IRC-Nachrichten und Ereignissen aus.
</refpurpose>
</refnamediv>
<refsect1>
@@ -501,7 +542,11 @@
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
- Wählt ein über die Funktion <function>ircg_register_format</function>
definiertes Format <parameter>string</parameter> zur Formatierung der Ausgabe von
IRC-Server Nachrichten und Ereignissen aus. Unter dem Namen <literal>ircg</literal>
steht ein Standardformat zur Verfügung.
+ Wählt ein über die Funktion
+ <function>ircg_register_format</function> definiertes Format
+ <parameter>string</parameter> zur Formatierung der Ausgabe von
+ IRC-Server Nachrichten und Ereignissen aus. Unter dem Namen
+ <literal>ircg</literal> steht ein Standardformat zur Verfügung.
</para>
<para>
Siehe auch: <function>ircg_register_format_messages</function>
@@ -513,8 +558,8 @@
<refnamediv>
<refname>ircg_register_format_messages</refname>
<refpurpose>
- Registriert die Ausgabeformatierungen für Nachrichten und Ereignisse
- vom IRC-Server
+ Registriert die Ausgabeformatierungen für Nachrichten und
+ Ereignisse vom IRC-Server
</refpurpose>
</refnamediv>
<refsect1>
@@ -525,57 +570,79 @@
<methodparam><type>array</type><parameter>messages</parameter></methodparam>
</methodsynopsis>
<para>
- Mit der Funktion <function>ircg_register_format_messages</function>
- kann die Formatierung der Ausgabe von IRC-Servermeldungen und
- -ereignissen festgelegt werden. Dabei ist es möglich mehrere
- Formate (Layer) zu definieren, die mit der Funktion
- <function>ircg_lookup_format_messages</function> ausgewählt werden
- können.
- </para>
- <para>
- Die Funktionen für die Ausgabe werden in dem Array
- <parameter>messages</parameter> in folgender Reihenfolge
- übergeben:
- <itemizedlist>
- <listitem><simpara>Nachricht an den
Channel</simpara></listitem>
- <listitem><simpara>Erhalten einer privaten
Nachricht</simpara></listitem>
- <listitem><simpara>Private Nachricht
gesendet</simpara></listitem>
- <listitem><simpara>Ein Benutzer verlässt den
Channel</simpara></listitem>
- <listitem><simpara>Ein Benutzer betritt den
Channel</simpara></listitem>
- <listitem><simpara>Ein Benutzer wurde aus dem Channel geworfen
(gekicked)</simpara></listitem>
- <listitem><simpara>Thema (Topic) des Channels hat sich
geändert</simpara></listitem>
- <listitem><simpara>Fehler</simpara></listitem>
- <listitem><simpara>schwerer Fehler</simpara></listitem>
- <listitem><simpara>Ende der Benutzerliste (wird beim Betreten
eines Channels gesendet)</simpara></listitem>
- <listitem><simpara>Meldung beim eigenen Betreten eines
Channels</simpara></listitem>
- <listitem><simpara>Ein Benutzer ändert seinen
Namen</simpara></listitem>
- <listitem><simpara>Ein Benutzer beendet die Verbindung zum
IRC-Server</simpara></listitem>
- <listitem><simpara>Eine grössere Anzahl von Benutzern betritt
den Channel (z.B. Bei netsplit/join)</simpara></listitem>
- <listitem><simpara>Ein Benutzer aus der Liste bei massenhaftem
Betreten eines Channels</simpara></listitem>
- <listitem><simpara>Ende des massenhaften Betretens eines
Channels</simpara></listitem>
- <listitem><simpara>Benutzerinformation</simpara></listitem>
- <listitem><simpara>Serverinformation</simpara></listitem>
- <listitem><simpara>Information über
Inaktivität</simpara></listitem>
- <listitem><simpara>Information über den
Channel</simpara></listitem>
- <listitem><simpara>Ende Meldung bei Information über Channel
(Listenende)</simpara></listitem>
- <listitem><simpara>Benachrichtigung über Änderung des
voice-Attributs</simpara></listitem>
- <listitem><simpara>Benachrichtung über Änderung des
Operator-Attributs</simpara></listitem>
- <listitem><simpara>für den Channel gesperrter
Benutzer</simpara></listitem>
- <listitem><simpara>Ende der Liste gesperrter
Benutzer</simpara></listitem>
- </itemizedlist>
- <itemizedlist>
- <listitem><simpara>%f - von</simpara></listitem>
- <listitem><simpara>%t - an</simpara></listitem>
- <listitem><simpara>%c - channel</simpara></listitem>
- <listitem><simpara>%r - vollständige
Nachricht</simpara></listitem>
- <listitem><simpara>%m - umgewandelte
Nachricht</simpara></listitem>
- <listitem><simpara>%j - für Javascript umgewandelte
Nachricht</simpara></listitem>
- </itemizedlist>
- <itemizedlist>
- <listitem><simpara>1 - mod encode</simpara></listitem>
- <listitem><simpara>2 - decodierter
Benutzername</simpara></listitem>
- </itemizedlist>
- </para>
+ Mit der Funktion
+ <function>ircg_register_format_messages</function> kann die
+ Formatierung der Ausgabe von IRC-Servermeldungen und -ereignissen
+ festgelegt werden. Dabei ist es möglich mehrere Formate (Layer) zu
+ definieren, die mit der
+ Funktion<function>ircg_lookup_format_messages</function>
+ ausgewählt werden
+ können.
+ </para>
+ <para>
+ Die Funktionen für die Ausgabe werden in dem Array
+ <parameter>messages</parameter> in folgender Reihenfolge
+ übergeben:
+ <itemizedlist>
+ <listitem><simpara>Nachricht an den Channel</simpara></listitem>
+ <listitem><simpara>Erhalten einer privaten
+ Nachricht</simpara></listitem>
+ <listitem><simpara>Private Nachricht
+ gesendet</simpara></listitem>
+ <listitem><simpara>Ein Benutzer verlässt den
+ Channel</simpara></listitem>
+ <listitem><simpara>Ein Benutzer betritt den
+ Channel</simpara></listitem>
+ <listitem><simpara>Ein Benutzer wurde aus dem Channel geworfen
+ (gekicked)</simpara></listitem>
+ <listitem><simpara>Thema (Topic) des Channels hat sich
+ geändert</simpara></listitem>
+ <listitem><simpara>Fehler</simpara></listitem>
+ <listitem><simpara>schwerer Fehler</simpara></listitem>
+ <listitem><simpara>Ende der Benutzerliste (wird beim Betreten
+ eines Channels gesendet)</simpara></listitem>
+ <listitem><simpara>Meldung beim eigenen Betreten eines
+ Channels</simpara></listitem>
+ <listitem><simpara>Ein Benutzer ändert seinen
+ Namen</simpara></listitem>
+ <listitem><simpara>Ein Benutzer beendet die Verbindung zum
+ IRC-Server</simpara></listitem>
+ <listitem><simpara>Eine grössere Anzahl von Benutzern betritt
+ den Channel (z.B. Bei netsplit/join)</simpara></listitem>
+ <listitem><simpara>Ein Benutzer aus der Liste bei massenhaftem
+ Betreten eines Channels</simpara></listitem>
+ <listitem><simpara>Ende des massenhaften Betretens eines
+ Channels</simpara></listitem>
+ <listitem><simpara>Benutzerinformation</simpara></listitem>
+ <listitem><simpara>Serverinformation</simpara></listitem>
+ <listitem><simpara>Information über
+ Inaktivität</simpara></listitem>
+ <listitem><simpara>Information über den
+ Channel</simpara></listitem>
+ <listitem><simpara>Ende Meldung bei Information über Channel
+ (Listenende)</simpara></listitem>
+ <listitem><simpara>Benachrichtigung über Änderung des
+ voice-Attributs</simpara></listitem>
+ <listitem><simpara>Benachrichtung über Änderung des
+ Operator-Attributs</simpara></listitem>
+ <listitem><simpara>für den Channel gesperrter
+ Benutzer</simpara></listitem>
+ <listitem><simpara>Ende der Liste gesperrter
+ Benutzer</simpara></listitem>
+ </itemizedlist>
+ <itemizedlist>
+ <listitem><simpara>%f - von</simpara></listitem>
+ <listitem><simpara>%t - an</simpara></listitem>
+ <listitem><simpara>%c - channel</simpara></listitem>
+ <listitem><simpara>%r - vollständige Nachricht</simpara></listitem>
+ <listitem><simpara>%m - umgewandelte Nachricht</simpara></listitem>
+ <listitem><simpara>%j - für Javascript umgewandelte
+Nachricht</simpara></listitem>
+ </itemizedlist>
+ <itemizedlist>
+ <listitem><simpara>1 - mod encode</simpara></listitem>
+ <listitem><simpara>2 - decodierter Benutzername</simpara></listitem>
+ </itemizedlist>
+ </para>
<para>
Siehe auch: <function>ircg_lookup_format_messages</function>.
</para>
@@ -601,10 +668,10 @@
<para>
Im Falle eines Verbindungsabruchs der Verbindung
<parameter>connection</parameter> sendet
- <function>ircg_set_on_die</function> auf einem Irc-Server, der über
- <parameter>host</parameter> und <parameter>port</parameter>
- (Hinweis, der Parameter <parameter>host</parameter> muss eine
- gültige IPv4-Adresse enthalten) angegeben wird,
+ <function>ircg_set_on_die</function> auf einem Irc-Server, der
+ über <parameter>host</parameter> und <parameter>port</parameter>
+ (Hinweis, der Parameter <parameter>host</parameter> muss eine
+ gültige IPv4-Adresse enthalten) angegeben wird,
die Zeichenkette <parameter>data</parameter>.
</para>
</refsect1>
