1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<reference id="ref.ircg">
<title>IRC Gateway Funktionen</title>
<titleabbrev>IRC Gateway</titleabbrev>
<partintro>
<section id="ircg.intro">
<title>Was ist ircg?</title>
<para>
IRCG ermglicht die Entwicklung schneller und skalierbarer
Webchats die ber einen privaten oder ffentlichen Webserver
kommunizieren.
</para>
</section>
<section id="ircg.platforms">
<title>Plattformen</title>
<para>
IRCG kann auf folgenden Betriebssystemen verwendet werden:
<itemizedlist>
<listitem><para>AIX</para></listitem>
<listitem><para>FreeBSD</para></listitem>
<listitem><para>HP-UX</para></listitem>
<listitem><para>Irix</para></listitem>
<listitem><para>Linux</para></listitem>
<listitem><para>Solaris</para></listitem>
<listitem><para>Tru64</para></listitem>
</itemizedlist>
</para>
</section>
<section id="ircg.requirements">
<title>Bentigte Software</title>
<para>
Um die IRCG-Funktionen zu verwenden, muss folgende Software
installiert sein:
<orderedlist>
<listitem><para><ulink url="&url.ircg;">IRCG-Library</ulink> von
Sascha Schumann.</para></listitem>
<listitem><para><ulink url="&url.st-threads;">SGI Static Threads
Library</ulink></para></listitem>
<listitem><para><ulink url="&url.thttpd;">thttpd</ulink>
webserver</para></listitem>
</orderedlist>
</para>
</section>
<section id="ircg.install">
<title>Installation</title>
<para>
Eine ausfhrliche Installationsanleitung befindet sich <ulink url="&url.ircg-install;">hier</ulink>.
</para>
</section>
</partintro>
<refentry id="function.ircg-pconnect">
<refnamediv>
<refname>ircg_pconnect</refname>
<refpurpose>
Verbindung zum IRC-Server aufbauen
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<methodsynopsis>
<type>resource</type><methodname>ircg_pconnect</methodname>
<methodparam><type>string</type><parameter>username</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>server_ip</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>server_port</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>msg_format</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>ctcp_messages</parameter></methodparam>
<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 fr <parameter>server_ip</parameter> der Wert 127.0.0.1 (localhost) und fr <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>
<para>
Siehe auch: <function>ircg_disconnect</function>,
<function>ircg_is_conn_alive</function>,
<function>ircg_register_format_messages</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.ircg-fetch-error-msg">
<refnamediv>
<refname>ircg_fetch_error_msg</refname>
<refpurpose>
Liefert den Fehler des letzten ircg Funktionsaufrufes.
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<methodsynopsis>
<type>array</type><methodname>ircg_fetch_error_msg</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>ircg_fetch_error_msg</function>
Liefet den Fehler der Verbindung <parameter>connection</parameter> der letzten aufgerufenen ircg Funktion zurck.
</para>
<note>
<para>
Die Fehlernummer wird im ersten Element des Arrays zurckgeliefert, der Fehlertext im zweiten Parameter.
</para>
</note>
<para>
<example>
<title><function>ircg_fetch_error_msg</function> Beispiel</title>
<programlisting role="php">
if (!ircg_join ($id, "#php")){
$error = ircg_fetch_error_msg($id);
print ("Can't join channel #php. Errorcode: $error[0] Description: $error[1]");
}
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<refentry id="function.ircg-set-current">
<refnamediv>
<refname>ircg_set_current</refname>
<refpurpose>
Setzt die Verbindung fr die Ausgabe der IRC-Server Meldungen
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<methodsynopsis>
<type>boolean</type><methodname>ircg_set_current</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Setzt die Verbindung fr 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>.
</para>
</refsect1>
</refentry>
<refentry id="function.ircg-join">
<refnamediv>
<refname>ircg_join</refname>
<refpurpose>
Einen Channel auf dem verbundenen IRC-Server betreten
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<methodsynopsis>
<type>boolean</type><methodname>ircg_join</methodname>
<methodparam><type>resource</type><parameter>connection</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>.
</para>
<para>
Siehe auch:
</para>
</refsect1>
</refentry>
<refentry id="function.ircg-part">
<refnamediv>
<refname>ircg_part</refname>
<refpurpose>
Einen Channel auf dem IRC-Server verlassen
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<methodsynopsis>
<type>boolean</type><methodname>ircg_part</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>channel</parameter></methodparam>
</methodsynopsis>
<para>
Verlsst den Channel <parameter>channel</parameter> auf dem IRC-Server <parameter>connection</parameter>.
</para>
<para>
Siehe auch:
</para>
</refsect1>
</refentry>
<refentry id="function.ircg-msg">
<refnamediv>
<refname>ircg_msg</refname>
<refpurpose>
Sendet eine Nachricht an einen Channel oder Benutzer
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<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.
</para>
</refsect1>
</refentry>
<refentry id="function.ircg-notice">
<refnamediv>
<refname>ircg_notice</refname>
<refpurpose>
Sendet eine Notiz zu einem anderen Benutzer
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<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>
</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.
</para>
<para>
Siehe auch:
</para>
</refsect1>
</refentry>
<refentry id="function.ircg-nick">
<refnamediv>
<refname>ircg_nick</refname>
<refpurpose>
ndert den Benutzernamen auf dem IRC-Server
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<methodsynopsis>
<type>boolean</type><methodname>ircg_nick</methodname>
<methodparam><type>resource</type><parameter>connection</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>.
</para>
<para>
liefert bei erfolgreicher nderung &true; oder &false; falls der name nicht gendert werden konnte.
</para>
</refsect1>
</refentry>
<refentry id="function.ircg-topic">
<refnamediv>
<refname>ircg_topic</refname>
<refpurpose>
Setzt das Thema fr einen Channel
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<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>
</methodsynopsis>
<para>
ndert das Thema (Topic) fr den Channel <parameter>channel</parameter> des
verbundenen IRC-Servers <parameter>connection</parameter> in
<parameter>new_topic</parameter>.
</para>
</refsect1>
</refentry>
<refentry id="function.ircg-channel_mode">
<refnamediv>
<refname>ircg_channel_mode</refname>
<refpurpose>
Setzt die Channel Attribute fr einen Benutzer
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<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>
</methodsynopsis>
<para>
Setzt die Attribute <parameter>mode_spec</parameter> in einem Channel <parameter>channel</parameter>
auf dem verbundenen Server <parameter>connection</parameter> fr den Benutzer <parameter>nick</parameter>.
</para>
<para>
Die Attribute werden gesetzt oder gelscht 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>
</refsect1>
</refentry>
<refentry id="function.ircg-html-encode">
<refnamediv>
<refname>ircg_html_encode</refname>
<refpurpose>
Wandelt einen HTML string fr die Ausgabe um
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<methodsynopsis>
<type>boolean</type><methodname>ircg_html_encode</methodname>
<methodparam><type>string</type><parameter>html_string</parameter></methodparam>
</methodsynopsis>
<para>
Wandelt den HTML-String <parameter>html_string</parameter> fr die Ausgabe um. Dies ist beispielsweise sinnvoll, wenn in einem Channel ber HTML oder Beispiele diskutiert wird.
</para>
<para>
Siehe auch: <!-- what -->
</para>
</refsect1>
</refentry>
<refentry id="function.ircg-whois">
<refnamediv>
<refname>ircg_whois</refname>
<refpurpose>
Liefert die Information ber einen bestimmten Benutzer
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<methodsynopsis>
<type>boolean</type><methodname>ircg_whois</methodname>
<methodparam><type>resource</type><parameter>connection</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.
</para>
<para>
Siehe auch:
</para>
</refsect1>
</refentry>
<refentry id="function.ircg-kick">
<refnamediv>
<refname>ircg_kick</refname>
<refpurpose>
Entfernt einen Benutzer aus einem Channel
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<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>
</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.
</para>
</refsect1>
</refentry>
<refentry id="function.ircg-ignore-add">
<refnamediv>
<refname>ircg_ignore_add</refname>
<refpurpose>
Fgt einen Benutzer an die Liste der zu ignorierenden Personen an.
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<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>
</methodsynopsis>
<para>
Die Function fgt den Benutzer <parameter>nick</parameter> zur persnlichen 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> .
</para>
</refsect1>
</refentry>
<refentry id="function.ircg-ignore-del">
<refnamediv>
<refname>ircg_ignore_del</refname>
<refpurpose>
Entfernt einen Benutzer von der Liste ignorierter Personen
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<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>
</methodsynopsis>
<para>
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>.
</para>
</refsect1>
</refentry>
<refentry id="function.ircg-disconnect">
<refnamediv>
<refname>ircg_disconnect</refname>
<refpurpose>
Beendet die Verbindung zum IRC-Server
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<methodsynopsis>
<type>boolean</type><methodname>ircg_disconnect</methodname>
<methodparam><type>resource</type><parameter>connection</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
</para>
<para>
Siehe auch: <function>ircg_pconnect</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.ircg-is-conn-alive">
<refnamediv>
<refname>ircg_is_conn_alive</refname>
<refpurpose>
Check connection status
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<methodsynopsis>
<type>boolean</type><methodname>ircg_is_conn_alive</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>ircg_is_conn_alive</function> gibt den Wert &true; zurck,
wenn die Verbindung <parameter>connection</parameter> zum IRC-Server besteht, oder &false; falls keine gltige Verbindung mehr besteht.
</para>
</refsect1>
</refentry>
<refentry id="function.ircg-lookup-format-messages">
<refnamediv>
<refname>ircg_lookup_format_messages</refname>
<refpurpose>
Whlt ein Format fr die Ausgabe von IRC-Nachrichten und Ereignissen aus.
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<methodsynopsis>
<type>boolean</type><methodname>ircg_lookup_format_messages</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
Whlt 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 Verfgung.
</para>
<para>
Siehe auch: <function>ircg_register_format_messages</function>
</para>
</refsect1>
</refentry>
<refentry id="function.ircg-register-format-messages">
<refnamediv>
<refname>ircg_register_format_messages</refname>
<refpurpose>
Registriert die Ausgabeformatierungen fr Nachrichten und Ereignisse
vom IRC-Server
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<methodsynopsis>
<type>boolean</type><methodname>ircg_register_format_messages</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<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 mglich mehrere
Formate (Layer) zu definieren, die mit der Funktion
<function>ircg_lookup_format_messages</function> ausgewhlt werden
knnen.
</para>
<para>
Die Funktionen fr 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 verlsst 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 gendert</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 grssere 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 Inaktivitt</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>fr 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 - vollstndige Nachricht</simpara></listitem>
<listitem><simpara>%m - umgewandelte Nachricht</simpara></listitem>
<listitem><simpara>%j - fr 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>
</refsect1>
</refentry>
<refentry id='function.ircg-set-on-die'>
<refnamediv>
<refname>ircg_set_on_die</refname>
<refpurpose>
Setzt eine Aktion bei Abbruch der Verbindung
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<methodsynopsis>
<type>bool</type><methodname>ircg_set_on_die</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
<methodparam><type>int</type><parameter>port</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<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
gltige IPv4-Adresse enthalten) angegeben wird,
die Zeichenkette <parameter>data</parameter>.
</para>
</refsect1>
</refentry>
<refentry id='function.ircg-set-file'>
<refnamediv>
<refname>ircg_set_file</refname>
<refpurpose>
Legt eine Logdatei an
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<methodsynopsis>
<type>bool</type><methodname>ircg_set_file</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
</methodsynopsis>
<para>
Die Funktion <function>ircg_set_file</function> legt eine
Logdatei <parameter>path</parameter> fr die Verbindung
<parameter>connection</parameter> an, in der alle Ausgaben
geloggt werden. <function>ircg_set_file</function> liefert bei
Auftreten eines Fehler &false; zurck, ansonsten &true;.
</para>
</refsect1>
</refentry>
<refentry id='function.ircg-get-username'>
<refnamediv>
<refname>ircg_get_username</refname>
<refpurpose>
Liefert den Benutzernamen zurck
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<methodsynopsis>
<type>string</type><methodname>ircg_get_username</methodname>
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Die Funktion <function>ircg_get_username</function> liefert den
aktuellen Benutzernamen fr die Verbindung
<parameter>connection</parameter> zurck. Ist die Verbindung
ungltig, oder wurde die Verbindung abgebrochen, liefert
<function>ircg_get_username</function> &false; zurck.
</para>
</refsect1>
</refentry>
<refentry id='function.ircg-nickname-escape'>
<refnamediv>
<refname>ircg_nickname_escape</refname>
<refpurpose>
Formatiert einen Benutzernamen in einen gltigen IRC-Namen
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<methodsynopsis>
<type>string</type><methodname>ircg_nickname_escape</methodname>
<methodparam><type>string</type><parameter>nick</parameter></methodparam>
</methodsynopsis>
<para>
Die Funktion <function>ircg_nickname_escape</function> formatiert
einen Benutzernamen <parameter>nick</parameter> in einen IRC
konformes Format, und liefert den umgewandelten Namen zurck.
</para>
<para>
Siehe auch: <function>ircg_nickname_unescape</function>
</para>
</refsect1>
</refentry>
<refentry id='function.ircg-nickname-unescape'>
<refnamediv>
<refname>ircg_nickname_unescape</refname>
<refpurpose>
Decodiert einen IRC konformen Benutzernamen
</refpurpose>
</refnamediv>
<refsect1>
<title>Beschreibung</title>
<methodsynopsis>
<type>string</type><methodname>ircg_nickname_unescape</methodname>
<methodparam><type>string</type><parameter>nick</parameter></methodparam>
</methodsynopsis>
<para>
Function <function>ircg_nickname_unescape</function> liefert
einen decodierten Benutzernamen zurck, der ber den Parameter
<parameter>nick</parameter> bergeben wurde.
</para>
<para>
Siehe auch: <function>ircg_nickname_escape</function>
</para>
</refsect1>
</refentry>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
|
