Commands.txt: Update description of the "KILL" command

[ngircd-alex.git] / doc / Commands.txt

diff --git a/doc/Commands.txt b/doc/Commands.txt
index 627efa5b2f04759bd7f41a2a6431dbf51578b9dd..4058f3dfe8febbbe2a709da4bec030c1ebeb18a9 100644 (file)
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -210,7 +210,7 @@ Status and Informational Commands
        .
        <target> can be a server name, the nickname of a client connected to
        a specific server, or a mask matching a server name in the network.
-       The server of the current connecion is used when <target> is omitted.
+       The server of the current connection is used when <target> is omitted.
 
        References:
         - RFC 2812, 3.4.9 "Admin command"
@@ -222,7 +222,7 @@ Status and Informational Commands
        .
        <target> can be a server name, the nickname of a client connected to
        a specific server, or a mask matching a server name in the network.
-       The server of the current connecion is used when <target> is omitted.
+       The server of the current connection is used when <target> is omitted.
 
        References:
         - RFC 2812, 3.4.10 "Info command"
@@ -231,7 +231,7 @@ Status and Informational Commands
        ISON <nickname> [<nickname> [...]]
        .
        Query online status of a list of nicknames. The server replies with
-       a list only containing nicknes actually connected to a server in
+       a list only containing nicknames actually connected to a server in
        the network. If no nicknames of the given list are online, an empty
        list is returned to the client requesting the information.
 
@@ -263,7 +263,7 @@ Status and Informational Commands
        .
        <target> can be a server name, the nickname of a client connected to
        a specific server, or a mask matching a server name in the network.
-       The server of the current connecion is used when <target> is omitted.
+       The server of the current connection is used when <target> is omitted.
 
        Please note that ngIRCd ignores the <mask> parameter entirely: it
        is not possible to get information for a part of the network only.
@@ -278,7 +278,7 @@ Status and Informational Commands
        .
        <target> can be a server name, the nickname of a client connected to
        a specific server, or a mask matching a server name in the network.
-       The server of the current connecion is used when <target> is omitted.
+       The server of the current connection is used when <target> is omitted.
 
        References:
         - RFC 2812, 3.4.1 "Motd message"
@@ -297,7 +297,7 @@ Status and Informational Commands
        .
        <target> can be a server name, the nickname of a client connected to
        a specific server, or a mask matching a server name in the network.
-       The server of the current connecion is used when <target> is omitted.
+       The server of the current connection is used when <target> is omitted.
 
        References:
         - RFC 2812, 3.2.5 "Names message"
@@ -318,7 +318,7 @@ Status and Informational Commands
        .
        <target> can be a server name, the nickname of a client connected to
        a specific server, or a mask matching a server name in the network.
-       The server of the current connecion is used when <target> is omitted.
+       The server of the current connection is used when <target> is omitted.
 
        References:
         - RFC 2812, 3.4.4 "Stats message"
@@ -330,7 +330,7 @@ Status and Informational Commands
        .
        <target> can be a server name, the nickname of a client connected to
        a specific server, or a mask matching a server name in the network.
-       The server of the current connecion is used when <target> is omitted.
+       The server of the current connection is used when <target> is omitted.
 
        References
         - RFC 2812, 3.4.6 "Time message"
@@ -345,7 +345,7 @@ Status and Informational Commands
        USERHOST <nickname> [<nickname> [...]]
        .
        Show flags and the hostmasks (<user>@<host>) of the <nickname>s,
-       seperated by spaces. The following flags are used:
+       separated by spaces. The following flags are used:
        .
         - "-"  The client is "away" (the mode "+a" is set on this client).
         - "+"  Client seems to be available, at least it isn't marked "away".
@@ -361,7 +361,7 @@ Status and Informational Commands
        .
        <target> can be a server name, the nickname of a client connected to
        a specific server, or a mask matching a server name in the network.
-       The server of the current connecion is used when <target> is omitted.
+       The server of the current connection is used when <target> is omitted.
        .
        Please note: in normal operation, the version number ends in a dot
        (".", for example "ngIRCd-20.1."). If it ends in ".1" (for example
@@ -393,7 +393,7 @@ Status and Informational Commands
        .
        <target> can be a server name, the nickname of a client connected to a
        specific server, or a mask matching a server name in the network. The
-       server of the current connecion is used when <target> is omitted.
+       server of the current connection is used when <target> is omitted.
 
        References:
         - RFC 2812, 3.6.2 "Whois query"
@@ -409,7 +409,7 @@ Status and Informational Commands
        .
        <target> can be a server name, the nickname of a client connected to a
        specific server, or a mask matching a server name in the network. The
-       server of the current connecion is used when <target> is omitted.
+       server of the current connection is used when <target> is omitted.
 
        References:
         - RFC 2812, 3.6.3 "Whowas"
@@ -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 removes <nick> from the IRC network with a <reason>.
+       Forcibly remove all users with a given <nickname> from the IRC
+       network and display the given <reason> to them.
+       .
+       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>
@@ -617,6 +634,15 @@ Dummy Commands
         - RFC 2812, 4.5 "Summon message"
 
 - USERS
+       USERS [<target>]
+       .
+       This command was intended to list users directly logged in into the
+       console of the IRC server -- but is deprecated today. Therefore ngIRCd
+       doesn't really implement this command and always returns an error
+       message, regardless of the parameters given.
+
+       References:
+        - RFC 2812, 4.6 "Users"
 
 - GET