]> arthur.barton.de Git - ngircd-alex.git/blobdiff - doc/Commands.txt
Commands.txt: Update description of the "LUSERS" command
[ngircd-alex.git] / doc / Commands.txt
index 0f3fdbb04fd1c209a1ee20afb791a6d61e6fe15f..83f811df978751b06d050281515472861f9aa0a5 100644 (file)
@@ -243,21 +243,33 @@ Status and Informational Commands
         - RFC 2812, 4.9 "Ison message"
 
 - LINKS
-       LINKS [<remote server> [<server mask>]]
+       LINKS [[<target>] [<mask>]
        .
-       Lists all server links matching <server mask>, if given,
-       on <remote server>, or the current server if omitted.
+       List all servers currently registered in the network matching <mask>,
+       or all servers if <mask> has been omitted, as seen by the server
+       specified by <target> or the local server when <target> is omitted.
+       .
+       <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.
+
+       References:
+        - RFC 2812, 3.4.5 "Links message"
 
 - LUSERS
-       LUSERS [<mask> [<server>]]
+       LUSERS [<mask> [<target>]]
        .
-       Return statistics about the size of the network. If called with no
-       arguments, the statistics will reflect the entire network.
+       Return statistics about the number of clients (users, servers,
+       services, ...) in the network as seen by the server <target>.
        .
-       If <mask> is given, it will return only statistics reflecting the
-       masked subset of the network.
-       If <server> is given, the command will be forwarded to <server>
-       for evaluation.
+       <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.
+
+       Please note that ngIRCd ignores the <mask> parameter entirely: it
+       is not possible to get information for a part of the network only.
+
+       References:
+        - RFC 2812, 3.4.2 "Lusers message"
 
 - MOTD
        MOTD [<server>]