X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2FCommands.txt;h=f21073abb86d16b12957dd2e2a8dd8743abcd37e;hb=19cb29da514a397268f2965c08496a7b6ff89aa0;hp=e92027bbe276b36a051a085e76348e6f4b0ee15d;hpb=e051ea06fc601f8ae8d91b3b3f360e6f6e48db70;p=ngircd.git

diff --git a/doc/Commands.txt b/doc/Commands.txt
index e92027bb..f21073ab 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -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>]]
+	.
+	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>]
@@ -320,26 +342,49 @@ 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 the ngIRCd version of the current server, or specified <server>.
+	Show version information about a particular IRC server in the network.
+	.
+	<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"]]
+	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>
 	.