summary refs log tree commit diff
diff options
context:
space:
mode:
authorAlexander Barton <alex@barton.de>2013-02-10 00:23:27 +0100
committerAlexander Barton <alex@barton.de>2013-02-10 00:23:27 +0100
commit5b8f13a4a975a7b60d44fa2d3817409feb234f16 (patch)
tree5b45824b372203e71795728281fa2ce5c25390f1
parentb6e6e2e1da632a022abf7530ed028ba79d453614 (diff)
downloadngircd-5b8f13a4a975a7b60d44fa2d3817409feb234f16.tar.gz
ngircd-5b8f13a4a975a7b60d44fa2d3817409feb234f16.zip
Commands.txt: Update description of the "USERHOST" command
-rw-r--r--doc/Commands.txt15
1 files changed, 10 insertions, 5 deletions
diff --git a/doc/Commands.txt b/doc/Commands.txt
index 642dfb0b..f23d99d8 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -342,12 +342,17 @@ Status and Informational Commands
 	of a specific <server>, in a similar method to traceroute.
 
 - USERHOST
-	USERHOST <nicknames>
+	USERHOST <nickname> [<nickname> [...]]
 	.
-	Show the user-host of <nicknames> (seperated by space).
-	"-" means <nick> is away,
-	"+" means <nick> is available,
-	"*" indicates your connection.
+	Show flags and the hostmasks (<user>@<host>) of the <nickname>s,
+	seperated by spaces. The following flags are used:
+	.
+	 - "-"  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>]