summaryrefslogtreecommitdiff
path: root/docs/help/in/kick.in
diff options
context:
space:
mode:
Diffstat (limited to 'docs/help/in/kick.in')
-rw-r--r--docs/help/in/kick.in26
1 files changed, 17 insertions, 9 deletions
diff --git a/docs/help/in/kick.in b/docs/help/in/kick.in
index 48f58e68..00586059 100644
--- a/docs/help/in/kick.in
+++ b/docs/help/in/kick.in
@@ -1,16 +1,24 @@
+%9Syntax:%9
+
@SYNTAX:kick@
-This command "kicks" the specified user off of the specified
-channel. It is typically used to remove troublemakers, flooders,
-or people otherwise making a nuisance of themselves on the channel.
-The reason for the kick is recommended, but not required by the IRC
-servers.
+%9Parameters%9
+
+ The channel and the nicknames, separated by a comma, to kick from the
+ channel and the reason thereof; if no channel is given, the active channel
+ will be used.
+
+%9Description:%9
+
+ Removes the given nicknames from the specified channel; this command is
+ typically used to remove troublemakers, flooders or people otherwise making
+ a nuisance of themselves.
-If the <channel> is omitted, removes the nick from the current
-channel.
+%9Examples:%9
-The default alias for /KICK is /K.
+ /KICK mike Please... chill down!
+ /KICK #irssi bob,sarah Stop flooding!
-See also: KNOCKOUT
+%9See also:%9 BAN, KICKBAN, KNOCKOUT