]> arthur.barton.de Git - ngircd-alex.git/blobdiff - doc/Commands.txt
Commands.txt: spelling fixes ...
[ngircd-alex.git] / doc / Commands.txt
index 1f86cef71748f51d5a626290e714a0ae8517d7ef..2d3cab2f3892bcbda76b38e8c0254aeb4561a4f2 100644 (file)
@@ -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,20 +393,26 @@ 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"
 
 - WHOWAS
-       WHOWAS <nickname> [<count> [<server>]]
+       WHOWAS <nickname>[,<nickname>[,...]] [<count> [<target>]]
        .
-       Used to return information about <nicknames> that are no longer in use
-       (due to client disconnection, or nickname changes).
+       Query information about nicknames no longer in use in the network,
+       either because of nickname changes or disconnects. The history is
+       searched backwards, returning the most recent entry first. If there
+       are multiple entries, up to <count> entries will be shown (or all of
+       them, if no <count> has been given).
        .
-       If given, the server will return information from the last <count> times
-       the nickname has been used.
-       If <server> is given, the command is forwarded to it for processing.
+       <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 connection is used when <target> is omitted.
+
+       References:
+        - RFC 2812, 3.6.3 "Whowas"
 
 
 Channel Commands
@@ -538,6 +544,18 @@ IRC Service Commands
 - SERVICE
 
 - SERVLIST
+       SERVLIST [<mask> [<type>]]
+       .
+       List all IRC services currently registered in the network.
+       .
+       The optional <mask> and <type> parameters can be used to limit the
+       listing to services matching the <mask> and that are of type <type>.
+       .
+       Please note that ngIRCd doesn't use any service types at the moment
+       and therefore all services are of type "0".
+
+       References:
+        - RFC 2812, 3.5.1 "Servlist message"
 
 - SQUERY
 
@@ -587,8 +605,27 @@ Dummy Commands
 ~~~~~~~~~~~~~~
 
 - SUMMON
+       SUMMON <user> [<target> [<channel>]]
+       .
+       This command was intended to call people into IRC who are directly
+       connected to the terminal 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.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