From: Alexander Barton <alex@barton.de>
Date: Sun, 24 Feb 2013 17:53:33 +0000 (+0100)
Subject: Commands.txt: Update description of the "KICK" command
X-Git-Tag: rel-21-rc1~119
X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git;a=commitdiff_plain;h=b25fd8a98ca48abdabfe52ce3bfdd00a8f9fc003

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

diff --git a/doc/Commands.txt b/doc/Commands.txt
index 2967b43d..92d25c7f 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -441,11 +441,18 @@ Channel Commands
 	If the channel(s) do not exist, then they will be created.
 
 - KICK
-	KICK <channel> <nick> [<kick-message>]
+	KICK <channel>[,<channel>[,...]] <nickname>[,<nickname>[,...]] [<reason>]
 	.
-	Remove <nick> from <channel>, optional with a <kick-message>.
+	Remove users(s) with <nickname>(s) from <channel>(s).
 	.
-	Only <channel> operators are able to KICK.
+	There must be either exactly one <channel> parameter and multiple
+	<nickname> parameters, or as many <channel> parameters as there are
+	<nickname> parameters. The <reason> is shown to the users being
+	kicked, and the nickname of the current user is used when <reason>
+	is omitted.
+
+	References:
+	 - RFC 2812, 3.2.8 "Kick command"
 
 - LIST
 	LIST [<channels> [<server>]]