Xcode: add missing files in src/testsuite, and sort them

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

diff --git a/doc/Commands.txt b/doc/Commands.txt
index 30947c150b7d00c7c5855c722269b15c9a914ac6..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.
 


@@ -227,6 +227,9 @@ General Commands
        .
        If <message> is omitted, the away status is removed.
 
        .
        If <message> is omitted, the away status is removed.
 

+       References:
+        - RFC 2812, 4.1 "Away"
+

 - HELP
        HELP [<command>]
        .
 - HELP
        HELP [<command>]
        .


@@ -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.
 
        ngIRCd replies using "NOTICE" commands like ircd 2.10/2.11; other
        implementations are using numerics 704, 705, and 706.
 

-

 - MODE
 - MODE

-       MODE <nickname> <flags> (user)
-       MODE <channel> <flags> [<args>]
+       MODE <nickname> [{+|-}<mode>[<mode>] [{+|-}<mode>[<mode>] [...]]]
+       MODE <channel> [{+|-}<mode>[<mode>] [<arg> [<arg> [...]]] [{+|-}<mode>[<mode>] [<arg> [<arg> [...]]] [...]]]
+       .
+       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 channel "modes" are indicated by single case-sensitive
+       characters.

        .
        .

-       The MODE command is dual-purpose. It can be used to set both (user) and
-       <channel> 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:
+       .
+         {+|-}<mode(s}>  -- set or unset one or more modes.
+         +<mode(s)> -<mode(s)>  -- set some modes and unset others.
+         +<modes> <arg1> <arg2>  -- 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: <http://ngircd.barton.de/doc/Modes.txt>.
+
+       References:
+        - RFC 2811, 4. "Channel Modes"
+        - RFC 2812, 3.1.5 "User mode message"
+        - RFC 2812, 3.2.3 "Channel mode message"
+        - <http://ngircd.barton.de/doc/Modes.txt>
+        - doc/Modes.txt

 
 - NOTICE
        NOTICE <target>[,<target>[,...]] <message>
 
 - NOTICE
        NOTICE <target>[,<target>[,...]] <message>


@@ -290,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.


@@ -346,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


@@ -417,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"


@@ -445,10 +483,19 @@ Status and Informational Commands
         - RFC 2812, 3.4.6 "Time message"
 
 - TRACE
         - RFC 2812, 3.4.6 "Time message"
 
 - TRACE

-       TRACE [<server>]
+       TRACE [<target>]
+       .
+       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.

        .
        .

-       Trace a path across the IRC network of the current server, or if given
-       of a specific <server>, in a similar method to traceroute.
+       <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.
+
+       References:
+        - RFC 2812, 3.4.8 "Trace message"

 
 - USERHOST
        USERHOST <nickname> [<nickname> [...]]
 
 - USERHOST
        USERHOST <nickname> [<nickname> [...]]


@@ -541,13 +588,19 @@ Channel Commands
         - RFC 2812, 3.2.7 "Invite message"
 
 - JOIN
         - RFC 2812, 3.2.7 "Invite message"
 
 - JOIN

-       JOIN <channels> [<channel-keys>]
+       JOIN {<channel>[,<channel>[,...]] [<key>[,<key>[,...]]] | 0}

        .
        .

-       Makes the client join the <channels> (comma-separated list), specifying
-       the passwords, if needed, in the comma-separated <channel-keys> list.
-       A <channel-key> is only needed, if the <channel> mode "+k" is set.
+       Makes the client join the <channel> (comma-separated list), specifying
+       the channel keys ("passwords"). A <channel-key> is only needed if the
+       <channel> has the mode "+k" set.

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


@@ -564,62 +617,103 @@ Channel Commands
         - RFC 2812, 3.2.8 "Kick command"
 
 - LIST
         - RFC 2812, 3.2.8 "Kick command"
 
 - LIST

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

        .
        .

-       List all visible <channels> (comma-seperated list) on the current
-       server.

        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.
 

+       References:
+        - RFC 2812, 3.2.6 "List message"
+

 - PART
 - PART

-       PART <channels> [<part-message>]
+       PART <channel>[,<channel>[,...]] [<part-message>]

        .
        .

-       Leave <channels> (comma-separated list), optional with a
-       <part-message>.
+       Leave <channel> (comma-separated list), optionally with sending a
+       <part-message> to all the other channel members.
+
+       References:
+        - RFC 2812, 3.2.2 "Part message"

 
 - TOPIC
 
 - TOPIC

-       TOPIC <channel> <topic>
+       TOPIC <channel> [<topic>]

        .
        .

-       Set a <topic> for <channel>.
+       Change or view the topic of a channel.

        .
        .

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

 
 
 Administrative Commands
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 - CONNECT
 
 
 Administrative Commands
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 - CONNECT

-       CONNECT <target server> [<port> [<remote server> [<mypwd> <peerpwd>]]]
+       CONNECT <server> [<port> [<remote-server> [<my-pwd> <peer-pwd>]]]

        .
        .

-       Instructs the current server, or <remote server> if specified,
-       to connect to <target server>.
+       Instructs the current server, or <remote-server> if specified,
+       to connect to the server named <server>, which must be configured
+       in the server configuration file.

        .
        .

-       To connect <remote server> you need to have remote oper status.
-       If <port> is omitted, it uses the server port of the configuration.
-       If <mypwd> and <peerpwd> 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 <remote-server>, you must have remote IRC operator
+       privileges.
+       .
+       If <port>, <my-pwd> and <peer-pwd> are given, these values override
+       the ones specified in the server configuration file.
+
+       References:
+        - RFC 2812, 3.4.7 "Connect message"

 
 - DIE
 
 - 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:
+        - RFC 2812, 4.3 "Die message"

 
 - DISCONNECT
 
 - DISCONNECT

-       DISCONNECT [<remote server>]
+       DISCONNECT <server>

        .
        .

-       Disconnects the current server, or <remote server> if specified.
-       To disconnect a <remote server> you need to have remote oper status.
+       Disconnect and disable a locally linked server.
+       .
+       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 <nick!user@hostmask> <seconds> :<reason>
+       GLINE <nick!user@hostmask> [<timeout> :<reason>]
+       .
+       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
        If a client matches a G-Line, it cannot connect to any server on

-       the IRC network. If you put 0 as <seconds>, it makes the G-Line
-       permanent.
+       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.

        .
        .

-       To remove a G-Line, type "GLINE <nick!user@hostmask>".
-       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 <nickname> <reason>
 
 - KILL
        KILL <nickname> <reason>


@@ -629,40 +723,78 @@ Administrative Commands
        .
        This command is used internally between servers, too, for example
        to disconnect duplicate <nickname>'s after a "net split".
        .
        This command is used internally between servers, too, for example
        to disconnect duplicate <nickname>'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
 
        References:
         - RFC 2812, 3.7.1 "Kill message"
 
 - KLINE

-       KLINE <nick!user@hostmask> <seconds> :<reason>
+       KLINE <nick!user@hostmask> [<timeout> :<reason>]
+       .
+       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 <timeout> 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 <seconds>, it makes the K-Line permanent.
+       If no <timeout> and no <reason> is given, the K-Line is removed.

        .
        .

-       To remove a K-Line, type "KLINE <nick!user@hostmask>".
-       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 <user> <password>
+       OPER <name> <password>
+       .
+       Authenticates a user named <name> as an IRC operator on the current
+       server/network.
+       .
+       This operator <name> must be configured in the server configuration.

        .
        .

-       Authenticates <user> as an IRC operator on the current server/network.
+       Please note that <name> 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).
 
 - 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.
 
 - 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 <message>
        .
        Sends <message> to all users with user mode "+w".
 
 - WALLOPS
        WALLOPS <message>
        .
        Sends <message> 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
 ~~~~~~~~~~~~~~~~~~~~
 
 IRC Service Commands
 ~~~~~~~~~~~~~~~~~~~~


@@ -741,6 +873,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.
        .
        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>
 
        References:
         - IRC+, <http://ngircd.barton.de/doc/Protocol.txt>


@@ -749,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.
        .


@@ -768,20 +902,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 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
 
        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

+       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

-       SQUIT <server>
+       SQUIT <server> <comment>

        .
        Disconnects an IRC Server from the network.
        .
        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
 ~~~~~~~~~~~~~~
 
 Dummy Commands
 ~~~~~~~~~~~~~~


@@ -810,5 +974,19 @@ Dummy Commands
         - RFC 2812, 4.6 "Users"
 
 - GET
         - 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

+       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