diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Commands.txt | 282 |
1 files changed, 229 insertions, 53 deletions
diff --git a/doc/Commands.txt b/doc/Commands.txt index 7765d3a4..c43b50e3 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -97,8 +97,8 @@ Connection Handling Commands clients using UTF-8, which should be the default today. References: - - <http://ngircd.barton.de/doc/Protocol.txt> - - doc/Protocol.txt + - IRC+, <http://ngircd.barton.de/doc/Protocol.txt> + - IRC+, doc/Protocol.txt - NICK NICK <nickname> @@ -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+, <http://ngircd.barton.de/doc/Protocol.txt> + - IRC+, doc/Protocol.txt - PING PING <token> [<target>] @@ -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+, <http://ngircd.barton.de/doc/Protocol.txt> + - IRC+, doc/Protocol.txt General Commands @@ -225,6 +227,9 @@ General Commands . If <message> is omitted, the away status is removed. + References: + - RFC 2812, 4.1 "Away" + - HELP HELP [<command>] . @@ -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 <nickname> <flags> (user) - MODE <channel> <flags> [<args>] + MODE <nickname> [{+|-}<mode>[<mode>] [{+|-}<mode>[<mode>] [...]]] + MODE <channel> [{+|-}<mode>[<mode>] [<arg> [<arg> [...]]] [{+|-}<mode>[<mode>] [<arg> [<arg> [...]]] [...]]] + . + 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 chnnel "modes" are indicated by single case-sensitive + characters. . - The MODE command is dual-purpose. It can be used to set both (user) and - <channel> 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: + . + {+|-}<mode(s}> -- set or unset one or more modes. + +<mode(s)> -<mode(s)> -- set some modes and unset others. + +<modes> <arg1> <arg2> -- 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: <http://ngircd.barton.de/doc/Modes.txt>. + + References: + - RFC 2811, 4. "Channel Modes" + - RFC 2812, 3.1.5 "User mode message" + - RFC 2812, 3.2.3 "Channel mode message" + - <http://ngircd.barton.de/doc/Modes.txt> + - doc/Modes.txt - NOTICE NOTICE <target>[,<target>[,...]] <message> @@ -443,10 +479,19 @@ Status and Informational Commands - RFC 2812, 3.4.6 "Time message" - TRACE - TRACE [<server>] + TRACE [<target>] + . + 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 <server>, in a similar method to traceroute. + <target> 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 <target> is omitted. + + References: + - RFC 2812, 3.4.8 "Trace message" - USERHOST USERHOST <nickname> [<nickname> [...]] @@ -539,13 +584,19 @@ Channel Commands - RFC 2812, 3.2.7 "Invite message" - JOIN - JOIN <channels> [<channel-keys>] + JOIN {<channel>[,<channel>[,...]] [<key>[,<key>[,...]]] | 0} . - Makes the client join the <channels> (comma-separated list), specifying - the passwords, if needed, in the comma-separated <channel-keys> list. - A <channel-key> is only needed, if the <channel> mode "+k" is set. + Makes the client join the <channel> (comma-separated list), specifying + the channel keys ("passwords"). A <channel-key> is only needed if the + <channel> 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 <channel>[,<channel>[,...]] <nickname>[,<nickname>[,...]] [<reason>] @@ -562,62 +613,99 @@ Channel Commands - RFC 2812, 3.2.8 "Kick command" - LIST - LIST [<channels> [<server>]] + LIST [<channel>[,<channel>[,...]] [<server>]] + . + List all visible <channels> (comma-seperated list). . - List all visible <channels> (comma-seperated list) on the current - server. If <server> is given, the command will be forwarded to <server> for evaluation. + References: + - RFC 2812, 3.2.6 "List message" + - PART - PART <channels> [<part-message>] + PART <channel>[,<channel>[,...]] [<part-message>] . - Leave <channels> (comma-separated list), optional with a - <part-message>. + Leave <channel> (comma-separated list), optionally with sending a + <part-message> to all the other channel members. + + References: + - RFC 2812, 3.2.2 "Part message" - TOPIC - TOPIC <channel> <topic> + TOPIC <channel> [<topic>] . - Set a <topic> for <channel>. + Cchange or view the topic of a channel. . - Only <channel> operators are able to set a <topic>. + The topic for channel <channel> is returned if there is no <topic> + given. If the <topic> parameter is present, the topic for that + channel will be changed, if this action is allowed for the user + requesting it. If the <topic> 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 <target server> [<port> [<remote server> [<mypwd> <peerpwd>]]] + CONNECT <server> [<port> [<remote-server> [<my-pwd> <peer-pwd>]]] + . + Instructs the current server, or <remote-server> if specified, + to connect to the server named <server>, which must be configured + in the server configuration file. . - Instructs the current server, or <remote server> if specified, - to connect to <target server>. + To use this command, the user must be an IRC Operator. To establish + a connection on a <remote-server>, you must have remote IRC operator + privileges. . - To connect <remote server> you need to have remote oper status. - If <port> is omitted, it uses the server port of the configuration. - If <mypwd> and <peerpwd> is given, it uses those passwords instead - of the ones in the configuration. + If <port>, <my-pwd> and <peer-pwd> 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 [<remote server>] + DISCONNECT <server> . - Disconnects the current server, or <remote server> if specified. - To disconnect a <remote server> you need to have remote oper status. + Disconnect and disable a locally linked server. + . + 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 <nick!user@hostmask> <seconds> :<reason> + GLINE <nick!user@hostmask> [<timeout> :<reason>] + . + 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 <seconds>, it makes the G-Line - permanent. + the IRC network for <timeout> seconds. When <timoeut> is 0, it make + the G-Line permanent. + . + If no <timeout> and no <reason> is given, the G-Line is removed. . - To remove a G-Line, type "GLINE <nick!user@hostmask>". - To list the G-Lines, type "STATS g". + 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 <nickname> <reason> @@ -627,40 +715,78 @@ Administrative Commands . This command is used internally between servers, too, for example to disconnect duplicate <nickname>'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 <nick!user@hostmask> <seconds> :<reason> + KLINE <nick!user@hostmask> [<timeout> :<reason>] + . + This command provides timed K-Lines (server-local bans). . - 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 <seconds>, it makes the K-Line permanent. + If a client matches a K-Line, it cannot connect to this server for + <timeout> seconds. When <timoeut> is 0, it makes the K-Line permanent. . - To remove a K-Line, type "KLINE <nick!user@hostmask>". - To list the K-Lines, type "STATS k". + If no <timeout> and no <reason> is given, the K-Line is removed. + . + 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 <user> <password> + OPER <name> <password> + . + Authenticates a user named <name> as an IRC operator on the current + server/network. + . + This operator <name> must be configured in the server configuration. . - Authenticates <user> as an IRC operator on the current server/network. + Please note that <name> 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 <message> . Sends <message> 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 +866,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+, <http://ngircd.barton.de/doc/Protocol.txt> + - IRC+, doc/Protocol.txt - ERROR ERROR [<message> [<> [...]]] @@ -765,17 +895,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+, <http://ngircd.barton.de/doc/Protocol.txt> + - IRC+, doc/Protocol.txt - NJOIN + NJOIN <channel> [<mode>]<nick>[,[<mode>]<nick>[,...]] + . + The NJOIN command is used on setver-links to add users with <nick> + and <mode> to a <channel> while peering. + . + The NJOIN command is allowed on server-links only. + + References: + - RFC 2813, 4.2.2 "Njoin message" - SERVER + SERVER <servername> <info> + SERVER <servername> <hopcount> <info> + SERVER <servername> <hopcount> <token> <info> + . + 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 <server> + SQUIT <server> <comment> . 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 +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 |