]> arthur.barton.de Git - ngircd.git/blobdiff - doc/Commands.txt
Commands.txt: Update description of the "TIME" command
[ngircd.git] / doc / Commands.txt
index e92027bbe276b36a051a085e76348e6f4b0ee15d..642dfb0b09db8a360b7627090396f3475217f00c 100644 (file)
@@ -284,34 +284,56 @@ Status and Informational Commands
         - RFC 2812, 3.4.1 "Motd message"
 
 - NAMES
-       NAMES [<channels> [<server>]]
+       NAMES [<channel>[,<channel>[,...]] [<target>]]
        .
-       Returns a list of who is on the comma-separated list of <channels>,
-       by channel name.
+       Show the list of users that are members of a particular <channel>
+       (and that are visible for the client requesting this information) as
+       seen by the server <target>. More than one <channel> can be given
+       separated by "," (but not whitespaces!).
        .
-       If <channels> is omitted, all users are shown, grouped by channel name
-       with all users who are not on a channel being shown as part of channel
-       "*".
-       If <server> is specified, the command is sent to <server> for
-       evaluation.
+       If <channel> has been omitted, all visible users are shown, grouped
+       by channel name, and all visible users not being members of at least
+       one channel are shown as members of the pseudo channel "*".
+       .
+       <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.2.5 "Names message"
 
 - STATS
-       STATS <flag> [<server>]
+       STATS [<query> [<target>]]
        .
-       Returns statistics about the current server, or of a specified <server>.
+       Show statistics and other information of type <query> of a particular
+       IRC server in the network.
        .
-       STATS flags:
+       The following <query> types are supported (case-insensitive):
        .
-       g = G-Lines (Network-wide bans)
-       k = K-Lines (Server-local bans)
-       l = Link status (Parent server and own link)
-       m = IRC command status (usage count)
-       u = Server uptime
+        - g  Network-wide bans ("G-Lines").
+        - k  Server-local bans ("K-Lines").
+        - l  Link status (parent server and own link only).
+        - m  Command usage count.
+        - u  Server uptime.
+       .
+       <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.4 "Stats message"
 
 - TIME
-       TIME [<server>]
+       TIME [<target>]
+       .
+       Show the local time of an IRC server in the network.
        .
-       Show the local time of the current server, or of a 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.6 "Time message"
 
 - TRACE
        TRACE [<server>]