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

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

diff --git a/doc/Commands.txt b/doc/Commands.txt
index 6889039c72d4ab190807f785a6fbb99150d6079e..3d9363e68b3226e7ab042f6a5383b1b85dbf86f4 100644 (file)
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -373,29 +373,46 @@ Status and Informational Commands
         - RFC 2812, 3.4.3 "Version message"
 
 - WHO
-       WHO [<target> ["o"]]
+       WHO [<mask> ["o"]]
        .
-       Returns a list of users who match <target> (nick, hostmask or channel).
+       Show a list of users who match the <mask>, or all visible users when
+       the <mask> has been omitted. (Special case: the <mask> "0" is
+       equivalent to "*")
        .
        If the flag "o" is given, the server will only return information about
        IRC Operators.
 
+       References:
+        - 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