From aefb255452718d8b3baf6b0b861b1df778c8a993 Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Mon, 11 Feb 2013 18:42:24 +0100 Subject: [PATCH] Update list of documentation files; add Commands.txt --- doc/Commands.txt | 632 +++++++++++++++++++++++++++++++++++++++++++ documentation.php.de | 3 +- documentation.php.en | 3 +- 3 files changed, 636 insertions(+), 2 deletions(-) create mode 100644 doc/Commands.txt diff --git a/doc/Commands.txt b/doc/Commands.txt new file mode 100644 index 0000000..2d3cab2 --- /dev/null +++ b/doc/Commands.txt @@ -0,0 +1,632 @@ + + ngIRCd - Next Generation IRC Server + http://ngircd.barton.de/ + + (c)2001-2013 Alexander Barton and Contributors. + ngIRCd is free software and published under the + terms of the GNU General Public License. + + -- Commands.txt -- + + +This file lists all commands available on ngIRCd. It is written in a format +that is human readable as well as machine parseable and therefore can be used +as "help text file" of the daemon. + +In short, the daemon reads this file on startup and parses it as following +when an user issues a "HELP " command: + + 1. Search the file for a line "- ", + 2. Output all subsequent lines that start with a TAB (ASCII 9) character + to the client using NOTICE commands, treat lines containing a single "." + after the TAB as empty lines. + 3. Break at the first line not starting with a TAB character. + +This format allows to have information to each command stored in this file +which will not be sent to an IRC user requesting help which enables us to +have additional annotations stored here which further describe the origin, +implementation details, or limits of the specific command which are not +relevant to an end-user but administrators and developers. + +A special "Intro" block is returned to the user when the HELP command is +used without a command name: + + +- Intro + This is ngIRCd, a server software for Internet Relay Chat (IRC) + networks. You can find more information about ngIRCd on its homepage: + + . + Use "HELP COMMANDS" to get a list of all available commands and + "HELP " to get help for a specific IRC command, for + example "HELP quit" or "HELP privmsg". + + +Connection Handling Commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- CAP + 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 + 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 + . + Change your nickname to . + +- PASS + PASS [] + . + Set a connection . This command must be sent before the + NICK/USER registration combination. + . + See doc/Protocol.txt for more info. + +- PING + PING [] + . + Tests the presence of a connection. A PING message results in a PONG + reply. If is specified, the message gets passed on to it. + +- PONG + PONG [] + . + This command is a reply to the PING command and works in much the + same way. + +- QUIT + QUIT [] + . + End IRC session and disconnect from the server. + . + If a has been given, it is displayed to all the + channels that you are a member of when leaving. + +- USER + USER + . + This command is used at the beginning of a connection to specify the + name, hostname, and initial user of the + connecting client. + . + may contain spaces, and thus must be prefixed with a colon. + +- WEBIRC + See doc/Protocol.txt + + +General Commands +~~~~~~~~~~~~~~~~ + +- AWAY + AWAY [] + . + Provides the server with a message to automatically send in reply to a + PRIVMSG directed at the user, but not to a channel they are on. + . + If is omitted, the away status is removed. + +- HELP + HELP [] + . + Show help information for a specific IRC . The name + is case-insensitive. + . + Use the command "HELP Commands" to get a list of all available commands. + + The HELP command isn't specified by any RFC but implemented by most + daemons. If no help text could be read in, ngIRCd outputs a list of all + implemented commands when receiving a plain "HELP" command as well as + on "HELP 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 [] + . + The MODE command is dual-purpose. It can be used to set both (user) and + modes. + . + See doc/Modes.txt for more information. + +- NOTICE + NOTICE + . + Send to (nick or channel). + . + This command works similarly to PRIVMSG, except automatic replies must + never be sent in reply to NOTICE messages. + +- PRIVMSG + PRIVMSG + . + Send to (nick or channel). + . + Common IRC clients use MSG as PRIVMSG alias. + (Some clients use "QUERY []" to open a private chat.) + + +Status and Informational Commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- ADMIN + ADMIN [] + . + Show administrative information about 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.9 "Admin command" + +- INFO + INFO [] + . + Show the version, birth & online 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.10 "Info command" + +- ISON + ISON [ [...]] + . + 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 [[] [] + . + 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 [ []] + . + Return statistics about the number of clients (users, servers, + services, ...) in the network as seen by the server . + . + 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 [] + . + 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 [[,[,...]] []] + . + 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 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 [ []] + . + Show statistics and other information of type of a particular + IRC server in the network. + . + The following types are supported (case-insensitive): + . + - 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 [] + . + 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 [] + . + Trace a path across the IRC network of the current server, or if given + of a specific , in a similar method to traceroute. + +- USERHOST + USERHOST [ [...]] + . + 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 [] + . + 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. + . + 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"]] + . + 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 [] [,[,...]] + . + Query information about users matching the parameter(s) as seen + by the server ; up to 3 are supported. + . + 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 [,[,...]] [ []] + . + 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). + . + 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 + . + Invites to . + does not have to exist, but if it does, only members of the + channel are allowed to invite other clients. + . + If the mode "+i" is set, only operators may invite + other clients. + +- JOIN + JOIN [] + . + 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. + . + If the channel(s) do not exist, then they will be created. + +- KICK + KICK [] + . + Remove from , optional with a . + . + Only operators are able to KICK. + +- LIST + LIST [ []] + . + List all visible (comma-seperated list) on the current + server. + If is given, the command will be forwarded to for + evaluation. + +- PART + PART [] + . + Leave (comma-separated list), optional with a + . + +- TOPIC + TOPIC + . + Set a for . + . + Only operators are able to set a . + + +Administrative Commands +~~~~~~~~~~~~~~~~~~~~~~~ + +- CONNECT + CONNECT [ [ [ ]]] + . + Instructs the current server, or if specified, + to connect to . + . + 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. + +- DIE + DIE + . + Instructs the server to shut down. + +- DISCONNECT + DISCONNECT [] + . + Disconnects the current server, or if specified. + To disconnect a you need to have remote oper status. + +- GLINE + GLINE : + . + 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. + . + To remove a G-Line, type "GLINE ". + To list the G-Lines, type "STATS g". + +- KILL + KILL + . + Forcibly removes from the IRC network with a . + +- KLINE + KLINE : + . + 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 remove a K-Line, type "KLINE ". + To list the K-Lines, type "STATS k". + +- OPER + OPER + . + Authenticates as an IRC operator on the current server/network. + +- REHASH + REHASH + . + Causes the server to re-read and re-process its configuration file(s). + +- RESTART + RESTART + . + Restart the server. + +- WALLOPS + WALLOPS + . + Sends to all users with user mode "+w". + + +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 + +- SVSNICK + + +Server Protocol Commands +~~~~~~~~~~~~~~~~~~~~~~~~ + +- CHANINFO + CHANINFO + [[ ] ] + . + 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. + +- 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. + . + This command is silently ignored on non-server and non-service links. + +- METADATA + METADATA + . + 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. + . + See doc/Protocol.txt for more information. + +- NJOIN + +- SERVER + +- SQUIT + SQUIT + . + Disconnects an IRC Server from the network. + + +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 + +- POST diff --git a/documentation.php.de b/documentation.php.de index f6b0f71..71b603d 100644 --- a/documentation.php.de +++ b/documentation.php.de @@ -91,6 +91,8 @@