summaryrefslogtreecommitdiff
path: root/docs/help/in/kickban.in
diff options
context:
space:
mode:
authorGeert Hauwaerts <geert@hauwaerts.be>2014-07-06 15:00:46 +0200
committerGeert Hauwaerts <geert@hauwaerts.be>2014-07-06 15:00:46 +0200
commit120508c14f42440408ab0ae4d32367a62bf9a9b2 (patch)
tree3aa5b5901fccd6f7812a861a7e15fa8e51b6078a /docs/help/in/kickban.in
parent06b6371ac544dc950291d4d4a72bf5e1a8e58441 (diff)
downloadirssi-120508c14f42440408ab0ae4d32367a62bf9a9b2.zip
Syntax documentation rewrite for J-K commands
Rewrote the syntax documentation for all commands starting with the letters J and K.
Diffstat (limited to 'docs/help/in/kickban.in')
-rw-r--r--docs/help/in/kickban.in20
1 files changed, 16 insertions, 4 deletions
diff --git a/docs/help/in/kickban.in b/docs/help/in/kickban.in
index aff0cfb2..3aef99cf 100644
--- a/docs/help/in/kickban.in
+++ b/docs/help/in/kickban.in
@@ -1,10 +1,22 @@
+%9Syntax:%9
+
@SYNTAX:kickban@
-Kicks off and bans a nick from the current channel.
-A reason for the kick can be supplied.
+%9Parameters:%9
+
+ The channel and the nicknames, separated by a comma, to kickban from the
+ channel and the reason thereof; if no channel is given, the active channel
+ will be used.
+
+%9Description:%9
+
+ Removes and then bans the given nicknames from the specified channel.
+
+%9Examples:%9
-Default alias for /KICKBAN is /KB.
+ /KICKBAN mike Please... chill down!
+ /KICKBAN #irssi bob,sarah You guys broke the rules for the last time.
-See also: KNOCKOUT, BANTYPE
+%9See also:%9 BAN, KICK, KNOCKOUT