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

commit adc8d4f6c89a11e08f5214e4ceb1323376a42ec5
Author: Alexander Barton 
Date:   Fri Aug 2 23:25:23 2013 +0200

    Commands.txt: Update more descriptions

    Update description of "CONNECT", "DIE", "DISCONNECT", "GLINE", "KILL",
    "KLINE", "OPER", "REHASH", "RESTART" and "WALLOPS".

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

--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -651,37 +651,61 @@ Administrative Commands
 ~~~~~~~~~~~~~~~~~~~~~~~

 - CONNECT
-	CONNECT  [ [ [ ]]]
+	CONNECT  [ [ [ ]]]
 	.
-	Instructs the current server, or  if specified,
-	to connect to .
+	Instructs the current server, or  if specified,
+	to connect to the server named , which must be configured
+	in the server configuration file.
 	.
-	To connect  you need to have remote oper status.
-	If  is omitted, it uses the server port of the configuration.
-	If  and  is given, it uses those passwords instead
-	of the ones in the configuration.
+	To use this command, the user must be an IRC Operator. To establish
+	a connection on a , you must have remote IRC operator
+	privileges.
+	.
+	If ,  and  are given, these values override
+	the ones specified in the server configuration file.
+
+	References:
+	 - RFC 2812, 3.4.7 "Connect message"

 - DIE
 	DIE
 	.
 	Instructs the server to shut down.
+	.
+	To use this command, the user must be an IRC Operator.
+
+	References:
+	 - RFC 2812, 4.3 "Die message"

 - DISCONNECT
-	DISCONNECT []
+	DISCONNECT 
+	.
+	Disconnect and disable a locally linked server.
 	.
-	Disconnects the current server, or  if specified.
-	To disconnect a  you need to have remote oper status.
+	To use this command, the user must be an IRC Operator.
+
+	References:
+	 - This command is not specified in the IRC RFCs, it is an extension
+	   of ngIRCd.

 - GLINE
-	GLINE   :
+	GLINE  [ :]
+	.
+	This command provides timed G-Lines (network-wide bans).
 	.
-	This command provides timed G-Lines (Network-wide bans).
 	If a client matches a G-Line, it cannot connect to any server on
-	the IRC network. If you put 0 as , it makes the G-Line
-	permanent.
+	the IRC network for  seconds. When  is 0, it make
+	the G-Line permanent.
+	.
+	If no  and no  is given, the G-Line is removed.
 	.
-	To remove a G-Line, type "GLINE ".
-	To list the G-Lines, type "STATS g".
+	To use this command, the user must be an IRC Operator.
+	.
+	"STATS g" can be used to list all currently active G-Lines.
+
+	References:
+	 - This command is not specified in the IRC RFCs, it is an extension
+	   of ngIRCd.

 - KILL
 	KILL  
@@ -691,40 +715,78 @@ Administrative Commands
 	.
 	This command is used internally between servers, too, for example
 	to disconnect duplicate 's after a "net split".
+	.
+	To use this command, the user must be an IRC Operator.

 	References:
 	 - RFC 2812, 3.7.1 "Kill message"

 - KLINE
-	KLINE   :
+	KLINE  [ :]
+	.
+	This command provides timed K-Lines (server-local bans).
+	.
+	If a client matches a K-Line, it cannot connect to this server for
+	 seconds. When  is 0, it makes the K-Line permanent.
 	.
-	This command provides timed K-Lines (Server-local bans).
-	If a client matches a K-Line, it cannot connect to the issued server.
-	If you put 0 as , it makes the K-Line permanent.
+	If no  and no  is given, the K-Line is removed.
 	.
-	To remove a K-Line, type "KLINE ".
-	To list the K-Lines, type "STATS k".
+	To use this command, the user must be an IRC Operator.
+	.
+	"STATS k" can be used to list all currently active K-Lines.
+
+	References:
+	 - This command is not specified in the IRC RFCs, it is an extension
+	   of ngIRCd.

 - OPER
-	OPER  
+	OPER  
+	.
+	Authenticates a user named  as an IRC operator on the current
+	server/network.
+	.
+	This operator  must be configured in the server configuration.
 	.
-	Authenticates  as an IRC operator on the current server/network.
+	Please note that  is NOT related to a nickname at all!
+
+	References:
+	 - RFC 2812, 3.1.4 "Oper message"

 - REHASH
 	REHASH
 	.
 	Causes the server to re-read and re-process its configuration file(s).
+	.
+	While rehashing, no new connections are accepted, but all already
+	established connections stay connected.
+	.
+	To use this command, the user must be an IRC Operator.
+
+	References:
+	 - RFC 2812, 4.2 "Rehash message"

 - RESTART
 	RESTART
 	.
 	Restart the server.
+	.
+	While restarting, all connections are reset and no new connections
+	are accepted.
+	.
+	To use this command, the user must be an IRC Operator.
+
+	References:
+	 - RFC 2812, 4.4 "Restart message"

 - WALLOPS
 	WALLOPS 
 	.
 	Sends  to all users with user mode "+w".
+	.
+	To use this command, the user must be an IRC Operator.

+	References:
+	 - RFC 2812, 4.7 "Operwall message"

 IRC Service Commands
 ~~~~~~~~~~~~~~~~~~~~

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