2 ngIRCd - Next Generation IRC Server
3 http://ngircd.barton.de/
5 (c)2001-2013 Alexander Barton and Contributors.
6 ngIRCd is free software and published under the
7 terms of the GNU General Public License.
12 This file lists all commands available on ngIRCd. It is written in a format
13 that is human readable as well as machine parseable and therefore can be used
14 as "help text file" of the daemon.
16 In short, the daemon reads this file on startup and parses it as following
17 when an user issues a "HELP <cmd>" command:
19 1. Search the file for a line "- <cmd>",
20 2. Output all subsequent lines that start with a TAB (ASCII 9) character
21 to the client using NOTICE commands, treat lines containing a single "."
22 after the TAB as empty lines.
23 3. Break at the first line not starting with a TAB character.
25 This format allows to have information to each command stored in this file
26 which will not be sent to an IRC user requesting help which enables us to
27 have additional annotations stored here which further describe the origin,
28 implementation details, or limits of the specific command which are not
29 relevant to an end-user but administrators and developers.
31 A special "Intro" block is returned to the user when the HELP command is
32 used without a command name:
36 This is ngIRCd, a server software for Internet Relay Chat (IRC)
37 networks. You can find more information about ngIRCd on its homepage:
38 <http://ngircd.barton.de>
40 Use "HELP COMMANDS" to get a list of all available commands and
41 "HELP <command-name>" to get help for a specific IRC command, for
42 example "HELP quit" or "HELP privmsg".
45 Connection Handling Commands
46 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51 CAP REQ <capabilities>
52 CAP ACK <capabilities>
53 CAP NAK <capabilities>
57 List, request, and clear "IRC Capabilities".
59 Using this command, an IRC client can request additional "IRC
60 capabilities" during login or later on, which influences the
61 communication between server and client. Normally, these commands
62 aren't directly used by humans, but automatically by their client
63 software. And please note that issuing such commands manually can
64 irritate the client software used, because of the "non-standard"
65 behavior of the server!
67 - CAP LS: list all available capabilities.
68 - CAP LIST: list active capabilities of this connection.
69 - CAP REQ: Request particular capabilities.
70 - CAP ACK: Acknowledge a set of capabilities to be enabled/disabled.
71 - CAP NAK: Reject a set of capabilities.
72 - CAP CLEAR: Clear all set capabilities.
73 - CAP END: Indicate end of capability negotiation during login,
74 ignored in an fully registered session.
76 Please note that the <capabilities> must be given in a single
77 parameter but whitespace separated, therefore a command could look
78 like this: "CAP REQ :capability1 capability2 capability3" for example.
81 - <http://ircv3.atheme.org/specification/capability-negotiation-3.1>
82 - <http://ngircd.barton.de/doc/Capabilities.txt>
83 - doc/Capabilities.txt
86 CHARCONV <client-charset>
88 Set client character set encoding to <client-charset>.
90 After receiving such a command, the server translates all message
91 data received from the client using the set <client-charset> to the
92 server encoding (UTF-8), and all message data which is to be sent to
93 the client from the server encoding (UTF-8) to <client-charset>.
95 This enables older clients and clients using "strange" character sets
96 to transparently participate in channels and direct messages to
97 clients using UTF-8, which should be the default today.
100 - <http://ngircd.barton.de/doc/Protocol.txt>
106 Change your nickname to <nick>.
109 PASS <password> <version> <flags> [<options>]
111 Set a connection <password>. This command must be sent before the
112 NICK/USER registration combination.
114 See doc/Protocol.txt for more info.
117 PING <server1> [<server2>]
119 Tests the presence of a connection. A PING message results in a PONG
120 reply. If <server2> is specified, the message gets passed on to it.
123 PONG <server1> [<server2>]
125 This command is a reply to the PING command and works in much the
129 QUIT [<quit-message>]
131 End IRC session and disconnect from the server.
133 If a <quit-message> has been given, it is displayed to all the
134 channels that you are a member of when leaving.
137 USER <user> <modes> <realname>
139 This command is used at the beginning of a connection to specify the
140 <user>name, hostname, <realname> and initial user <modes> of the
143 <realname> may contain spaces, and thus must be prefixed with a colon.
155 Provides the server with a message to automatically send in reply to a
156 PRIVMSG directed at the user, but not to a channel they are on.
158 If <message> is omitted, the away status is removed.
163 Show help information for a specific IRC <command>. The <command> name
166 Use the command "HELP Commands" to get a list of all available commands.
168 The HELP command isn't specified by any RFC but implemented by most
169 daemons. If no help text could be read in, ngIRCd outputs a list of all
170 implemented commands when receiving a plain "HELP" command as well as
173 ngIRCd replies using "NOTICE" commands like ircd 2.10/2.11; other
174 implementations are using numerics 704, 705, and 706.
178 MODE <nickname> <flags> (user)
179 MODE <channel> <flags> [<args>]
181 The MODE command is dual-purpose. It can be used to set both (user) and
184 See doc/Modes.txt for more information.
187 NOTICE <target> <notice>
189 Send <notice> to <target> (nick or channel).
191 This command works similarly to PRIVMSG, except automatic replies must
192 never be sent in reply to NOTICE messages.
195 PRIVMSG <target> <message>
197 Send <message> to <target> (nick or channel).
199 Common IRC clients use MSG as PRIVMSG alias.
200 (Some clients use "QUERY <nick> [<message>]" to open a private chat.)
203 Status and Informational Commands
204 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
209 Show administrative information about an IRC server in the network.
211 <target> can be a server name, the nickname of a client connected to
212 a specific server, or a mask matching a server name in the network.
213 The server of the current connecion is used when <target> is omitted.
216 - RFC 2812, 3.4.9 "Admin command"
221 Show the version, birth & online time of an IRC server in the network.
223 <target> can be a server name, the nickname of a client connected to
224 a specific server, or a mask matching a server name in the network.
225 The server of the current connecion is used when <target> is omitted.
228 - RFC 2812, 3.4.10 "Info command"
231 ISON <nickname> [<nickname> [...]]
233 Query online status of a list of nicknames. The server replies with
234 a list only containing nicknes actually connected to a server in
235 the network. If no nicknames of the given list are online, an empty
236 list is returned to the client requesting the information.
238 Please note that "all" IRC daemons even parse separate nicknames in
239 a single parameter (like ":nick1 nick2"), and therefore ngIRCd
240 implements this behaviour, too.
243 - RFC 2812, 4.9 "Ison message"
246 LINKS [[<target>] [<mask>]
248 List all servers currently registered in the network matching <mask>,
249 or all servers if <mask> has been omitted, as seen by the server
250 specified by <target> or the local server when <target> is omitted.
252 <target> can be a server name, the nickname of a client connected to
253 a specific server, or a mask matching a server name in the network.
256 - RFC 2812, 3.4.5 "Links message"
259 LUSERS [<mask> [<target>]]
261 Return statistics about the number of clients (users, servers,
262 services, ...) in the network as seen by the server <target>.
264 <target> can be a server name, the nickname of a client connected to
265 a specific server, or a mask matching a server name in the network.
266 The server of the current connecion is used when <target> is omitted.
268 Please note that ngIRCd ignores the <mask> parameter entirely: it
269 is not possible to get information for a part of the network only.
272 - RFC 2812, 3.4.2 "Lusers message"
277 Show the "Message of the Day" (MOTD) of an IRC server in the network.
279 <target> can be a server name, the nickname of a client connected to
280 a specific server, or a mask matching a server name in the network.
281 The server of the current connecion is used when <target> is omitted.
284 - RFC 2812, 3.4.1 "Motd message"
287 NAMES [<channel>[,<channel>[,...]] [<target>]]
289 Show the list of users that are members of a particular <channel>
290 (and that are visible for the client requesting this information) as
291 seen by the server <target>. More than one <channel> can be given
292 separated by "," (but not whitespaces!).
294 If <channel> has been omitted, all visible users are shown, grouped
295 by channel name, and all visible users not being members of at least
296 one channel are shown as members of the pseudo channel "*".
298 <target> can be a server name, the nickname of a client connected to
299 a specific server, or a mask matching a server name in the network.
300 The server of the current connecion is used when <target> is omitted.
303 - RFC 2812, 3.2.5 "Names message"
306 STATS [<query> [<target>]]
308 Show statistics and other information of type <query> of a particular
309 IRC server in the network.
311 The following <query> types are supported (case-insensitive):
313 - g Network-wide bans ("G-Lines").
314 - k Server-local bans ("K-Lines").
315 - l Link status (parent server and own link only).
316 - m Command usage count.
319 <target> can be a server name, the nickname of a client connected to
320 a specific server, or a mask matching a server name in the network.
321 The server of the current connecion is used when <target> is omitted.
324 - RFC 2812, 3.4.4 "Stats message"
329 Show the local time of an IRC server in the network.
331 <target> can be a server name, the nickname of a client connected to
332 a specific server, or a mask matching a server name in the network.
333 The server of the current connecion is used when <target> is omitted.
336 - RFC 2812, 3.4.6 "Time message"
341 Trace a path across the IRC network of the current server, or if given
342 of a specific <server>, in a similar method to traceroute.
347 Show the user-host of <nicknames> (seperated by space).
348 "-" means <nick> is away,
349 "+" means <nick> is available,
350 "*" indicates your connection.
355 Show the ngIRCd version of the current server, or specified <server>.
360 Returns a list of users who match <target> (nick, hostmask or channel).
362 If the flag "o" is given, the server will only return information about
366 WHOIS [<server>] <nicknames>
368 Returns information about the comma-separated list of <nicknames>.
370 If <server> is given, the command is forwarded to it for processing.
373 WHOWAS <nickname> [<count> [<server>]]
375 Used to return information about <nicknames> that are no longer in use
376 (due to client disconnection, or nickname changes).
378 If given, the server will return information from the last <count> times
379 the nickname has been used.
380 If <server> is given, the command is forwarded to it for processing.
387 INVITE <nick> <channel>
389 Invites <nick> to <channel>.
390 <channel> does not have to exist, but if it does, only members of the
391 channel are allowed to invite other clients.
393 If the <channel> mode "+i" is set, only <channel> operators may invite
397 JOIN <channels> [<channel-keys>]
399 Makes the client join the <channels> (comma-separated list), specifying
400 the passwords, if needed, in the comma-separated <channel-keys> list.
401 A <channel-key> is only needed, if the <channel> mode "+k" is set.
403 If the channel(s) do not exist, then they will be created.
406 KICK <channel> <nick> [<kick-message>]
408 Remove <nick> from <channel>, optional with a <kick-message>.
410 Only <channel> operators are able to KICK.
413 LIST [<channels> [<server>]]
415 List all visible <channels> (comma-seperated list) on the current
417 If <server> is given, the command will be forwarded to <server> for
421 PART <channels> [<part-message>]
423 Leave <channels> (comma-separated list), optional with a
427 TOPIC <channel> <topic>
429 Set a <topic> for <channel>.
431 Only <channel> operators are able to set a <topic>.
434 Administrative Commands
435 ~~~~~~~~~~~~~~~~~~~~~~~
438 CONNECT <target server> [<port> [<remote server> [<mypwd> <peerpwd>]]]
440 Instructs the current server, or <remote server> if specified,
441 to connect to <target server>.
443 To connect <remote server> you need to have remote oper status.
444 If <port> is omitted, it uses the server port of the configuration.
445 If <mypwd> and <peerpwd> is given, it uses those passwords instead
446 of the ones in the configuration.
451 Instructs the server to shut down.
454 DISCONNECT [<remote server>]
456 Disconnects the current server, or <remote server> if specified.
457 To disconnect a <remote server> you need to have remote oper status.
460 GLINE <nick!user@hostmask> <seconds> :<reason>
462 This command provides timed G-Lines (Network-wide bans).
463 If a client matches a G-Line, it cannot connect to any server on
464 the IRC network. If you put 0 as <seconds>, it makes the G-Line
467 To remove a G-Line, type "GLINE <nick!user@hostmask>".
468 To list the G-Lines, type "STATS g".
473 Forcibly removes <nick> from the IRC network with a <reason>.
476 KLINE <nick!user@hostmask> <seconds> :<reason>
478 This command provides timed K-Lines (Server-local bans).
479 If a client matches a K-Line, it cannot connect to the issued server.
480 If you put 0 as <seconds>, it makes the K-Line permanent.
482 To remove a K-Line, type "KLINE <nick!user@hostmask>".
483 To list the K-Lines, type "STATS k".
486 OPER <user> <password>
488 Authenticates <user> as an IRC operator on the current server/network.
493 Causes the server to re-read and re-process its configuration file(s).
503 Sends <message> to all users with user mode "+w".
518 Server Protocol Commands
519 ~~~~~~~~~~~~~~~~~~~~~~~~
522 CHANINFO <channel> +<modes> [[<key> <limit>] <topic>]
524 CHANINFO is used by servers to inform each other about a channel:
525 its modes, channel key, user limits and its topic.
527 See doc/Protocol.txt for more information.
530 ERROR [<message> [<> [...]]]
532 Return an error message to the server. The first parameter, if given,
533 will be logged by the server, all further parameters are silently
536 This command is silently ignored on non-server and non-service links.
539 METADATA <target> <key> <value>
541 The METADATA command is used on server-links to update "metadata"
542 information of clients, like the hostname, the info text ("real name"),
545 See doc/Protocol.txt for more information.
554 Disconnects an IRC Server from the network.