From: Alexander Barton <alex@barton.de>
Date: Thu, 18 Jul 2013 21:42:00 +0000 (+0200)
Subject: Commands.txt: Update description of the "ERROR" command
X-Git-Tag: rel-21-rc1~89
X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=commitdiff_plain;h=720eb874a9397672de06055947a057db8cf62007;ds=sidebyside

Commands.txt: Update description of the "ERROR" command
---

diff --git a/doc/Commands.txt b/doc/Commands.txt
index 4058f3df..26e37d44 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -593,11 +593,18 @@ Server Protocol Commands
 - ERROR
 	ERROR [<message> [<> [...]]]
 	.
-	Return an error message to the server. The first parameter, if given,
-	will be logged by the server, all further parameters are silently
-	ignored.
+	Inform a client or a server about an error condition. The first 
+	parameter, if given, is logged by the server receiving the message,
+	all other parameters are silently ignored.
 	.
-	This command is silently ignored on non-server and non-service links.
+	This command is silently ignored on non-server and non-service links
+	and shouldn't be used by regular IRC clients.
+	.
+	The ERROR message is also sent before terminating a regular client
+	connection.
+
+	References:
+	 - RFC 2812, 3.7.4 "Error message"
 
 - METADATA
 	METADATA <target> <key> <value>