]> arthur.barton.de Git - ngircd-alex.git/blobdiff - doc/Commands.txt
Enhance Travis-CI configuration file
[ngircd-alex.git] / doc / Commands.txt
index 2d3cab2f3892bcbda76b38e8c0254aeb4561a4f2..4058f3dfe8febbbe2a709da4bec030c1ebeb18a9 100644 (file)
@@ -419,14 +419,17 @@ Channel Commands
 ~~~~~~~~~~~~~~~~
 
 - INVITE
-       INVITE <nick> <channel>
+       INVITE <nickname> <channel>
        .
-       Invites <nick> to <channel>.
-       <channel> does not have to exist, but if it does, only members of the
-       channel are allowed to invite other clients.
+       Invite <nickname> to join channel <channel>.
        .
-       If the <channel> mode "+i" is set, only <channel> operators may invite
-       other clients.
+       <channel> does not have to exist, but if it does, only members of the
+       channel are allowed to invite other users. If the channel mode "+i"
+       is set, only channel "half-ops" (and above) may invite other clients,
+       and if channel mode "+V" is set, nobody can invite other users.
+
+       References:
+        - RFC 2812, 3.2.7 "Invite message"
 
 - JOIN
        JOIN <channels> [<channel-keys>]
@@ -438,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>]]
@@ -503,9 +513,16 @@ Administrative Commands
        To list the G-Lines, type "STATS g".
 
 - KILL
-       KILL <nick> <reason>
+       KILL <nickname> <reason>
+       .
+       Forcibly remove all users with a given <nickname> from the IRC
+       network and display the given <reason> to them.
        .
-       Forcibly removes <nick> from the IRC network with a <reason>.
+       This command is used internally between servers, too, for example
+       to disconnect duplicate <nickname>'s after a "net split".
+
+       References:
+        - RFC 2812, 3.7.1 "Kill message"
 
 - KLINE
        KLINE <nick!user@hostmask> <seconds> :<reason>