- beim GCC wird nun die "-ansi"-Option gesetzt.
[ngircd-alex.git] / doc / Protocol.txt
1
2                      ngIRCd - Next Generation IRC Server
3
4                       (c)2001,2002 by Alexander Barton,
5                     alex@barton.de, http://www.barton.de/
6
7                   ngIRCd ist freie Software und steht unter
8                        der GNU General Public License.
9
10                               -- Protocol.txt --
11
12
13 I. Kompatibilitaet
14 ~~~~~~~~~~~~~~~~~~
15
16 Der ngIRCd haelt sich an das IRC-Protokoll Version 2.10, wie es in den RFCs
17 1459 und 2810-2813 beschrieben ist. Diese (und ggf. weitere fuer den ngIRCd
18 relevante) RFCs sind in RFC.txt aufgefuehrt.
19
20 Leider verhaelt sich aber schon der "Originalserver" nicht immer genau so,
21 wie es in den RFCs beschrieben ist. Da der ngIRCd aber ein Ersatz fuer
22 eben diesen Server sein soll, werden diese Abweichungen in der Regel vom
23 ngIRCd emuliert um die Kompatibilitaet zu wahren.
24
25 Sollte dieses Verhalten nicht erwuenscht sein, so kann mit der configure-
26 Option "--enable-strict-rfc" der ngIRCd so compiliert werden, dass er sich
27 strikt an die entsprechenden RFCs haelt.
28
29 ACHTUNG: an einem so compilierten Server koennen sich andere Server und
30 Clients, die sich nicht genau an das Protokoll halten, u.U. nicht mehr
31 anmelden oder alle Funktionen nutzen! In der Regel ist diese Option daher
32 nicht erwuenscht.
33
34
35 II. Das IRC+-Protokoll
36 ~~~~~~~~~~~~~~~~~~~~~~
37
38 Der ngIRCd unterstuetzt als Erweiterung zum IRC-Protokoll wie es in den RFCs
39 2810-2813 beschrieben ist, das IRC+-Protokoll. Dieses Protokoll ist dabei
40 kompatibel zum IRC-Protokoll und wird nur verwendet, wenn der ngIRCd fest-
41 stellt, dass ein connectierter Server ebenfalls dieses erweiterte Protokoll
42 unterstuetzt.
43
44 Die Protokoll- und Server-Erkennung wird mit dem "PASS"-Befehl durchgefuehrt
45 (vgl. RFC 2813, Sektion 4.1.1):
46
47
48 II.1 neuen Server-Link registrieren
49
50      Befehl: PASS
51   Parameter: <password> <version> <flags> [<options>]
52        Fuer: mit dieser Syntax nur Server
53
54 <password> enthaelt das Passwort fur den neu aufzubauenden Server-Link,
55 so wie es in der Konfigurationsdatei definiert wurde.
56
57 <version> setzt sich aus zwei Teilen zusammen und ist mindestens 4, maximal
58 14 Zeichen lang: die ersten vier Bytes enthalten die Versionsnummer des
59 unterstuetzten IRC-Protokolls, wobei die ersten zwei Bytes die Major-, die
60 letzten beiden die Minor-Revision angeben. Der String "0210" steht also
61 fuer Protokollversion 2.10.
62 Die folgenden (optionalen!) 10 Bytes enthalten eine von der jeweiligen
63 Implementation abhaengige Versionsnummer. Server, die das IRC+-Protokoll
64 unterstuetzen, liefern hier "-IRC+".
65
66 <flags> setzt sich ebenfalls aus zwei Bestandteilen zusammen und ist
67 maximal 100 Bytes lang. Getrennt werden die beiden Teile mit dem Zeichen
68 "|". Der erste Teil enthaelt den Namen der Implementation, der ngIRCd
69 liefert hier z.B. "ngIRCd", der Originalserver "IRC". Anhand dieser "ID"
70 kann zwischen Serverimplementationen unterschieden werden. Der zweite Teil
71 (nach dem "|") ist implementationsabhaengig und wird nur ausgewertet,
72 wenn die Gegenseite das IRC+-Protokoll unterstuetzt. In diesem Fall wird
73 folgende Syntax erwartet: "<serverversion>[:<serverflags>]".
74
75 <serverversion> ist hier eine ASCII-Klartext-Darstellung der Versionsnummer,
76 <serverflags> zeigt die vom Server unterstuetzten Erweiterungen an (und
77 kann die leere Menge sein).
78
79 Mit dem optionalen Parameter <options> werden Server-Optionen uebermittelt,
80 wie sie in RFC 2813, Sektion 4.1.1 definiert sind.
81
82 Folgende <serverflags> sind zur Zeit definiert:
83
84 - o: IRC-Operatoren duerfen auch dann Channel- und Channel-User-Modes
85      aendern, wenn sie kein Channel-Operator im betroffenen Channel sind.
86
87 - C: der Server unterstuetzt den CHANINFO-Befehl.     
88
89
90 II.2 Channel-Modes, persistente Channel und Topic austauschen
91
92      Befehl: CHANINFO
93   Parameter: <channel> +<mode> [<topic>]
94        Fuer: Server
95
96 Mit CHANINFO Informiert ein Server den anderen ueber einen Channel: dessen
97 Modes und dessen Topic. <topic> ist optional.
98
99 Existiert auf dem Server, der das CHANINFO empfaengt, der Channel bereits,
100 so uebernimmt er die Werte jeweils nur dann, wenn er selber noch keine
101 Modes bzw. kein Topic definiert hat. Ansonsten wird der jeweilige Parameter
102 ignoriert.
103
104 Existiert der Channel noch nicht, so wird er mit den entsprechenden Angaben
105 erzeugt.
106
107
108 -- 
109 $Id: Protocol.txt,v 1.5 2002/09/04 00:06:19 alex Exp $