]> arthur.barton.de Git - ngircd-alex.git/blobdiff - doc/Commands.txt
Commands.txt: Update description of the "VERSION" command
[ngircd-alex.git] / doc / Commands.txt
index 0f3fdbb04fd1c209a1ee20afb791a6d61e6fe15f..6889039c72d4ab190807f785a6fbb99150d6079e 100644 (file)
@@ -243,56 +243,97 @@ 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>]
+       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>]]
+       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>]]
+       .
+       Show statistics and other information of type <query> of a particular
+       IRC server in the network.
        .
-       Returns statistics about the current server, or of a specified <server>.
+       The following <query> types are supported (case-insensitive):
        .
-       STATS flags:
+        - 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.
        .
-       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
+       <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>]
@@ -301,17 +342,35 @@ Status and Informational Commands
        of a specific <server>, in a similar method to traceroute.
 
 - USERHOST
-       USERHOST <nicknames>
+       USERHOST <nickname> [<nickname> [...]]
+       .
+       Show flags and the hostmasks (<user>@<host>) of the <nickname>s,
+       seperated by spaces. The following flags are used:
        .
-       Show the user-host of <nicknames> (seperated by space).
-       "-" means <nick> is away,
-       "+" means <nick> is available,
-       "*" indicates your connection.
+        - "-"  The client is "away" (the mode "+a" is set on this client).
+        - "+"  Client seems to be available, at least it isn't marked "away".
+        - "*"  The client is an IRC operator (the mode "+o" is set).
+
+       References:
+        - RFC 2812, 4.8 "Userhost message"
 
 - VERSION
-       VERSION [<server>]
+       VERSION [<target>]
+       .
+       Show version information about a particular IRC server in the network.
        .
-       Show the ngIRCd version 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.
+       .
+       Please note: in normal operation, the version number ends in a dot
+       (".", for example "ngIRCd-20.1."). If it ends in ".1" (for example
+       "ngIRCd-20.1.1", same version than before!), the server is running in
+       debug-mode; and if it ends in ".2", the "network sniffer" is active!
+       Keep your privacy in mind ...
+
+       References:
+        - RFC 2812, 3.4.3 "Version message"
 
 - WHO
        WHO [<target> ["o"]]