about summary refs log tree commit diff
diff options
context:
space:
mode:
authorAlexander Barton <alex@barton.de>2013-02-10 00:20:19 +0100
committerAlexander Barton <alex@barton.de>2013-02-10 00:20:19 +0100
commita7023113e7546e3b278f753f0d38161f11afdb79 (patch)
tree34af196794dead8fce97324b8ba146b9c18b1261
parent02e24f5d1e6f098f2452f344331871a9d9a64280 (diff)
downloadngircd-a7023113e7546e3b278f753f0d38161f11afdb79.tar.gz
ngircd-a7023113e7546e3b278f753f0d38161f11afdb79.zip
Commands.txt: Update description of the "LUSERS" command
-rw-r--r--doc/Commands.txt19
1 files changed, 12 insertions, 7 deletions
diff --git a/doc/Commands.txt b/doc/Commands.txt
index 2c357928..83f811df 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -256,15 +256,20 @@ Status and Informational Commands
 	 - 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>]