repo: ngircd
action: commit
revision: 
path_from: 
revision_from: 7871a904d766e325bd2ce94dd8bea37f45198771:
path_to: 
revision_to: 

commit 7871a904d766e325bd2ce94dd8bea37f45198771
Author: Alexander Barton 
Date:   Mon Nov 5 23:51:52 2012 +0100

    doc/Protocol.txt: Document METADATA command

diff --git a/doc/Protocol.txt b/doc/Protocol.txt

--- a/doc/Protocol.txt
+++ b/doc/Protocol.txt
@@ -81,6 +81,9 @@ The following  are defined at the moment:
 - H: The server supports the "enhanced server handshake", see section II.2
      for a detailed description.

+- M: Changing client "metadata" (hostname, real name, ...) using the
+     METADATA command is supported.
+
 - o: IRC operators are allowed to change channel- and channel-user-modes
      even if they aren't channel-operator of the affected channel.

@@ -194,13 +197,35 @@ received from the client using the set  to the server
 encoding (UTF-8), and all message data which is to be sent to the client
 from the server encoding (UTF-8) to .

-The list of supported 's is implementation dependent.
+The list of supported client character sets is implementation dependent.

 If a client sets its  to the server encoding (UTF-8),
 it disables all conversions; the connection behaves as if no CHARCONV
 command has been sent at all in this session.


+II.6 Update client "metadata"
+
+     Command: METADATA
+  Parameters:   
+     Used by: servers only
+
+The METADATA command is used on server-links to update "metadata" information
+of clients, like the hostname, the info text ("real name"), or the user name.
+
+The server updates its client database according to the received  and
+ parameters, and passes the METADATA command on to all the other
+servers in the network that support this command (see section II.1 "Register
+new server link",  "M"), even if it doesn't support the given
+ itself: unknown  names are ignored silently!
+
+The following  names are defined:
+
+ - "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)
+
+
 III. Numerics used by IRC+ Protocol
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-----END OF PAGE-----