doc/Protocol.txt

   1
   2                      ngIRCd - Next Generation IRC Server
   3
   4                       (c)2001-2003 by Alexander Barton,
   5                     alex@barton.de, http://www.barton.de/
   6
   7                ngIRCd is free software and published under the
   8                    terms of the GNU General Public License.
   9
  10                               -- Protocol.txt --
  11
  12
  13 I. Compatibility
  14 ~~~~~~~~~~~~~~~~
  15
  16 The ngIRCd implements the Internet Relay Chat (IRC) protocol version 2.10
  17 as defined in RFC ("request for comment") 1459 and 2810-2813. These (and
  18 probably further relevant RFCs) are listed in doc/RFC.txt.
  19
  20 Unfortunately, even the "original" ircd doesn't follow these specifications
  21 in all details. But because the ngIRCd should be a fully compatible
  22 replacement for this server ("ircd") it tries to emulate these differences.
  23
  24 If you don't like this behavior please ./configure the ngIRCd using the
  25 "--enable-strict-rfc" command line option. But keep in mind: not all IRC
  26 clients are compatible with a server configured that way, some can't even
  27 connect at all! Therefore this option usually isn't desired for "normal
  28 server operation".
  29
  30
  31 II. The IRC+ Protocol
  32 ~~~~~~~~~~~~~~~~~~~~~
  33
  34 Starting with version 0.5.0, the ngIRCd extends the original IRC protocol
  35 as defined in RFC 2810-2813. This enhanced protocol is named "IRC+". It is
  36 backwards compatible to the "plain" IRC protocol and will only be used by
  37 the ngIRCd if it detects that the peer supports it as well.
  38
  39 The "PASS" command is used to detect the protocol and peer versions see
  40 RFC 2813 (section 4.1.1) and below.
  41
  42
  43 II.1 Register new server link
  44
  45      Command: PASS
  46   Parameters: <password> <version> <flags> [<options>]
  47      Used by: servers only (with these parameters)
  48
  49 <password> is the password for this new server link as defined in the server
  50 configuration which is sent to the peer or received from it.
  51
  52 <version> consists of two parts and is at least 4, at most 14 characters
  53 long: the first four bytes contain the IRC protocol version number, whereas
  54 the first two bytes represent the major version, the last two bytes the
  55 minor version (the string "0210" indicates version 2.10, e.g.).
  56
  57 The following optional(!) 10 bytes contain an implementation-dependent
  58 version number. Servers supporting the IRC+ protocol as defined in this
  59 document provide the string "-IRC+" here.
  60
  61 Example for <version>: "0210-IRC+".
  62
  63 <flags> consists of two parts separated with the character "|" and is at
  64 most 100 bytes long. The first part contains the name of the implementation
  65 (ngIRCd sets this to "ngircd", the original ircd to "IRC", e.g.). The second
  66 part is implementation-dependent and should only be parsed if the peer
  67 supports the IRC+ protocol as well. In this case the following syntax is
  68 used: "<serverversion>[:<serverflags>]".
  69
  70 <serverversion> is an ASCII representation of the clear-text server version
  71 number, <serverflags> indicates the supported IRC+ protocol extensions (and
  72 may be empty!).
  73
  74 The following <serverflags> are defined at the moment:
  75
  76 - C: The server supports the CHANINFO command.
  77
  78 - L: INVITE- and BAN-lists should be synchronized between servers: if the
  79      peer understands this flag, it will send "MODE +I" and "MODE +b"
  80      commands after the server link has been established.
  81
  82 - o: IRC operators are allowed to change channel- and channel-user-modes
  83      even if they aren't channel-operator of the affected channel.
  84
  85 - Z: Compressed server links are supported by the server.
  86
  87 Example for a complete <flags> string: "ngircd|0.7.5:CZ".
  88
  89 The optional parameter <options> is used to propagate server options as
  90 defined in RFC 2813, section 4.1.1.
  91
  92
  93 II.2 Exchange channel-modes, topics, and persistent channels
  94
  95      Command: CHANINFO
  96   Parameters: <channel> +<modes> <key> <limit> [<topic>]
  97      Used by: servers only
  98
  99 CHANINFO is used by servers to inform each other about a channel: its
 100 modes, channel key, user limits and its topic. <topic> is optional.
 101
 102 If the channel already exists on the server receiving the CHANINFO command,
 103 it only adopts the <modes> (or the <topic>) if there are no modes (or topic)
 104 already set. It there are already values set the server ignores the
 105 corresponding parameter.
 106
 107 If the channel doesn't exists at all it will be created.
 108
 109 The parameter <key> must be ignored if a channel has no key (the parameter
 110 <modes> doesn't list the "k" channel mode). In this case <key> should
 111 contain "*" because the parameter <key> is required by the CHANINFO syntax
 112 and therefore can't be omitted. The parameter <limit> must be ignored when
 113 a channel has no user limit (the parameter <modes> doesn't list the "l"
 114 channel mode). In this case <limit> should be "0".
 115
 116
 117 --
 118 $Id: Protocol.txt,v 1.13 2005/08/27 19:00:06 alex Exp $