Initial import of the ircii-pana-1.1-final source tree.

git-svn-id: svn://svn.code.sf.net/p/bitchx/code/tags/ircii-pana-1.1-final@1 13b04d17-f746-0410-82c6-800466cd88b0

bitchx-docs/5_Programming/on/kick

@@ -0,0 +1,26 @@
+Synopsis:
+   on [<modes>]kick [<serial#>] [-|^]<match> { <action> }
+
+Description:
+   This hook is triggered whenever the client observes another client (or
+   itself!) being kicked from a channel.
+
+Parameters:
+   $0    nickname of user kicked from channel
+   $1    nickname of user kicking $0 from channel
+   $2    channel kick observed on
+   $3-   kick message
+
+Examples:
+   To distinguish who is being kicked on a channel:
+      on ^kick "*" {
+         if ( [$0] == N ) {
+            echo *** You have been kicked from $2 by $1 \($3-\)
+         } {
+            echo *** $0 has been kicked from $2 by $1 \($3-\)
+         }
+      }
+
+See Also:
+   kick(1)
+