summary refs log tree commit diff
diff options
context:
space:
mode:
authorAlexander Barton <alex@barton.de>2013-02-10 00:24:14 +0100
committerAlexander Barton <alex@barton.de>2013-02-10 00:24:14 +0100
commit78978994dfeab446f45817ec78c0e1c9aced3acc (patch)
tree8d07ef605201ee1e0a6d8792b7e12b3793806199
parent19cb29da514a397268f2965c08496a7b6ff89aa0 (diff)
downloadngircd-78978994dfeab446f45817ec78c0e1c9aced3acc.tar.gz
ngircd-78978994dfeab446f45817ec78c0e1c9aced3acc.zip
Commands.txt: Update description of the "WHOIS" command
-rw-r--r--doc/Commands.txt12
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/Commands.txt b/doc/Commands.txt
index f21073ab..1f86cef7 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -386,11 +386,17 @@ Status and Informational Commands
 	 - RFC 2812, 3.6.1 "Who query"
 
 - WHOIS
-	WHOIS [<server>] <nicknames>
+	WHOIS [<target>] <mask>[,<mask>[,...]]
 	.
-	Returns information about the comma-separated list of <nicknames>.
+	Query information about users matching the <mask> parameter(s) as seen
+	by the server <target>; up to 3 <masks> are supported.
 	.
-	If <server> is given, the command is forwarded to it for processing.
+	<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.6.2 "Whois query"
 
 - WHOWAS
 	WHOWAS <nickname> [<count> [<server>]]