]> arthur.barton.de Git - ngircd-alex.git/blobdiff - doc/Commands.txt
Commands.txt: Update description of the "MOTD" command
[ngircd-alex.git] / doc / Commands.txt
index ac455b300c2390704ded61e1472486daed1a4376..e92027bbe276b36a051a085e76348e6f4b0ee15d 100644 (file)
@@ -228,36 +228,60 @@ Status and Informational Commands
         - RFC 2812, 3.4.10 "Info command"
 
 - ISON
-       ISON <nicknames>
+       ISON <nickname> [<nickname> [...]]
        .
-       Queries the server to see if the clients in the space-separated list
-       <nicknames> are currently on the network.
-       .
-       The server returns only the <nicknames> that are on the network in a
-       space-separated list. If none of the clients are on the network the
-       server returns an empty list.
+       Query online status of a list of nicknames. The server replies with
+       a list only containing nicknes 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.
+
+       Please note that "all" IRC daemons even parse separate nicknames in
+       a single parameter (like ":nick1 nick2"), and therefore ngIRCd
+       implements this behaviour, too.
+
+       References:
+        - RFC 2812, 4.9 "Ison message"
 
 - LINKS
-       LINKS [<remote server> [<server mask>]]
+       LINKS [[<target>] [<mask>]
+       .
+       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.
        .
-       Lists all server links matching <server mask>, if given,
-       on <remote server>, or the current server if 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>]
+       MOTD [<target>]
+       .
+       Show the "Message of the Day" (MOTD) of an IRC server in the network.
        .
-       Show "Message Of The Day" of the current server or specified <server>.
+       <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.4.1 "Motd message"
 
 - NAMES
        NAMES [<channels> [<server>]]