X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=doc%2FCommands.txt;h=e049f5ef88f2e3434d6cbe00995db70f0bbfe7b0;hp=49a84f654c984e8222ad7e4af92755e6b23e2331;hb=212d99146d4a3681976450b5ff0dfa57e1d2e44f;hpb=24183b1a918d7475f9fac28a10c6ae49c93e24b3 diff --git a/doc/Commands.txt b/doc/Commands.txt index 49a84f65..e049f5ef 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -145,7 +145,7 @@ Connection Handling Commands Please note: The RFCs state that the 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 [[,[,...]] []] . - List all visible (comma-seperated list). + List all visible (comma-separated list). . If is given, the command will be forwarded to for evaluation. @@ -635,7 +635,7 @@ Channel Commands - TOPIC TOPIC [] . - Cchange or view the topic of a channel. + Change or view the topic of a channel. . The topic for channel is returned if there is no given. If the parameter is present, the topic for that @@ -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. . - To remove a G-Line, type "GLINE ". - To list the G-Lines, type "STATS g". + If no and no is given, the G-Line is removed. + . + 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 as an IRC operator on the current server/network. + Authenticates a user named as an IRC operator on the current + server/network. + . + This operator must be configured in the server configuration. + . + 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 ~~~~~~~~~~~~~~~~~~~~ @@ -803,6 +865,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+, @@ -830,20 +894,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+, - IRC+, doc/Protocol.txt - NJOIN + NJOIN [][,[][,...]] + . + The NJOIN command is used on server-links to add users with + and to a while peering. + . + The NJOIN command is allowed on server-links only. + + References: + - RFC 2813, 4.2.2 "Njoin message" - SERVER + SERVER + SERVER + SERVER + . + 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 . 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 ~~~~~~~~~~~~~~ @@ -872,5 +966,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