X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=doc%2FCommands.txt;h=c4bd3a111852c0178077d64e911a9877a9762845;hp=7765d3a440cc6fe4431081b10b34120d426defa8;hb=d9f81ac66942000861d46cd33708585a729b1207;hpb=659d1264607e780708ace76181b0dc556b54e39a diff --git a/doc/Commands.txt b/doc/Commands.txt index 7765d3a4..c4bd3a11 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -78,7 +78,7 @@ Connection Handling Commands like this: "CAP REQ :capability1 capability2 capability3" for example. References: - - + - - - doc/Capabilities.txt @@ -97,8 +97,8 @@ Connection Handling Commands clients using UTF-8, which should be the default today. References: - - - - doc/Protocol.txt + - IRC+, + - IRC+, doc/Protocol.txt - NICK NICK @@ -129,7 +129,8 @@ Connection Handling Commands - RFC 1459, 4.1.1 "Password message" (old client and server protocol) - RFC 2812, 3.1.1 "Password message" (client protocol) - RFC 2813, 4.1.1 "Password message" (server protocol) - - doc/Protocol.txt + - IRC+, + - IRC+, doc/Protocol.txt - PING PING [] @@ -144,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. @@ -211,7 +212,8 @@ Connection Handling Commands unauthorized clients to fake their identity; it is an arbitrary string. References: - - doc/Protocol.txt, II.4: "Update webchat/proxy client information" + - IRC+, + - IRC+, doc/Protocol.txt General Commands @@ -225,6 +227,9 @@ General Commands . If is omitted, the away status is removed. + References: + - RFC 2812, 4.1 "Away" + - HELP HELP [] . @@ -241,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. - - MODE - MODE (user) - MODE [] + MODE [{+|-}[] [{+|-}[] [...]]] + MODE [{+|-}[] [ [ [...]]] [{+|-}[] [ [ [...]]] [...]]] + . + 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 - 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: + . + {+|-} -- set or unset one or more modes. + + - -- set some modes and unset others. + + -- 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: . + + References: + - RFC 2811, 4. "Channel Modes" + - RFC 2812, 3.1.5 "User mode message" + - RFC 2812, 3.2.3 "Channel mode message" + - + - doc/Modes.txt - NOTICE NOTICE [,[,...]] @@ -288,7 +324,7 @@ General Commands In addition, IRC Ops can use these two forms to specify the : . - # - - # + - $ . The can contain the wildcard characters "*" and "?", but must contain at least one dot (".") and no wildcard after the last one. @@ -344,7 +380,7 @@ Status and Informational Commands 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" @@ -415,17 +451,21 @@ Status and Informational Commands Show statistics and other information of type of a particular IRC server in the network. . - The following types are supported (case-insensitive): + The following types are supported (case-insensitive where + applicable): . - 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. . 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 is omitted. + . + To use "STATS L" the user must be an IRC Operator. References: - RFC 2812, 3.4.4 "Stats message" @@ -443,10 +483,19 @@ Status and Informational Commands - RFC 2812, 3.4.6 "Time message" - TRACE - TRACE [] + TRACE [] + . + 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 , in a similar method to traceroute. + 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 is omitted. + + References: + - RFC 2812, 3.4.8 "Trace message" - USERHOST USERHOST [ [...]] @@ -539,13 +588,19 @@ Channel Commands - RFC 2812, 3.2.7 "Invite message" - JOIN - JOIN [] + JOIN {[,[,...]] [[,[,...]]] | 0} . - 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. + Makes the client join the (comma-separated list), specifying + the channel keys ("passwords"). A is only needed if the + has the mode "+k" set. . 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 [,[,...]] [,[,...]] [] @@ -562,62 +617,102 @@ Channel Commands - RFC 2812, 3.2.8 "Kick command" - LIST - LIST [ []] + LIST [[,[,...]] []] + . + List all visible (comma-separated list). . - List all visible (comma-seperated list) on the current - server. If is given, the command will be forwarded to for evaluation. + References: + - RFC 2812, 3.2.6 "List message" + - PART - PART [] + PART [,[,...]] [] . - Leave (comma-separated list), optional with a - . + Leave (comma-separated list), optionally with sending a + to all the other channel members. + + References: + - RFC 2812, 3.2.2 "Part message" - TOPIC - TOPIC + TOPIC [] . - Set a for . + Change or view the topic of a channel. . - Only operators are able to set a . + The topic for channel is returned if there is no + given. If the parameter is present, the topic for that + channel will be changed, if this action is allowed for the user + requesting it. If the parameter is an empty string, the + topic for that channel will be removed. + + References: + - RFC 2812, 3.2.4 "Topic message" Administrative Commands ~~~~~~~~~~~~~~~~~~~~~~~ - CONNECT - CONNECT [ [ [ ]]] + CONNECT [ [ [ ]]] + . + Instructs the current server, or if specified, + to connect to the server named , which must be configured + in the server configuration file. . - Instructs the current server, or if specified, - to connect to . + To use this command, the user must be an IRC Operator. To establish + a connection on a , you must have remote IRC operator + privileges. . - 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. + 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 + DIE [] . Instructs the server to shut down. + . + The optional (and non-standard) 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 + . + 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. + . + If no and no is given, the G-Line is removed. + . + To use this command, the user must be an IRC Operator. . - To remove a G-Line, type "GLINE ". - To list the G-Lines, type "STATS g". + "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 @@ -627,40 +722,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. + . + If no and no is given, the K-Line is removed. . - 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 use this command, the user must be an IRC Operator. . - To remove a K-Line, type "KLINE ". - To list the K-Lines, type "STATS k". + "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 a user named as an IRC operator on the current + server/network. . - Authenticates 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 ~~~~~~~~~~~~~~~~~~~~ @@ -740,7 +873,11 @@ Server Protocol Commands 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. + The CHANINFO command is allowed on server-links only. + + References: + - IRC+, + - IRC+, doc/Protocol.txt - ERROR ERROR [ [<> [...]]] @@ -765,17 +902,49 @@ Server Protocol Commands information of clients, like the hostname, the info text ("real name"), or the user name. . - See doc/Protocol.txt for more information. + 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 ~~~~~~~~~~~~~~ @@ -804,5 +973,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