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>[,<target>[,...]] <message>
189 Send a <message> to a given <target>, which can be a user or a
190 channel, but DON'T report any error.
192 The "NOTICE" command exactly behaves like the "PRIVMSG" command, but
193 doesn't report any errors it encounters (like an unknown <target>).
194 Please see the help text of the "PRIVMSG" command for a detailed
195 description of the parameters!
198 - RFC 2812, 2.3.1 "Message format in Augmented BNF"
199 - RFC 2812, 3.3 "Sending messages"
200 - RFC 2812, 3.3.2 "Notice"
203 PRIVMSG <target>[,<target>[,...]] <message>
205 Send a <message> to a given <target>, which can be a user or a
206 channel, and report all errors.
208 The <target> must follow one of these syntax variants:
212 - <user>[%<host>]@<server>
214 - <nickname>!<user>@<host>
216 If the <target> is a user, a private message is sent directly to this
217 user; if it resolves to a channel name, a public message is sent
218 to all the members of that channel.
220 In addition, IRC Ops can use these two forms to specify the <target>:
225 The <mask> can contain the wildcard characters "*" and "?", but must
226 contain at least one dot (".") and no wildcard after the last one.
227 Then, the <message> is sent to all users matching this <mask>.
229 All warnings and errors are reported back to the initiator using
230 numeric status codes, which is the only difference to the "NOTICE"
231 command, which doesn't report back any errors or warnings at all.
233 Please note that clients often use "MSG" as an alias to PRIVMSG, and
234 a command "QUERY <nick> [<message>]" to initiate private chats. Both
235 are command extensions of the client and never sent to the server.
238 - RFC 2812, 2.3.1 "Message format in Augmented BNF"
239 - RFC 2812, 3.3 "Sending messages"
240 - RFC 2812, 3.3.1 "Private messages"
242 Status and Informational Commands
243 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
248 Show administrative information about an IRC server in the network.
250 <target> can be a server name, the nickname of a client connected to
251 a specific server, or a mask matching a server name in the network.
252 The server of the current connection is used when <target> is omitted.
255 - RFC 2812, 3.4.9 "Admin command"
260 Show the version, birth & online time of an IRC server in the network.
262 <target> can be a server name, the nickname of a client connected to
263 a specific server, or a mask matching a server name in the network.
264 The server of the current connection is used when <target> is omitted.
267 - RFC 2812, 3.4.10 "Info command"
270 ISON <nickname> [<nickname> [...]]
272 Query online status of a list of nicknames. The server replies with
273 a list only containing nicknames actually connected to a server in
274 the network. If no nicknames of the given list are online, an empty
275 list is returned to the client requesting the information.
277 Please note that "all" IRC daemons even parse separate nicknames in
278 a single parameter (like ":nick1 nick2"), and therefore ngIRCd
279 implements this behaviour, too.
282 - RFC 2812, 4.9 "Ison message"
285 LINKS [[<target>] [<mask>]
287 List all servers currently registered in the network matching <mask>,
288 or all servers if <mask> has been omitted, as seen by the server
289 specified by <target> or the local server when <target> is omitted.
291 <target> can be a server name, the nickname of a client connected to
292 a specific server, or a mask matching a server name in the network.
295 - RFC 2812, 3.4.5 "Links message"
298 LUSERS [<mask> [<target>]]
300 Return statistics about the number of clients (users, servers,
301 services, ...) in the network as seen by the server <target>.
303 <target> can be a server name, the nickname of a client connected to
304 a specific server, or a mask matching a server name in the network.
305 The server of the current connection is used when <target> is omitted.
307 Please note that ngIRCd ignores the <mask> parameter entirely: it
308 is not possible to get information for a part of the network only.
311 - RFC 2812, 3.4.2 "Lusers message"
316 Show the "Message of the Day" (MOTD) of an IRC server in the network.
318 <target> can be a server name, the nickname of a client connected to
319 a specific server, or a mask matching a server name in the network.
320 The server of the current connection is used when <target> is omitted.
323 - RFC 2812, 3.4.1 "Motd message"
326 NAMES [<channel>[,<channel>[,...]] [<target>]]
328 Show the list of users that are members of a particular <channel>
329 (and that are visible for the client requesting this information) as
330 seen by the server <target>. More than one <channel> can be given
331 separated by "," (but not whitespaces!).
333 If <channel> has been omitted, all visible users are shown, grouped
334 by channel name, and all visible users not being members of at least
335 one channel are shown as members of the pseudo channel "*".
337 <target> can be a server name, the nickname of a client connected to
338 a specific server, or a mask matching a server name in the network.
339 The server of the current connection is used when <target> is omitted.
342 - RFC 2812, 3.2.5 "Names message"
345 STATS [<query> [<target>]]
347 Show statistics and other information of type <query> of a particular
348 IRC server in the network.
350 The following <query> types are supported (case-insensitive):
352 - g Network-wide bans ("G-Lines").
353 - k Server-local bans ("K-Lines").
354 - l Link status (parent server and own link only).
355 - m Command usage count.
358 <target> can be a server name, the nickname of a client connected to
359 a specific server, or a mask matching a server name in the network.
360 The server of the current connection is used when <target> is omitted.
363 - RFC 2812, 3.4.4 "Stats message"
368 Show the local time of an IRC server in the network.
370 <target> can be a server name, the nickname of a client connected to
371 a specific server, or a mask matching a server name in the network.
372 The server of the current connection is used when <target> is omitted.
375 - RFC 2812, 3.4.6 "Time message"
380 Trace a path across the IRC network of the current server, or if given
381 of a specific <server>, in a similar method to traceroute.
384 USERHOST <nickname> [<nickname> [...]]
386 Show flags and the hostmasks (<user>@<host>) of the <nickname>s,
387 separated by spaces. The following flags are used:
389 - "-" The client is "away" (the mode "+a" is set on this client).
390 - "+" Client seems to be available, at least it isn't marked "away".
391 - "*" The client is an IRC operator (the mode "+o" is set).
394 - RFC 2812, 4.8 "Userhost message"
399 Show version information about a particular IRC server in the network.
401 <target> can be a server name, the nickname of a client connected to
402 a specific server, or a mask matching a server name in the network.
403 The server of the current connection is used when <target> is omitted.
405 Please note: in normal operation, the version number ends in a dot
406 (".", for example "ngIRCd-20.1."). If it ends in ".1" (for example
407 "ngIRCd-20.1.1", same version than before!), the server is running in
408 debug-mode; and if it ends in ".2", the "network sniffer" is active!
409 Keep your privacy in mind ...
412 - RFC 2812, 3.4.3 "Version message"
417 Show a list of users who match the <mask>, or all visible users when
418 the <mask> has been omitted. (Special case: the <mask> "0" is
421 If the flag "o" is given, the server will only return information about
425 - RFC 2812, 3.6.1 "Who query"
428 WHOIS [<target>] <mask>[,<mask>[,...]]
430 Query information about users matching the <mask> parameter(s) as seen
431 by the server <target>; up to 3 <masks> are supported.
433 <target> can be a server name, the nickname of a client connected to a
434 specific server, or a mask matching a server name in the network. The
435 server of the current connection is used when <target> is omitted.
438 - RFC 2812, 3.6.2 "Whois query"
441 WHOWAS <nickname>[,<nickname>[,...]] [<count> [<target>]]
443 Query information about nicknames no longer in use in the network,
444 either because of nickname changes or disconnects. The history is
445 searched backwards, returning the most recent entry first. If there
446 are multiple entries, up to <count> entries will be shown (or all of
447 them, if no <count> has been given).
449 <target> can be a server name, the nickname of a client connected to a
450 specific server, or a mask matching a server name in the network. The
451 server of the current connection is used when <target> is omitted.
454 - RFC 2812, 3.6.3 "Whowas"
461 INVITE <nickname> <channel>
463 Invite <nickname> to join channel <channel>.
465 <channel> does not have to exist, but if it does, only members of the
466 channel are allowed to invite other users. If the channel mode "+i"
467 is set, only channel "half-ops" (and above) may invite other clients,
468 and if channel mode "+V" is set, nobody can invite other users.
471 - RFC 2812, 3.2.7 "Invite message"
474 JOIN <channels> [<channel-keys>]
476 Makes the client join the <channels> (comma-separated list), specifying
477 the passwords, if needed, in the comma-separated <channel-keys> list.
478 A <channel-key> is only needed, if the <channel> mode "+k" is set.
480 If the channel(s) do not exist, then they will be created.
483 KICK <channel>[,<channel>[,...]] <nickname>[,<nickname>[,...]] [<reason>]
485 Remove users(s) with <nickname>(s) from <channel>(s).
487 There must be either exactly one <channel> parameter and multiple
488 <nickname> parameters, or as many <channel> parameters as there are
489 <nickname> parameters. The <reason> is shown to the users being
490 kicked, and the nickname of the current user is used when <reason>
494 - RFC 2812, 3.2.8 "Kick command"
497 LIST [<channels> [<server>]]
499 List all visible <channels> (comma-seperated list) on the current
501 If <server> is given, the command will be forwarded to <server> for
505 PART <channels> [<part-message>]
507 Leave <channels> (comma-separated list), optional with a
511 TOPIC <channel> <topic>
513 Set a <topic> for <channel>.
515 Only <channel> operators are able to set a <topic>.
518 Administrative Commands
519 ~~~~~~~~~~~~~~~~~~~~~~~
522 CONNECT <target server> [<port> [<remote server> [<mypwd> <peerpwd>]]]
524 Instructs the current server, or <remote server> if specified,
525 to connect to <target server>.
527 To connect <remote server> you need to have remote oper status.
528 If <port> is omitted, it uses the server port of the configuration.
529 If <mypwd> and <peerpwd> is given, it uses those passwords instead
530 of the ones in the configuration.
535 Instructs the server to shut down.
538 DISCONNECT [<remote server>]
540 Disconnects the current server, or <remote server> if specified.
541 To disconnect a <remote server> you need to have remote oper status.
544 GLINE <nick!user@hostmask> <seconds> :<reason>
546 This command provides timed G-Lines (Network-wide bans).
547 If a client matches a G-Line, it cannot connect to any server on
548 the IRC network. If you put 0 as <seconds>, it makes the G-Line
551 To remove a G-Line, type "GLINE <nick!user@hostmask>".
552 To list the G-Lines, type "STATS g".
555 KILL <nickname> <reason>
557 Forcibly remove all users with a given <nickname> from the IRC
558 network and display the given <reason> to them.
560 This command is used internally between servers, too, for example
561 to disconnect duplicate <nickname>'s after a "net split".
564 - RFC 2812, 3.7.1 "Kill message"
567 KLINE <nick!user@hostmask> <seconds> :<reason>
569 This command provides timed K-Lines (Server-local bans).
570 If a client matches a K-Line, it cannot connect to the issued server.
571 If you put 0 as <seconds>, it makes the K-Line permanent.
573 To remove a K-Line, type "KLINE <nick!user@hostmask>".
574 To list the K-Lines, type "STATS k".
577 OPER <user> <password>
579 Authenticates <user> as an IRC operator on the current server/network.
584 Causes the server to re-read and re-process its configuration file(s).
594 Sends <message> to all users with user mode "+w".
603 SERVLIST [<mask> [<type>]]
605 List all IRC services currently registered in the network.
607 The optional <mask> and <type> parameters can be used to limit the
608 listing to services matching the <mask> and that are of type <type>.
610 Please note that ngIRCd doesn't use any service types at the moment
611 and therefore all services are of type "0".
614 - RFC 2812, 3.5.1 "Servlist message"
617 SQUERY <target>[,<target>[,...]] <message>
619 Send a <message> to a given <target> IRC service, and report all
622 The "SQUERY" command exactly behaves like the "PRIVMSG" command, but
623 enforces that the <target> of the <message> is an IRC service.
624 Please see the help text of the "PRIVMSG" command for a detailed
625 description of the parameters!
627 If a user wants to interact with IRC services, he should use "SQUERY"
628 instead of "PRIVMSG" or "NOTICE": only "SQUERY makes sure that no
629 regular user, which uses the nickname of an IRC service, receives
630 the command in error, for example during a "net split"!
633 - RFC 2812, 2.3.1 "Message format in Augmented BNF"
634 - RFC 2812, 3.3 "Sending messages"
635 - RFC 2812, 3.3.2 "Notice"
640 Server Protocol Commands
641 ~~~~~~~~~~~~~~~~~~~~~~~~
644 CHANINFO <channel> +<modes> [[<key> <limit>] <topic>]
646 CHANINFO is used by servers to inform each other about a channel:
647 its modes, channel key, user limits and its topic.
649 See doc/Protocol.txt for more information.
652 ERROR [<message> [<> [...]]]
654 Inform a client or a server about an error condition. The first
655 parameter, if given, is logged by the server receiving the message,
656 all other parameters are silently ignored.
658 This command is silently ignored on non-server and non-service links
659 and shouldn't be used by regular IRC clients.
661 The ERROR message is also sent before terminating a regular client
665 - RFC 2812, 3.7.4 "Error message"
668 METADATA <target> <key> <value>
670 The METADATA command is used on server-links to update "metadata"
671 information of clients, like the hostname, the info text ("real name"),
674 See doc/Protocol.txt for more information.
683 Disconnects an IRC Server from the network.
690 SUMMON <user> [<target> [<channel>]]
692 This command was intended to call people into IRC who are directly
693 connected to the terminal console of the IRC server -- but is
694 deprecated today. Therefore ngIRCd doesn't really implement this
695 command and always returns an error message, regardless of the
699 - RFC 2812, 4.5 "Summon message"
704 This command was intended to list users directly logged in into the
705 console of the IRC server -- but is deprecated today. Therefore ngIRCd
706 doesn't really implement this command and always returns an error
707 message, regardless of the parameters given.
710 - RFC 2812, 4.6 "Users"