X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;ds=sidebyside;f=doc%2FCommands.txt;h=26e37d443f09950913f3a8692fa33b860edd9cea;hb=720eb874a9397672de06055947a057db8cf62007;hp=431a410affaa4d9c92cd0d1ff0d7e5e8f936cbe0;hpb=b7690a0add0d46f952cc44ce522bb0e2e802b24c;p=ngircd-alex.git diff --git a/doc/Commands.txt b/doc/Commands.txt index 431a410a..26e37d44 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -204,78 +204,136 @@ Status and Informational Commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - ADMIN - ADMIN [] + ADMIN [] . Show administrative information about an IRC server in the network. - If no server name has been given, the local server will respond. + . + 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.9 "Admin command" - INFO - INFO [] + INFO [] + . + Show the version, birth & online time of an IRC server in the network. . - Show the version, birth & online time of the current IRC server. - If has been given, it shows the INFO of the specific . + 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.10 "Info command" - ISON - ISON + ISON [ [...]] . - Queries the server to see if the clients in the space-separated list - are currently on the network. - . - The server returns only the that are on the network in a - space-separated list. If none of the clients are on the network the - server returns an empty list. + Query online status of a list of nicknames. The server replies with + a list only containing nicknames actually connected to a server in + the network. If no nicknames of the given list are online, an empty + list is returned to the client requesting the information. + + Please note that "all" IRC daemons even parse separate nicknames in + a single parameter (like ":nick1 nick2"), and therefore ngIRCd + implements this behaviour, too. + + References: + - RFC 2812, 4.9 "Ison message" - LINKS - LINKS [ []] + LINKS [[] [] . - Lists all server links matching , if given, - on , or the current server if omitted. + List all servers currently registered in the network matching , + or all servers if has been omitted, as seen by the server + specified by or the local server when is omitted. + . + 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. + + References: + - RFC 2812, 3.4.5 "Links message" - LUSERS - LUSERS [ []] + LUSERS [ []] . - Return statistics about the size of the network. If called with no - arguments, the statistics will reflect the entire network. + Return statistics about the number of clients (users, servers, + services, ...) in the network as seen by the server . . - If is given, it will return only statistics reflecting the - masked subset of the network. - If is given, the command will be forwarded to - for evaluation. + 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. + + Please note that ngIRCd ignores the parameter entirely: it + is not possible to get information for a part of the network only. + + References: + - RFC 2812, 3.4.2 "Lusers message" - MOTD - MOTD [] + MOTD [] . - Show "Message Of The Day" of the current server or specified . + Show the "Message of the Day" (MOTD) of an IRC server in the network. + . + 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.1 "Motd message" - NAMES - NAMES [ []] + NAMES [[,[,...]] []] . - Returns a list of who is on the comma-separated list of , - by channel name. + Show the list of users that are members of a particular + (and that are visible for the client requesting this information) as + seen by the server . More than one can be given + separated by "," (but not whitespaces!). . - If is omitted, all users are shown, grouped by channel name - with all users who are not on a channel being shown as part of channel - "*". - If is specified, the command is sent to for - evaluation. + If has been omitted, all visible users are shown, grouped + by channel name, and all visible users not being members of at least + one channel are shown as members of the pseudo channel "*". + . + 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.2.5 "Names message" - STATS - STATS [] + STATS [ []] + . + Show statistics and other information of type of a particular + IRC server in the network. . - Returns statistics about the current server, or of a specified . + The following types are supported (case-insensitive): . - STATS flags: + - g Network-wide bans ("G-Lines"). + - k Server-local bans ("K-Lines"). + - l Link status (parent server and own link only). + - m Command usage count. + - u Server uptime. . - g = G-Lines (Network-wide bans) - k = K-Lines (Server-local bans) - l = Link status (Parent server and own link) - m = IRC command status (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. + + References: + - RFC 2812, 3.4.4 "Stats message" - TIME - TIME [] + TIME [] . - Show the local time of the current server, or of a specified . + Show the local time of an IRC server in the network. + . + 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.6 "Time message" - TRACE TRACE [] @@ -284,56 +342,94 @@ Status and Informational Commands of a specific , in a similar method to traceroute. - USERHOST - USERHOST + USERHOST [ [...]] . - Show the user-host of (seperated by space). - "-" means is away, - "+" means is available, - "*" indicates your connection. + Show flags and the hostmasks (@) of the s, + separated by spaces. The following flags are used: + . + - "-" The client is "away" (the mode "+a" is set on this client). + - "+" Client seems to be available, at least it isn't marked "away". + - "*" The client is an IRC operator (the mode "+o" is set). + + References: + - RFC 2812, 4.8 "Userhost message" - VERSION - VERSION [] + VERSION [] + . + Show version information about a particular IRC server in the network. . - Show the ngIRCd version of the current server, or specified . + 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. + . + Please note: in normal operation, the version number ends in a dot + (".", for example "ngIRCd-20.1."). If it ends in ".1" (for example + "ngIRCd-20.1.1", same version than before!), the server is running in + debug-mode; and if it ends in ".2", the "network sniffer" is active! + Keep your privacy in mind ... + + References: + - RFC 2812, 3.4.3 "Version message" - WHO - WHO [ ["o"]] + WHO [ ["o"]] . - Returns a list of users who match (nick, hostmask or channel). + Show a list of users who match the , or all visible users when + the has been omitted. (Special case: the "0" is + equivalent to "*") . If the flag "o" is given, the server will only return information about IRC Operators. + References: + - RFC 2812, 3.6.1 "Who query" + - WHOIS - WHOIS [] + WHOIS [] [,[,...]] . - Returns information about the comma-separated list of . + Query information about users matching the parameter(s) as seen + by the server ; up to 3 are supported. . - If is given, the command is forwarded to it for processing. + 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.6.2 "Whois query" - WHOWAS - WHOWAS [ []] + WHOWAS [,[,...]] [ []] . - Used to return information about that are no longer in use - (due to client disconnection, or nickname changes). + Query information about nicknames no longer in use in the network, + either because of nickname changes or disconnects. The history is + searched backwards, returning the most recent entry first. If there + are multiple entries, up to entries will be shown (or all of + them, if no has been given). . - If given, the server will return information from the last times - the nickname has been used. - If is given, the command is forwarded to it for processing. + 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.6.3 "Whowas" Channel Commands ~~~~~~~~~~~~~~~~ - INVITE - INVITE + INVITE . - Invites to . - does not have to exist, but if it does, only members of the - channel are allowed to invite other clients. + Invite to join channel . . - If the mode "+i" is set, only operators may invite - other clients. + does not have to exist, but if it does, only members of the + channel are allowed to invite other users. If the channel mode "+i" + is set, only channel "half-ops" (and above) may invite other clients, + and if channel mode "+V" is set, nobody can invite other users. + + References: + - RFC 2812, 3.2.7 "Invite message" - JOIN JOIN [] @@ -345,11 +441,18 @@ Channel Commands If the channel(s) do not exist, then they will be created. - KICK - KICK [] + KICK [,[,...]] [,[,...]] [] . - Remove from , optional with a . + Remove users(s) with (s) from (s). . - Only operators are able to KICK. + There must be either exactly one parameter and multiple + parameters, or as many parameters as there are + parameters. The is shown to the users being + kicked, and the nickname of the current user is used when + is omitted. + + References: + - RFC 2812, 3.2.8 "Kick command" - LIST LIST [ []] @@ -410,9 +513,16 @@ Administrative Commands To list the G-Lines, type "STATS g". - KILL - KILL + KILL + . + Forcibly remove all users with a given from the IRC + network and display the given to them. . - Forcibly removes from the IRC network with a . + This command is used internally between servers, too, for example + to disconnect duplicate 's after a "net split". + + References: + - RFC 2812, 3.7.1 "Kill message" - KLINE KLINE : @@ -451,6 +561,18 @@ IRC Service Commands - SERVICE - SERVLIST + SERVLIST [ []] + . + List all IRC services currently registered in the network. + . + The optional and parameters can be used to limit the + listing to services matching the and that are of type . + . + Please note that ngIRCd doesn't use any service types at the moment + and therefore all services are of type "0". + + References: + - RFC 2812, 3.5.1 "Servlist message" - SQUERY @@ -471,11 +593,18 @@ Server Protocol Commands - ERROR ERROR [ [<> [...]]] . - Return an error message to the server. The first parameter, if given, - will be logged by the server, all further parameters are silently - ignored. + 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. + . + This command is silently ignored on non-server and non-service links + and shouldn't be used by regular IRC clients. . - This command is silently ignored on non-server and non-service links. + The ERROR message is also sent before terminating a regular client + connection. + + References: + - RFC 2812, 3.7.4 "Error message" - METADATA METADATA @@ -500,8 +629,27 @@ Dummy Commands ~~~~~~~~~~~~~~ - SUMMON + SUMMON [ []] + . + This command was intended to call people into IRC who are directly + connected to the terminal console of the IRC server -- but is + deprecated today. Therefore ngIRCd doesn't really implement this + command and always returns an error message, regardless of the + parameters given. + + References: + - RFC 2812, 4.5 "Summon message" - USERS + USERS [] + . + This command was intended to list users directly logged in into the + console of the IRC server -- but is deprecated today. Therefore ngIRCd + doesn't really implement this command and always returns an error + message, regardless of the parameters given. + + References: + - RFC 2812, 4.6 "Users" - GET