repo: ngircd
action: commit
revision: 
path_from: 
revision_from: 73fded75150a72c68b4c382d90e6d7c3374d5f6c:
path_to: 
revision_to: 

commit 73fded75150a72c68b4c382d90e6d7c3374d5f6c
Author: Alexander Barton 
Date:   Wed Jan 23 15:16:33 2013 +0100

    Commands.txt: Import descriptions from "rbose/command_help"

    Import command description texts from the "rbose/command_help" branch,
    which have been written by DNS  -- thanks a lot!

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

--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -46,16 +46,35 @@ Connection Handling Commands
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 - CAP
+	See doc/Capabilities.txt

 - CHARCONV
+	See doc/Protocol.txt

 - NICK
+	NICK 
+	.
+	Change your nickname to .

 - PASS
+	PASS    []
+	.
+	Set a connection . This command must be sent before the
+	NICK/USER registration combination.
+	.
+	See doc/Protocol.txt for more info.

 - PING
+	PING  []
+	.
+	Tests the presence of a connection. A PING message results in a PONG
+	reply. If  is specified, the message gets passed on to it.

 - PONG
+	PONG  []
+	.
+	This command is a reply to the PING command and works in much the
+	same way.

 - QUIT
 	QUIT []
@@ -66,14 +85,28 @@ Connection Handling Commands
 	channels that you are a member of when leaving.

 - USER
+	USER   
+	.
+	This command is used at the beginning of a connection to specify the
+	name, hostname,  and initial user  of the
+	connecting client.
+	.
+	 may contain spaces, and thus must be prefixed with a colon.

 - WEBIRC
+	See doc/Protocol.txt


 General Commands
 ~~~~~~~~~~~~~~~~

 - AWAY
+	AWAY []
+	.
+	Provides the server with a message to automatically send in reply to a
+	PRIVMSG directed at the user, but not to a channel they are on.
+	.
+	If  is omitted, the away status is removed.

 - HELP
 	HELP []
@@ -93,10 +126,29 @@ General Commands


 - MODE
+	MODE   (user)
+	MODE   []
+	.
+	The MODE command is dual-purpose. It can be used to set both (user) and
+	 modes.
+	.
+	See doc/Modes.txt for more information.

 - NOTICE
+	NOTICE  
+	.
+	Send  to  (nick or channel).
+	.
+	This command works similarly to PRIVMSG, except automatic replies must
+	never be sent in reply to NOTICE messages.

 - PRIVMSG
+	PRIVMSG  
+	.
+	Send  to  (nick or channel).
+	.
+	Common IRC clients use MSG as PRIVMSG alias.
+	(Some clients use "QUERY  []" to open a private chat.)


 Status and Informational Commands
@@ -109,72 +161,239 @@ Status and Informational Commands
 	If no server name has been given, the local server will respond.

 - INFO
+	INFO []
+	.
+	Show the version, birth & online time of the current IRC server.
+	If  has been given, it shows the INFO of the specific .

 - ISON
+	ISON 
+	.
+	Queries the server to see if the clients in the space-separated list
+	 are currently on the network.
+	.
+	The server returns only the  that are on the network in a
+	space-separated list. If none of the clients are on the network the
+	server returns an empty list.

 - LINKS
+	LINKS [ []]
+	.
+	Lists all server links matching , if given,
+	on , or the current server if omitted.

 - LUSERS
+	LUSERS [ []]
+	.
+	Return statistics about the size of the network. If called with no
+	arguments, the statistics will reflect the entire network.
+	.
+	If  is given, it will return only statistics reflecting the
+	masked subset of the network.
+	If  is given, the command will be forwarded to 
+	for evaluation.

 - MOTD
+	MOTD []
+	.
+	Show "Message Of The Day" of the current server or specified .

 - NAMES
+	NAMES [ []]
+	.
+	Returns a list of who is on the comma-separated list of ,
+	by channel name.
+	.
+	If  is omitted, all users are shown, grouped by channel name
+	with all users who are not on a channel being shown as part of channel
+	"*".
+	If  is specified, the command is sent to  for
+	evaluation.

 - STATS
+	STATS  []
+	.
+	Returns statistics about the current server, or of a specified .
+	.
+	STATS flags:
+	.
+	g = G-Lines (Network-wide bans)
+	k = K-Lines (Server-local bans)
+	l = Link status (Parent server and own link)
+	m = IRC command status (usage count)
+	u = Server uptime

 - TIME
+	TIME []
+	.
+	Show the local time of the current server, or of a specified .

 - 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.

 - USERHOST
+	USERHOST 
+	.
+	Show the user-host of  (seperated by space).
+	"-" means  is away,
+	"+" means  is available,
+	"*" indicates your connection.

 - VERSION
+	VERSION []
+	.
+	Show the ngIRCd version of the current server, or specified .

 - WHO
+	WHO [ ["o"]]
+	.
+	Returns a list of users who match  (nick, hostmask or channel).
+	.
+	If the flag "o" is given, the server will only return information about
+	IRC Operators.

 - WHOIS
+	WHOIS [] 
+	.
+	Returns information about the comma-separated list of .
+	.
+	If  is given, the command is forwarded to it for processing.

 - WHOWAS
+	WHOWAS  [ []]
+	.
+	Used to return information about  that are no longer in use
+	(due to client disconnection, or nickname changes).
+	.
+	If given, the server will return information from the last  times
+	the nickname has been used.
+	If  is given, the command is forwarded to it for processing.


 Channel Commands
 ~~~~~~~~~~~~~~~~

 - INVITE
+	INVITE  
+	.
+	Invites  to .
+	 does not have to exist, but if it does, only members of the
+	channel are allowed to invite other clients.
+	.
+	If the  mode "+i" is set, only  operators may invite
+	other clients.

 - JOIN
+	JOIN  []
+	.
+	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.
+	.
+	If the channel(s) do not exist, then they will be created.

 - KICK
+	KICK   []
+	.
+	Remove  from , optional with a .
+	.
+	Only  operators are able to KICK.

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

 - PART
+	PART  []
+	.
+	Leave  (comma-separated list), optional with a
+	.

 - TOPIC
+	TOPIC  
+	.
+	Set a  for .
+	.
+	Only  operators are able to set a .


 Administrative Commands
 ~~~~~~~~~~~~~~~~~~~~~~~

 - CONNECT
+	CONNECT  [ [ [ ]]]
+	.
+	Instructs the current server, or  if specified,
+	to connect to .
+	.
+	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.

 - DIE
+	DIE
+	.
+	Instructs the server to shut down.

 - DISCONNECT
+	DISCONNECT []
+	.
+	Disconnects the current server, or  if specified.
+	To disconnect a  you need to have remote oper status.

 - GLINE
+	GLINE   :
+	.
+	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.
+	.
+	To remove a G-Line, type "GLINE ".
+	To list the G-Lines, type "STATS g".

 - KILL
+	KILL  
+	.
+	Forcibly removes  from the IRC network with a .

 - KLINE
+	KLINE   :
+	.
+	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.
+	.
+	To remove a K-Line, type "KLINE ".
+	To list the K-Lines, type "STATS k".

 - OPER
+	OPER  
+	.
+	Authenticates  as an IRC operator on the current server/network.

 - REHASH
+	REHASH
+	.
+	Causes the server to re-read and re-process its configuration file(s).

 - RESTART
+	RESTART
+	.
+	Restart the server.

 - WALLOPS
+	WALLOPS 
+	.
+	Sends  to all users with user mode "+w".


 IRC Service Commands
@@ -193,6 +412,12 @@ Server Protocol Commands
 ~~~~~~~~~~~~~~~~~~~~~~~~

 - CHANINFO
+	CHANINFO  + [[ ] ]
+	.
+	CHANINFO is used by servers to inform each other about a channel:
+	its modes, channel key, user limits and its topic.
+	.
+	See doc/Protocol.txt for more information.

 - ERROR
 	ERROR [ [<> [...]]]
@@ -204,12 +429,22 @@ Server Protocol Commands
 	This command is silently ignored on non-server and non-service links.

 - METADATA
+	METADATA   
+	.
+	The METADATA command is used on server-links to update "metadata"
+	information of clients, like the hostname, the info text ("real name"),
+	or the user name.
+	.
+	See doc/Protocol.txt for more information.

 - NJOIN

 - SERVER

 - SQUIT
+	SQUIT 
+	.
+	Disconnects an IRC Server from the network.


 Dummy Commands

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