Fix and extend documentation a little bit

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

diff --git a/doc/Commands.txt b/doc/Commands.txt
index c43b50e38d5a5fea58b2c9d4458f58efdb73afa7..0accc5c29d81c02369f53c244b4686cb13b1f0c9 100644 (file)
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -2,7 +2,7 @@
                      ngIRCd - Next Generation IRC Server
                            http://ngircd.barton.de/
 
                      ngIRCd - Next Generation IRC Server
                            http://ngircd.barton.de/
 

-               (c)2001-2013 Alexander Barton and Contributors.
+               (c)2001-2019 Alexander Barton and Contributors.

                ngIRCd is free software and published under the
                    terms of the GNU General Public License.
 
                ngIRCd is free software and published under the
                    terms of the GNU General Public License.
 


@@ -78,7 +78,7 @@ Connection Handling Commands
        like this: "CAP REQ :capability1 capability2 capability3" for example.
 
        References:
        like this: "CAP REQ :capability1 capability2 capability3" for example.
 
        References:

-        - <http://ircv3.atheme.org/specification/capability-negotiation-3.1>
+        - <http://ircv3.net/specs/core/capability-negotiation-3.1.html>

         - <http://ngircd.barton.de/doc/Capabilities.txt>
         - doc/Capabilities.txt
 
         - <http://ngircd.barton.de/doc/Capabilities.txt>
         - doc/Capabilities.txt
 


@@ -145,7 +145,7 @@ Connection Handling Commands
 
        Please note:
        The RFCs state that the <token> parameter is used to specify the
 
        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.
 
        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.
        .
        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
        characters.
        .
        Please note that a user can only get and set his own modes, and not


@@ -324,7 +324,7 @@ General Commands
        In addition, IRC Ops can use these two forms to specify the <target>:
        .
         - #<hostmask>
        In addition, IRC Ops can use these two forms to specify the <target>:
        .
         - #<hostmask>

-        - #<servermask>
+        - $<servermask>

        .
        The <mask> can contain the wildcard characters "*" and "?", but must
        contain at least one dot (".") and no wildcard after the last one.
        .
        The <mask> can contain the wildcard characters "*" and "?", but must
        contain at least one dot (".") and no wildcard after the last one.


@@ -380,13 +380,13 @@ Status and Informational Commands
 
        Please note that "all" IRC daemons even parse separate nicknames in
        a single parameter (like ":nick1 nick2"), and therefore ngIRCd
 
        Please note that "all" IRC daemons even parse separate nicknames in
        a single parameter (like ":nick1 nick2"), and therefore ngIRCd

-       implements this behaviour, too.
+       implements this behavior, too.

 
        References:
         - RFC 2812, 4.9 "Ison message"
 
 - LINKS
 
        References:
         - RFC 2812, 4.9 "Ison message"
 
 - LINKS

-       LINKS [[<target>] [<mask>]
+       LINKS [[<target>] <mask>]

        .
        List all servers currently registered in the network matching <mask>,
        or all servers if <mask> has been omitted, as seen by the server
        .
        List all servers currently registered in the network matching <mask>,
        or all servers if <mask> has been omitted, as seen by the server


@@ -451,17 +451,21 @@ Status and Informational Commands
        Show statistics and other information of type <query> of a particular
        IRC server in the network.
        .
        Show statistics and other information of type <query> of a particular
        IRC server in the network.
        .

-       The following <query> types are supported (case-insensitive):
+       The following <query> types are supported (case-insensitive where
+       applicable):

        .
         - g  Network-wide bans ("G-Lines").
         - k  Server-local bans ("K-Lines").
        .
         - g  Network-wide bans ("G-Lines").
         - k  Server-local bans ("K-Lines").

-        - l  Link status (parent server and own link only).
+        - L  Link status (servers and user links).
+        - l  Link status (servers and own link).

         - m  Command usage count.
         - u  Server uptime.
        .
        <target> can be a server name, the nickname of a client connected to
        a specific server, or a mask matching a server name in the network.
        The server of the current connection is used when <target> is omitted.
         - m  Command usage count.
         - u  Server uptime.
        .
        <target> can be a server name, the nickname of a client connected to
        a specific server, or a mask matching a server name in the network.
        The server of the current connection is used when <target> is omitted.

+       .
+       To use "STATS L" the user must be an IRC Operator.

 
        References:
         - RFC 2812, 3.4.4 "Stats message"
 
        References:
         - RFC 2812, 3.4.4 "Stats message"


@@ -613,9 +617,10 @@ Channel Commands
         - RFC 2812, 3.2.8 "Kick command"
 
 - LIST
         - RFC 2812, 3.2.8 "Kick command"
 
 - LIST

-       LIST [<channel>[,<channel>[,...]] [<server>]]
+       LIST [<mask>[,<mask>[,...]] [<server>]]

        .
        .

-       List all visible <channels> (comma-seperated list).
+       List all visible channels matching the <mask> (comma-separated list),
+       or all channels when no <mask> was specified.

        .
        If <server> is given, the command will be forwarded to <server> for
        evaluation.
        .
        If <server> is given, the command will be forwarded to <server> for
        evaluation.


@@ -635,7 +640,7 @@ Channel Commands
 - TOPIC
        TOPIC <channel> [<topic>]
        .
 - 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
        .
        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 +673,13 @@ Administrative Commands
         - RFC 2812, 3.4.7 "Connect message"
 
 - DIE
         - RFC 2812, 3.4.7 "Connect message"
 
 - DIE

-       DIE
+       DIE [<message>]

        .
        Instructs the server to shut down.
        .
        .
        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:
        To use this command, the user must be an IRC Operator.
 
        References:


@@ -694,7 +702,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
        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.
        the G-Line permanent.
        .
        If no <timeout> and no <reason> is given, the G-Line is removed.


@@ -727,7 +735,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
        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.
        .
        .
        If no <timeout> and no <reason> is given, the K-Line is removed.
        .


@@ -875,7 +883,7 @@ Server Protocol Commands
 - ERROR
        ERROR [<message> [<> [...]]]
        .
 - ERROR
        ERROR [<message> [<> [...]]]
        .

-       Inform a client or a server about an error condition. The first 
+       Inform a client or a server about an error condition. The first

        parameter, if given, is logged by the server receiving the message,
        all other parameters are silently ignored.
        .
        parameter, if given, is logged by the server receiving the message,
        all other parameters are silently ignored.
        .


@@ -904,7 +912,7 @@ Server Protocol Commands
 - NJOIN
        NJOIN <channel> [<mode>]<nick>[,[<mode>]<nick>[,...]]
        .
 - NJOIN
        NJOIN <channel> [<mode>]<nick>[,[<mode>]<nick>[,...]]
        .

-       The NJOIN command is used on setver-links to add users with <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.
        and <mode> to a <channel> while peering.
        .
        The NJOIN command is allowed on server-links only.