Fix and extend documentation a little bit

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

diff --git a/doc/Protocol.txt b/doc/Protocol.txt
index 516a4a4c914bd45138c9cea81e19d6ba2e1d920d..b920b4553daa1ef88d8571847f7c015bd68d2901 100644 (file)
--- a/doc/Protocol.txt
+++ b/doc/Protocol.txt
@@ -2,7 +2,7 @@
                      ngIRCd - Next Generation IRC Server
                            http://ngircd.barton.de/
 
-               (c)2001-2012 Alexander Barton and Contributors.
+               (c)2001-2019 Alexander Barton and Contributors.
                ngIRCd is free software and published under the
                    terms of the GNU General Public License.
 
@@ -26,6 +26,12 @@ 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".
 
+In addition, ngIRCd implements some "IRCv3" features. This includes:
+ - IRCv3 Client Capability Negotiation
+ - IRCv3.1 multi-prefix Extension
+ - IRCv3.2 userhost-in-names Extension
+Please see the IRCv3 homepage for more information: <https://ircv3.net>.
+
 
 II. The IRC+ Protocol
 ~~~~~~~~~~~~~~~~~~~~~
@@ -89,6 +95,9 @@ The following <serverflags> are defined at the moment:
 
 - S: The server supports the SERVICE command (on this link).
 
+- X: Server supports XOP channel modes (owner, admin, halfop) and supports
+     these user prefixes in CHANINFO commands, for example.
+
 - Z: Compressed server links are supported by the server.
 
 Example for a complete <flags> string: "ngircd|0.7.5:CZ".
@@ -173,7 +182,7 @@ channel mode). In this case <limit> should be "0".
 II.4 Update webchat/proxy client information
 
      Command: WEBIRC
-  Parameters: <password> <username> <hostname> <ip-address>
+  Parameters: <password> <username> <hostname> <ip-address> [<ignored>]
      Used by: unregistered clients only
 
 The WEBIRC command is used by some Web-to-IRC gateways to set the correct
@@ -183,6 +192,9 @@ 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.
 
+Optionally, a 5th parameter is accepted to comply with an IRCv3 extension,
+see <https://github.com/ircv3/ircv3-ideas/issues/12>, but ignored.
+
 
 II.5 Client character encoding conversion
 
@@ -221,6 +233,9 @@ new server link", <serverflag> "M"), even if it doesn't support the given
 
 The following <key> names are defined:
 
+ - "accountname": the account name of a client (can't be empty)
+ - "certfp": the certificate fingerprint of a client (can't be empty)
+ - "cloakhost": the cloaked hostname of a client
  - "host": the hostname of a client (can't be empty)
  - "info": info text ("real name") of a client
  - "user": the user name of a client (can't be empty)