From 4552ad5269367be15f3b38adeeb43815bcf1d558 Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Wed, 23 Jan 2013 14:51:19 +0100 Subject: Commands.txt: Fix some wording and spelling --- doc/Commands.txt | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index e9b78731..8b5425d3 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -13,8 +13,8 @@ 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 HELP command parses this file as following when a user user -issues a "HELP " command: +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 @@ -25,7 +25,8 @@ issues a "HELP " command: 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. +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: @@ -175,7 +176,7 @@ Administrative Commands IRC Service Commands -~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~ - SERVICE -- cgit 1.4.1 From 7630e8ffc636045b94699e36127bdd601137ba0e Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Wed, 23 Jan 2013 15:02:46 +0100 Subject: Commands.txt: Reorder some commands Reorder some commands and introduce new section "Connection Handling". Idea by DNS , thanks! --- doc/Commands.txt | 72 ++++++++++++++++++++++++++++++-------------------------- 1 file changed, 38 insertions(+), 34 deletions(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index 8b5425d3..c8790929 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -42,15 +42,39 @@ used without a command name: example "HELP quit" or "HELP privmsg". -General Commands -~~~~~~~~~~~~~~~~ - -- AWAY +Connection Handling Commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - CAP - CHARCONV +- NICK + +- PASS + +- PING + +- PONG + +- 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 + +- WEBIRC + + +General Commands +~~~~~~~~~~~~~~~~ + +- AWAY + - HELP HELP [] . @@ -70,36 +94,20 @@ General Commands - MODE -- NICK - - NOTICE -- PASS - -- PING - -- PONG - - PRIVMSG -- 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 - -- WALLOPS - -- WEBIRC - Status and Informational Commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +- ADMIN + ADMIN [] + . + Show administrative information about an IRC server in the network. + If no server name has been given, the local server will respond. + - INFO - ISON @@ -108,8 +116,6 @@ Status and Informational Commands - LUSERS -- METADATA - - MOTD - NAMES @@ -150,12 +156,6 @@ Channel Commands Administrative Commands ~~~~~~~~~~~~~~~~~~~~~~~ -- ADMIN - ADMIN [] - . - Show administartive information about an IRC server in the network. - If no server name has been given, the local server will respond. - - CONNECT - DIE @@ -174,6 +174,8 @@ Administrative Commands - RESTART +- WALLOPS + IRC Service Commands ~~~~~~~~~~~~~~~~~~~~ @@ -201,6 +203,8 @@ Server Protocol Commands . This command is silently ignored on non-server and non-service links. +- METADATA + - NJOIN - SERVER -- cgit 1.4.1 From 73fded75150a72c68b4c382d90e6d7c3374d5f6c Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Wed, 23 Jan 2013 15:16:33 +0100 Subject: Commands.txt: Import descriptions from "rbose/command_help" Import command description texts from the "rbose/command_help" branch, which have been written by DNS -- thanks a lot! --- doc/Commands.txt | 235 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 235 insertions(+) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index c8790929..c6e06378 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -46,16 +46,35 @@ Connection Handling Commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - CAP + See doc/Capabilities.txt - CHARCONV + See 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 [] @@ -66,14 +85,28 @@ Connection Handling Commands 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 [] @@ -93,10 +126,29 @@ General Commands - 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 @@ -109,72 +161,239 @@ Status and Informational Commands If no server name has been given, the local server will respond. - INFO + INFO [] + . + Show the version, birth & online time of the current IRC server. + If has been given, it shows the INFO of the specific . - 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. - LINKS + LINKS [ []] + . + Lists all server links matching , if given, + on , or the current server if omitted. - LUSERS + LUSERS [ []] + . + Return statistics about the size of the network. If called with no + arguments, the statistics will reflect the entire network. + . + 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. - MOTD + MOTD [] + . + Show "Message Of The Day" of the current server or specified . - NAMES + NAMES [ []] + . + Returns a list of who is on the comma-separated list of , + by channel name. + . + 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. - STATS + STATS [] + . + Returns statistics about the current server, or of a specified . + . + STATS flags: + . + 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 - TIME + TIME [] + . + Show the local time of the current server, or of a specified . - 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 the user-host of (seperated by space). + "-" means is away, + "+" means is available, + "*" indicates your connection. - VERSION + VERSION [] + . + Show the ngIRCd version of the current server, or specified . - WHO + WHO [ ["o"]] + . + Returns a list of users who match (nick, hostmask or channel). + . + If the flag "o" is given, the server will only return information about + IRC Operators. - WHOIS + WHOIS [] + . + Returns information about the comma-separated list of . + . + If is given, the command is forwarded to it for processing. - WHOWAS + WHOWAS [ []] + . + Used to return information about that are no longer in use + (due to client disconnection, or nickname changes). + . + 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. 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 @@ -193,6 +412,12 @@ 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 [ [<> [...]]] @@ -204,12 +429,22 @@ Server Protocol Commands 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 -- cgit 1.4.1 From 18ecc2fd811d3419c597fc31663f3f4a0e14824b Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 3 Feb 2013 18:59:44 +0100 Subject: Commands.txt: Add description for the "CAP" command --- doc/Commands.txt | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index c6e06378..ac77c650 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -46,7 +46,41 @@ 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 -- cgit 1.4.1 From b7690a0add0d46f952cc44ce522bb0e2e802b24c Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 3 Feb 2013 19:02:42 +0100 Subject: Commands.txt: Add description for the "CHARCONV" command --- doc/Commands.txt | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index ac77c650..431a410a 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -83,7 +83,22 @@ Connection Handling Commands - 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 -- cgit 1.4.1 From a4daa613ae4ce3c87b1f711d7700383fac591f16 Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 10 Feb 2013 00:18:36 +0100 Subject: Commands.txt: Update description of the "ADMIN" command --- doc/Commands.txt | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index 431a410a..177b22ed 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -204,10 +204,16 @@ 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 connecion is used when is omitted. + + References: + - RFC 2812, 3.4.9 "Admin command" - INFO INFO [] -- cgit 1.4.1 From 8212b730c707da88dcadd6384a5ecd559a2b393f Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 10 Feb 2013 00:19:20 +0100 Subject: Commands.txt: Update description of the "INFO" command --- doc/Commands.txt | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index 177b22ed..ac455b30 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -216,10 +216,16 @@ Status and Informational Commands - RFC 2812, 3.4.9 "Admin command" - INFO - INFO [] + INFO [] . - Show the version, birth & online time of the current IRC server. - If has been given, it shows the INFO of the specific . + 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 connecion is used when is omitted. + + References: + - RFC 2812, 3.4.10 "Info command" - ISON ISON -- cgit 1.4.1 From 13740c1bf4518c2d82476948f43d675524c42221 Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 10 Feb 2013 00:19:41 +0100 Subject: Commands.txt: Update description of the "ISON" command --- doc/Commands.txt | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index ac455b30..0f3fdbb0 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -228,14 +228,19 @@ Status and Informational Commands - 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 nicknes 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 [ []] -- cgit 1.4.1 From 02e24f5d1e6f098f2452f344331871a9d9a64280 Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 10 Feb 2013 00:19:59 +0100 Subject: Commands.txt: Update description of the "LINKS" command --- doc/Commands.txt | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index 0f3fdbb0..2c357928 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -243,10 +243,17 @@ Status and Informational Commands - 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 [ []] -- cgit 1.4.1 From a7023113e7546e3b278f753f0d38161f11afdb79 Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 10 Feb 2013 00:20:19 +0100 Subject: Commands.txt: Update description of the "LUSERS" command --- doc/Commands.txt | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index 2c357928..83f811df 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -256,15 +256,20 @@ Status and Informational Commands - 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 connecion 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 [] -- cgit 1.4.1 From e051ea06fc601f8ae8d91b3b3f360e6f6e48db70 Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 10 Feb 2013 00:20:41 +0100 Subject: Commands.txt: Update description of the "MOTD" command --- doc/Commands.txt | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index 83f811df..e92027bb 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -272,9 +272,16 @@ Status and Informational Commands - 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 connecion is used when is omitted. + + References: + - RFC 2812, 3.4.1 "Motd message" - NAMES NAMES [ []] -- cgit 1.4.1 From 1a5e08f3f6d240f865434e9274f01e6f39a704cb Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 10 Feb 2013 00:22:24 +0100 Subject: Commands.txt: Update description of the "NAMES" command --- doc/Commands.txt | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index e92027bb..e38f03f6 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -284,16 +284,23 @@ Status and Informational Commands - 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 connecion is used when is omitted. + + References: + - RFC 2812, 3.2.5 "Names message" - STATS STATS [] -- cgit 1.4.1 From 7c7fc8b5c4d6e7d6be3cf840688c3e34a8cb05a3 Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 10 Feb 2013 00:22:50 +0100 Subject: Commands.txt: Update description of the "STATS" command --- doc/Commands.txt | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index e38f03f6..2ea533a0 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -303,17 +303,25 @@ Status and Informational Commands - 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 connecion is used when is omitted. + + References: + - RFC 2812, 3.4.4 "Stats message" - TIME TIME [] -- cgit 1.4.1 From b6e6e2e1da632a022abf7530ed028ba79d453614 Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 10 Feb 2013 00:23:10 +0100 Subject: Commands.txt: Update description of the "TIME" command --- doc/Commands.txt | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index 2ea533a0..642dfb0b 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -324,9 +324,16 @@ Status and Informational Commands - 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 connecion is used when is omitted. + + References + - RFC 2812, 3.4.6 "Time message" - TRACE TRACE [] -- cgit 1.4.1 From 5b8f13a4a975a7b60d44fa2d3817409feb234f16 Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 10 Feb 2013 00:23:27 +0100 Subject: Commands.txt: Update description of the "USERHOST" command --- doc/Commands.txt | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index 642dfb0b..f23d99d8 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -342,12 +342,17 @@ 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, + seperated 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 [] -- cgit 1.4.1 From 6ed3b6f85c6cfa25d1607a8efa51a82ad7a8e012 Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 10 Feb 2013 00:23:43 +0100 Subject: Commands.txt: Update description of the "VERSION" command --- doc/Commands.txt | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index f23d99d8..6889039c 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -355,9 +355,22 @@ Status and Informational Commands - RFC 2812, 4.8 "Userhost message" - VERSION - VERSION [] + VERSION [] . - Show the ngIRCd version of the current server, or specified . + 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 connecion 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"]] -- cgit 1.4.1 From 19cb29da514a397268f2965c08496a7b6ff89aa0 Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 10 Feb 2013 00:23:59 +0100 Subject: Commands.txt: Update description of the "WHO" command --- doc/Commands.txt | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index 6889039c..f21073ab 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -373,13 +373,18 @@ Status and Informational Commands - 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 [] . -- cgit 1.4.1 From 78978994dfeab446f45817ec78c0e1c9aced3acc Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 10 Feb 2013 00:24:14 +0100 Subject: Commands.txt: Update description of the "WHOIS" command --- doc/Commands.txt | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index f21073ab..1f86cef7 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -386,11 +386,17 @@ Status and Informational Commands - 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 connecion is used when is omitted. + + References: + - RFC 2812, 3.6.2 "Whois query" - WHOWAS WHOWAS [ []] -- cgit 1.4.1 From 45ab73ac81ac8167b7e3b2efde6ec2c54127fa68 Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 10 Feb 2013 00:24:34 +0100 Subject: Commands.txt: Update description of the "WHOWAS" command --- doc/Commands.txt | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index 1f86cef7..3d9363e6 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -399,14 +399,20 @@ Status and Informational Commands - 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 connecion is used when is omitted. + + References: + - RFC 2812, 3.6.3 "Whowas" Channel Commands -- cgit 1.4.1 From e90d30a2cc30cddd797602dcc63adebdec8d0538 Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 10 Feb 2013 00:24:52 +0100 Subject: Commands.txt: Update description of the "SERVLIST" command --- doc/Commands.txt | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index 3d9363e6..2a4baefe 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -544,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 -- cgit 1.4.1 From 35452b31579174e0714ff7912a5857b82c787804 Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 10 Feb 2013 00:25:09 +0100 Subject: Commands.txt: Update description of the "SUMMON" command --- doc/Commands.txt | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index 2a4baefe..627efa5b 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -605,6 +605,16 @@ 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 -- cgit 1.4.1 From cb7e4e8679af5906069f840cca32cd365ebf26c7 Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 10 Feb 2013 00:25:19 +0100 Subject: Commands.txt: Update description of the "USERS" command --- doc/Commands.txt | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'doc') diff --git a/doc/Commands.txt b/doc/Commands.txt index 627efa5b..b282e2e7 100644 --- a/doc/Commands.txt +++ b/doc/Commands.txt @@ -617,6 +617,15 @@ Dummy Commands - 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 -- cgit 1.4.1