Spelling fix: "nick name" -> "nickname"

[ngircd-alex.git] / doc / Protocol.txt

diff --git a/doc/Protocol.txt b/doc/Protocol.txt
index 2b7e7b875d226a5586331dc7994da8ea7850a57e..c7fd7826b85539d6e6615362b9693897a2e7fa27 100644 (file)
--- a/doc/Protocol.txt
+++ b/doc/Protocol.txt
@@ -1,9 +1,8 @@
 
                      ngIRCd - Next Generation IRC Server
 
                      ngIRCd - Next Generation IRC Server

+                           http://ngircd.barton.de/

 
 

-                        (c)2001-2008 Alexander Barton,
-                    alex@barton.de, http://www.barton.de/
-
+               (c)2001-2012 Alexander Barton and Contributors.

                ngIRCd is free software and published under the
                    terms of the GNU General Public License.
 
                ngIRCd is free software and published under the
                    terms of the GNU General Public License.
 


@@ -134,18 +133,24 @@ protocol which allows at max 15 arguments per command).
 Please see <http://www.irc.org/tech_docs/005.html> for details.
 
 The information exchanged using ISUPPORT can be used to detect configuration
 Please see <http://www.irc.org/tech_docs/005.html> for details.
 
 The information exchanged using ISUPPORT can be used to detect configuration

-incompatibilities (different maximum nick name length, for example) and
+incompatibilities (different maximum nickname length, for example) and

 therefore to disconnect the peer prior to registering it in the network.
 
 
 II.3 Exchange channel-modes, topics, and persistent channels
 
      Command: CHANINFO
 therefore to disconnect the peer prior to registering it in the network.
 
 
 II.3 Exchange channel-modes, topics, and persistent channels
 
      Command: CHANINFO

-  Parameters: <channel> +<modes> <key> <limit> [<topic>]
+  Parameters: <channel> +<modes> [[<key> <limit>] <topic>]

      Used by: servers only
 
 CHANINFO is used by servers to inform each other about a channel: its
      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. <topic> is optional.
+modes, channel key, user limits and its topic. The parameter combination
+<key> and <limit> is optional, as well as the <topic> parameter, so that
+there are three possible forms of this command:
+
+  CHANINFO <channel> +<modes>
+  CHANINFO <channel> +<modes> <topic>
+  CHANINFO <channel> +<modes> <key> <limit> <topic>

 
 If the channel already exists on the server receiving the CHANINFO command,
 it only adopts the <modes> (or the <topic>) if there are no modes (or topic)
 
 If the channel already exists on the server receiving the CHANINFO command,
 it only adopts the <modes> (or the <topic>) if there are no modes (or topic)


@@ -175,3 +180,34 @@ first command sent to the server, even before USER and NICK commands!
 The <password> must be set in the server configuration file to prevent
 unauthorized clients to fake their identity; it is an arbitrary string.
 
 The <password> must be set in the server configuration file to prevent
 unauthorized clients to fake their identity; it is an arbitrary string.
 

+
+II.5 Client character encoding conversion
+
+     Command: CHARCONV
+  Parameters: <client-charset>
+     Used by: registered clients
+     Replies: RPL_IP_CHARCONV_MSG, ERR_IP_CHARCONV_MSG
+
+
+III. Numerics used by IRC+ Protocol
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The IRC+ protocol uses numerics in the range 800-899 which aren't used by
+RFC 2812 and hopefully don't clash with other implementations ...
+
+Numerics 800-849 are used for status and success messages, and numerics
+850-899 are failure and error messages.
+
+
+III.1 IRC+ status and success numerics
+
+800 - RPL_IP_CHARCONV_MSG
+       %1 :Client encoding set"
+
+               %1      client character set
+
+
+III.2 IRC+ failure and error numerics
+
+850 - ERR_IP_CHARCONV_MSG
+       :Can't initialize client encoding