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

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

diff --git a/doc/Commands.txt b/doc/Commands.txt
index f21073abb86d16b12957dd2e2a8dd8743abcd37e..2a4baefe13903823b6b61c136bf6b563ecfeadb0 100644 (file)
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -386,21 +386,33 @@ Status and Informational Commands
         - RFC 2812, 3.6.1 "Who query"
 
 - WHOIS
-       WHOIS [<server>] <nicknames>
+       WHOIS [<target>] <mask>[,<mask>[,...]]
        .
-       Returns information about the comma-separated list of <nicknames>.
+       Query information about users matching the <mask> parameter(s) as seen
+       by the server <target>; up to 3 <masks> are supported.
        .
-       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 connecion 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 connecion is used when <target> is omitted.
+
+       References:
+        - RFC 2812, 3.6.3 "Whowas"
 
 
 Channel Commands
@@ -532,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