X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=doc%2FProtocol.txt;h=9858e9ed4980159324d8b3a730b8611e2a7f997f;hp=1c4a961be469e3f7ba593ddd682e3dc6b68d2042;hb=d329a961bd7153754fe587c14719d68a0ea422a0;hpb=9611833e33801b49c1d3b5e81ebd28ab8e2ae3b7 diff --git a/doc/Protocol.txt b/doc/Protocol.txt index 1c4a961b..9858e9ed 100644 --- a/doc/Protocol.txt +++ b/doc/Protocol.txt @@ -1,107 +1,114 @@ ngIRCd - Next Generation IRC Server - (c)2001,2002 by Alexander Barton, + (c)2001-2003 by Alexander Barton, alex@barton.de, http://www.barton.de/ - ngIRCd ist freie Software und steht unter - der GNU General Public License. + ngIRCd is free software and published under the + terms of the GNU General Public License. -- Protocol.txt -- -I. Kompatibilitaet -~~~~~~~~~~~~~~~~~~ +I. Compatibility +~~~~~~~~~~~~~~~~ -Der ngIRCd haelt sich an das IRC-Protokoll Version 2.10, wie es in den RFCs -1459 und 2810-2813 beschrieben ist. Diese (und ggf. weitere fuer den ngIRCd -relevante) RFCs sind in RFC.txt aufgefuehrt. +The ngIRCd implements the Internet Relay Chat (IRC) protocol version 2.10 +as defined in RFC ("request for comment") 1459 and 2810-2813. These (and +probably further relevant RFCs) are listed in doc/RFC.txt. -Leider verhaelt sich aber schon der "Originalserver" nicht immer genau so, -wie es in den RFCs beschrieben ist. Da der ngIRCd aber ein Ersatz fuer -eben diesen Server sein soll, werden diese Abweichungen in der Regel vom -ngIRCd emuliert um die Kompatibilitaet zu wahren. +Unfortunately, even the "original" ircd doesn't follow these specifications +in all details. But because the ngIRCd should be a fully compatible +replacement for this server ("ircd") it tries to emulate these differences. -Sollte dieses Verhalten nicht erwuenscht sein, so kann mit der configure- -Option "--enable-strict-rfc" der ngIRCd so compiliert werden, dass er sich -strikt an die entsprechenden RFCs haelt. +If you don't like this behavior please ./configure the ngIRCd using the +"--enable-strict-rfc" command line option. But keep in mind: not all IRC +clients are compatible with a server configured that way, some can't even +connect at all! Therefore this option usually isn't desired for "normal +server operation". -ACHTUNG: an einem so compilierten Server koennen sich andere Server und -Clients, die sich nicht genau an das Protokoll halten, u.U. nicht mehr -anmelden oder alle Funktionen nutzen! In der Regel ist diese Option daher -nicht erwuenscht. +II. The IRC+ Protocol +~~~~~~~~~~~~~~~~~~~~~ -II. Das IRC+-Protokoll -~~~~~~~~~~~~~~~~~~~~~~ +Starting with version 0.5.0, the ngIRCd extends the original IRC protocol +as defined in RFC 2810-2813. This enhanced protocol is named "IRC+". It is +backwards compatible to the "plain" IRC protocol and will only be used by +the ngIRCd if it detects that the peer supports it as well. -Der ngIRCd unterstuetzt als Erweiterung zum IRC-Protokoll wie es in den RFCs -2810-2813 beschrieben ist, das IRC+-Protokoll. Dieses Protokoll ist dabei -kompatibel zum IRC-Protokoll und wird nur verwendet, wenn der ngIRCd fest- -stellt, dass ein connectierter Server ebenfalls dieses erweiterte Protokoll -unterstuetzt. +The "PASS" command is used to detect the protocol and peer versions see +RFC 2813 (section 4.1.1) and below. -Die Protokoll- und Server-Erkennung wird mit dem "PASS"-Befehl durchgefuehrt -(vgl. RFC 2813, Sektion 4.1.1): +II.1 Register new server link -II.1 neuen Server-Link registrieren + Command: PASS + Parameters: [] + Used by: servers only (with these parameters) - Befehl: PASS - Parameter: [] - Fuer: mit dieser Syntax nur Server + is the password for this new server link as defined in the server +configuration which is sent to the peer or received from it. - enthaelt das Passwort fur den neu aufzubauenden Server-Link, -so wie es in der Konfigurationsdatei definiert wurde. + consists of two parts and is at least 4, at most 14 characters +long: the first four bytes contain the IRC protocol version number, whereas +the first two bytes represent the major version, the last two bytes the +minor version (the string "0210" indicates version 2.10, e.g.). - setzt sich aus zwei Teilen zusammen und ist mindestens 4, maximal -14 Zeichen lang: die ersten vier Bytes enthalten die Versionsnummer des -unterstuetzten IRC-Protokolls, wobei die ersten zwei Bytes die Major-, die -letzten beiden die Minor-Revision angeben. Der String "0210" steht also -fuer Protokollversion 2.10. -Die folgenden (optionalen!) 10 Bytes enthalten eine von der jeweiligen -Implementation abhaengige Versionsnummer. Server, die das IRC+-Protokoll -unterstuetzen, liefern hier "-IRC+". +The following optional(!) 10 bytes contain an implementation-dependent +version number. Servers supporting the IRC+ protocol as defined in this +document provide the string "-IRC+" here. - setzt sich ebenfalls aus zwei Bestandteilen zusammen und ist -maximal 100 Bytes lang. Getrennt werden die beiden Teile mit dem Zeichen -"|". Der erste Teil enthaelt den Namen der Implementation, der ngIRCd -liefert hier z.B. "ngIRCd", der Originalserver "IRC". Anhand dieser "ID" -kann zwischen Serverimplementationen unterschieden werden. Der zweite Teil -(nach dem "|") ist implementationsabhaengig und wird nur ausgewertet, -wenn die Gegenseite das IRC+-Protokoll unterstuetzt. In diesem Fall wird -folgende Syntax erwartet: "[:]". +Example for : "0210-IRC+". - ist hier eine ASCII-Klartext-Darstellung der Versionsnummer, - zeigt die vom Server unterstuetzten Erweiterungen an (und -kann die leere Menge sein). + consists of two parts separated with the character "|" and is at +most 100 bytes long. The first part contains the name of the implementation +(ngIRCd sets this to "ngircd", the original ircd to "IRC", e.g.). The second +part is implementation-dependent and should only be parsed if the peer +supports the IRC+ protocol as well. In this case the following syntax is +used: "[:]". -Mit dem optionalen Parameter werden Server-Optionen uebermittelt, -wie sie in RFC 2813, Sektion 4.1.1 definiert sind. + is an ASCII representation of the clear-text server version +number, indicates the supported IRC+ protocol extensions (and +may be empty!). -Folgende sind zur Zeit definiert: +The following are defined at the moment: -- o: IRC-Operatoren duerfen auch dann Channel- und Channel-User-Modes - aendern, wenn sie kein Channel-Operator im betroffenen Channel sind. +- C: The server supports the CHANINFO command. +- o: IRC operators are allowed to change channel- and channel-user-modes + even if they aren't channel-operator of the affected channel. -II.2 Channel-Modes, persistente Channel und Topic austauschen +- Z: Compressed server links are supported by the server. - Befehl: CHANINFO - Parameter: + [] - Fuer: Server +Example for a complete string: "ngircd|0.7.5:CZ". -Mit CHANINFO Informiert ein Server den anderen ueber einen Channel: dessen -Modes und dessen Topic. ist optional. +The optional parameter is used to propagate server options as +defined in RFC 2813, section 4.1.1. -Existiert auf dem Server, der das CHANINFO empfaengt, der Channel bereits, -so uebernimmt er die Werte jeweils nur dann, wenn er selber noch keine -Modes bzw. kein Topic definiert hat. Ansonsten wird der jeweilige Parameter -ignoriert. -Existiert der Channel noch nicht, so wird er mit den entsprechenden Angaben -erzeugt. +II.2 Exchange channel-modes, topics, and persistent channels + + Command: CHANINFO + Parameters: + [] + Used by: servers only + +CHANINFO is used by servers to inform each other about a channel: its +modes, channel key, user limits and its topic. is optional. + +If the channel already exists on the server receiving the CHANINFO command, +it only adopts the (or the ) if there are no modes (or topic) +already set. It there are already values set the server ignores the +corresponding parameter. + +If the channel doesn't exists at all it will be created. + +The parameter must be ignored if a channel has no key (the parameter + doesn't list the "k" channel mode). In this case should +contain "*" because the parameter is required by the CHANINFO syntax +and therefore can't be omitted. The parameter must be ignored when +a channel has no user limit (the parameter doesn't list the "l" +channel mode). In this case should be "0". -- -$Id: Protocol.txt,v 1.4 2002/09/04 00:00:43 alex Exp $ +$Id: Protocol.txt,v 1.11 2003/11/30 20:30:56 alex Exp $