repo: ngircd
action: commit
revision: 
path_from: 
revision_from: a8ecde255377c4235440c491cb28711a7b59869e:
path_to: 
revision_to: 

commit a8ecde255377c4235440c491cb28711a7b59869e
Author: Alexander Barton 
Date:   Fri Aug 2 01:45:02 2013 +0200

    Commands.txt: Update more descriptions

    Update descriptions of "AWAY", "JOIN", "LIST", "MODE", "PART",
    "TOPC", and "TRACE".

diff --git a/doc/Commands.txt b/doc/Commands.txt

--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -227,6 +227,9 @@ General Commands
 	.
 	If  is omitted, the away status is removed.

+	References:
+	 - RFC 2812, 4.1 "Away"
+
 - HELP
 	HELP []
 	.
@@ -243,15 +246,46 @@ General Commands
 	ngIRCd replies using "NOTICE" commands like ircd 2.10/2.11; other
 	implementations are using numerics 704, 705, and 706.

-
 - MODE
-	MODE   (user)
-	MODE   []
+	MODE  [{+|-}[] [{+|-}[] [...]]]
+	MODE  [{+|-}[] [ [ [...]]] [{+|-}[] [ [ [...]]] [...]]]
+	.
+	Set and get user and channel modes.
+	.
+	When no mode parameters are given, the currently set user or channel
+	modes are returned. Otherwise the modes are adjusted accordingly
+	and the changes will be reported back to the client.
+	.
+	All user and chnnel "modes" are indicated by single case-sensitive
+	characters.
 	.
-	The MODE command is dual-purpose. It can be used to set both (user) and
-	 modes.
+	Please note that a user can only get and set his own modes, and not
+	all user "levels" are allowed to change all channel modes ...
 	.
-	See doc/Modes.txt for more information.
+	The mode parameters can become quite complex, especially when dealing
+	with channel modes that require additional arguments:
+	.
+	  {+|-}  -- set or unset one or more modes.
+	  + -  -- set some modes and unset others.
+	  +    -- set (at least) two modes with arguments.
+	.
+	Some examples:
+	.
+	  MODE nick +i  -- set user to "invisible".
+	  MODE #chan +tn  -- set "topic lock" and "no external messages".
+	  MODE #chan -t +l 50  -- remove "topic lock", set "user limit" to 50.
+	  MODE #chan +ov nick1 nick2  -- set "channel op" and "voice" mode
+	                                 to nick1 and nick2 in channel #chan.
+	.
+	A complete list of all modes supported by ngIRCd can be found online
+	here: .
+
+	References:
+	 - RFC 2811, 4. "Channel Modes"
+	 - RFC 2812, 3.1.5 "User mode message"
+	 - RFC 2812, 3.2.3 "Channel mode message"
+	 - 
+	 - doc/Modes.txt

 - NOTICE
 	NOTICE [,[,...]] 
@@ -447,8 +481,13 @@ Status and Informational Commands
 - TRACE
 	TRACE []
 	.
-	Trace a path across the IRC network of the current server, or if given
-	of a specific , in a similar method to traceroute.
+	Find the route to a specific server and send information about its
+	peers. Each server that processes this command reports back to the
+	sender about it: the replies from pass-through servers form a chain
+	which shows the route to the destination.
+
+	References:
+	 - RFC 2812, 3.4.8 "Trace message"

 - USERHOST
 	USERHOST  [ [...]]
@@ -541,13 +580,19 @@ Channel Commands
 	 - RFC 2812, 3.2.7 "Invite message"

 - JOIN
-	JOIN  []
+	JOIN {[,[,...]] [[,[,...]]] | 0}
 	.
-	Makes the client join the  (comma-separated list), specifying
-	the passwords, if needed, in the comma-separated  list.
-	A  is only needed, if the  mode "+k" is set.
+	Makes the client join the  (comma-separated list), specifying
+	the channel keys ("passwords"). A  is only needed if the
+	 has the mode "+k" set.
 	.
 	If the channel(s) do not exist, then they will be created.
+	.
+	Using "JOIN 0" parts all channels at once.
+
+	References:
+	 - RFC 2812, 3.2.1 "Join message" (client protocol)
+	 - RFC 2813, 4.2.1 "Join message" (server protocol)

 - KICK
 	KICK [,[,...]] [,[,...]] []
@@ -564,25 +609,38 @@ Channel Commands
 	 - RFC 2812, 3.2.8 "Kick command"

 - LIST
-	LIST [ []]
+	LIST [[,[,...]] []]
+	.
+	List all visible  (comma-seperated list).
 	.
-	List all visible  (comma-seperated list) on the current
-	server.
 	If  is given, the command will be forwarded to  for
 	evaluation.

+	References:
+	 - RFC 2812, 3.2.6 "List message"
+
 - PART
-	PART  []
+	PART [,[,...]] []
 	.
-	Leave  (comma-separated list), optional with a
-	.
+	Leave  (comma-separated list), optionally with sending a
+	 to all the other channel members.
+
+	References:
+	 - RFC 2812, 3.2.2 "Part message"

 - TOPIC
-	TOPIC  
+	TOPIC  []
 	.
-	Set a  for .
+	Cchange or view the topic of a channel.
 	.
-	Only  operators are able to set a .
+	The topic for channel  is returned if there is no 
+	given. If the  parameter is present, the topic for that
+	channel will be changed, if this action is allowed for the user
+	requesting it. If the  parameter is an empty string, the
+	topic for that channel will be removed.
+
+	References:
+	 - RFC 2812, 3.2.4 "Topic message"


 Administrative Commands

-----END OF PAGE-----