Update doc/Protocol.txt for IRCv3 WEBIRC extension

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

diff --git a/doc/Protocol.txt b/doc/Protocol.txt
index 9a8ddf6fdcefa96674200764876b7e7895cd2b74..b6ead9dfdbe5ef6078236dff1e1e60829a715413 100644 (file)
--- a/doc/Protocol.txt
+++ b/doc/Protocol.txt
@@ -176,7 +176,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
@@ -186,6 +186,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
 
@@ -224,6 +227,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)