Merge remote-tracking branch 'alex/bug162-SSLCipherList'

[ngircd-alex.git] / doc / Commands.txt

diff --git a/doc/Commands.txt b/doc/Commands.txt
index 6bbd206874745a9af0251860567976c81c88c398..dde1498d47b49b5d70302d0bb60a8d84e04cd53e 100644 (file)
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -145,7 +145,7 @@ Connection Handling Commands
 
        Please note:
        The RFCs state that the <token> parameter is used to specify the
-       origin of the PING command when forwared in the network, but this
+       origin of the PING command when forwarded in the network, but this
        is not the case: the sender is specified using the prefix as usual,
        and the parameter is used to identify the PONG reply in practice.
 
@@ -256,7 +256,7 @@ General Commands
        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
+       All user and channel "modes" are indicated by single case-sensitive
        characters.
        .
        Please note that a user can only get and set his own modes, and not
@@ -615,7 +615,7 @@ Channel Commands
 - LIST
        LIST [<channel>[,<channel>[,...]] [<server>]]
        .
-       List all visible <channels> (comma-seperated list).
+       List all visible <channels> (comma-separated list).
        .
        If <server> is given, the command will be forwarded to <server> for
        evaluation.
@@ -635,7 +635,7 @@ Channel Commands
 - TOPIC
        TOPIC <channel> [<topic>]
        .
-       Cchange or view the topic of a channel.
+       Change or view the topic of a channel.
        .
        The topic for channel <channel> is returned if there is no <topic>
        given. If the <topic> parameter is present, the topic for that
@@ -668,10 +668,13 @@ Administrative Commands
         - RFC 2812, 3.4.7 "Connect message"
 
 - DIE
-       DIE
+       DIE [<message>]
        .
        Instructs the server to shut down.
        .
+       The optional (and non-standard) <message> text is sent to each client
+       connected to this server before all connections are closed.
+       .
        To use this command, the user must be an IRC Operator.
 
        References:
@@ -694,7 +697,7 @@ Administrative Commands
        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 for <timeout> seconds. When <timoeut> is 0, it make
+       the IRC network for <timeout> seconds. When <timeout> is 0, it make
        the G-Line permanent.
        .
        If no <timeout> and no <reason> is given, the G-Line is removed.
@@ -727,7 +730,7 @@ Administrative Commands
        This command provides timed K-Lines (server-local bans).
        .
        If a client matches a K-Line, it cannot connect to this server for
-       <timeout> seconds. When <timoeut> is 0, it makes the K-Line permanent.
+       <timeout> seconds. When <timeout> is 0, it makes the K-Line permanent.
        .
        If no <timeout> and no <reason> is given, the K-Line is removed.
        .
@@ -865,6 +868,8 @@ Server Protocol Commands
        .
        CHANINFO is used by servers to inform each other about a channel:
        its modes, channel key, user limits and its topic.
+       .
+       The CHANINFO command is allowed on server-links only.
 
        References:
         - IRC+, <http://ngircd.barton.de/doc/Protocol.txt>
@@ -892,20 +897,50 @@ Server Protocol Commands
        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.
+       .
+       The METADATA command is allowed on server-links only.
 
        References:
         - IRC+, <http://ngircd.barton.de/doc/Protocol.txt>
         - IRC+, doc/Protocol.txt
 
 - NJOIN
+       NJOIN <channel> [<mode>]<nick>[,[<mode>]<nick>[,...]]
+       .
+       The NJOIN command is used on server-links to add users with <nick>
+       and <mode> to a <channel> while peering.
+       .
+       The NJOIN command is allowed on server-links only.
+
+       References:
+        - RFC 2813, 4.2.2 "Njoin message"
 
 - SERVER
+       SERVER <servername> <info>
+       SERVER <servername> <hopcount> <info>
+       SERVER <servername> <hopcount> <token> <info>
+       .
+       The first form registers the local connection as a new server in the
+       network, the second (RFC 1459) and third (RFC 2812) form announce a
+       new remote server in the network.
+       .
+       The SERVER command is allowed on unregistered or server-links only.
+
+       References:
+        - RFC 1459, 4.1.4 "Server message"
+        - RFC 2813, 4.1.2 "Server message"
 
 - SQUIT
-       SQUIT <server>
+       SQUIT <server> <comment>
        .
        Disconnects an IRC Server from the network.
+       .
+       This command is used on server-links, but can be used by IRC Operators
+       to forcefully disconnect servers from the network, too.
 
+       References:
+        - RFC 2812, 3.1.8 "Squit"
+        - RFC 2813, 4.1.6 "Server quit message"
 
 Dummy Commands
 ~~~~~~~~~~~~~~
@@ -934,5 +969,19 @@ Dummy Commands
         - RFC 2812, 4.6 "Users"
 
 - GET
+       GET [...]
+       .
+       Fake HTTP GET command. When received, the connection is shut down
+       immediately again to protect against crazy web browsers ...
+
+       References:
+        - ngIRCd GIT commit 33e8c2480649
 
 - POST
+       POST [...]
+       .
+       Fake HTTP POST command. When received, the connection is shut down
+       immediately again to protect against crazy web browsers ...
+
+       References:
+        - ngIRCd GIT commit 33e8c2480649