X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2FCommands.txt;h=2d3cab2f3892bcbda76b38e8c0254aeb4561a4f2;hb=65359ff8f722efdf24700ce05011afc0fef28924;hp=c6e063785a8fb32f73574c25ebb7e7115b5b7acd;hpb=73fded75150a72c68b4c382d90e6d7c3374d5f6c;p=ngircd-alex.git diff --git a/doc/Commands.txt b/doc/Commands.txt index c6e06378..2d3cab2f 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -46,10 +46,59 @@ Connection Handling Commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - CAP - See doc/Capabilities.txt + CAP LS + CAP LIST + CAP REQ + CAP ACK + CAP NAK + CAP CLEAR + CAP END + . + List, request, and clear "IRC Capabilities". + . + Using this command, an IRC client can request additional "IRC + capabilities" during login or later on, which influences the + communication between server and client. Normally, these commands + aren't directly used by humans, but automatically by their client + software. And please note that issuing such commands manually can + irritate the client software used, because of the "non-standard" + behavior of the server! + . + - CAP LS: list all available capabilities. + - CAP LIST: list active capabilities of this connection. + - CAP REQ: Request particular capabilities. + - CAP ACK: Acknowledge a set of capabilities to be enabled/disabled. + - CAP NAK: Reject a set of capabilities. + - CAP CLEAR: Clear all set capabilities. + - CAP END: Indicate end of capability negotiation during login, + ignored in an fully registered session. + + Please note that the must be given in a single + parameter but whitespace separated, therefore a command could look + like this: "CAP REQ :capability1 capability2 capability3" for example. + + References: + - + - + - doc/Capabilities.txt - CHARCONV - See doc/Protocol.txt + CHARCONV + . + Set client character set encoding to . + . + After receiving such a command, the server translates all message + data received from the client using the set to the + server encoding (UTF-8), and all message data which is to be sent to + the client from the server encoding (UTF-8) to . + . + This enables older clients and clients using "strange" character sets + to transparently participate in channels and direct messages to + clients using UTF-8, which should be the default today. + + References: + - + - doc/Protocol.txt - NICK NICK @@ -155,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 [[] [] + . + 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. . - Lists all server links matching , if given, - on , or the current server if 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 [ []] . - Returns statistics about the current server, or of a specified . + Show statistics and other information of type of a particular + IRC server in the network. . - STATS flags: + The following types are supported (case-insensitive): . - 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 + - 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. + . + 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 an IRC server in the network. . - Show the local time of the current server, or of a 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. + + References + - RFC 2812, 3.4.6 "Time message" - TRACE TRACE [] @@ -235,42 +342,77 @@ Status and Informational Commands of a specific , in a similar method to traceroute. - USERHOST - USERHOST + USERHOST [ [...]] + . + Show flags and the hostmasks (@) of the s, + separated by spaces. The following flags are used: . - Show the user-host of (seperated by space). - "-" means is away, - "+" means is available, - "*" indicates your connection. + - "-" 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. + . + 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. . - Show the ngIRCd version of the current server, or specified . + 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 @@ -402,6 +544,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 @@ -451,8 +605,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