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 - IRC+, <http://ngircd.barton.de/doc/Protocol.txt>
101 - IRC+, doc/Protocol.txt
105 NICK <nickname> [<hops>]
106 NICK <nickname> <hops> <username> <host> <servertoken> <usermodes> <realname>
108 Set or change the <nickname> of a client (first form) and register
109 remote clients (second and third form; servers only).
112 - RFC 1459, 4.1.2 "Nick message" (old client and server protocol)
113 - RFC 2812, 3.1.2 "Nick message" (client protocol)
114 - RFC 2813, 4.1.3 "Nick" (server protocol)
118 PASS <password> <version> <flags> [<options>]
120 Set a connection <password>. This command must be the first command
121 sent to the server, even before the NICK/USER or SERVER commands.
123 The first form is used by user sessions or (old) RFC 1459 servers,
124 the second form is used by RFC 2812 or IRC+ compliant servers and
125 enables the server to indicate its version and supported protocol
129 - RFC 1459, 4.1.1 "Password message" (old client and server protocol)
130 - RFC 2812, 3.1.1 "Password message" (client protocol)
131 - RFC 2813, 4.1.1 "Password message" (server protocol)
132 - IRC+, <http://ngircd.barton.de/doc/Protocol.txt>
133 - IRC+, doc/Protocol.txt
136 PING <token> [<target>]
138 Tests the presence of a connection to a client or server.
140 If no <target> has been given, the local server is used. User clients
141 can only use other servers as <target>, no user clients.
143 A PING message results in a PONG reply containing the <token>, which
144 can be arbitrary text.
147 The RFCs state that the <token> parameter is used to specify the
148 origin of the PING command when forwared in the network, but this
149 is not the case: the sender is specified using the prefix as usual,
150 and the parameter is used to identify the PONG reply in practice.
153 - RFC 2812, 3.7.2 "Ping message"
156 PONG <target> [<token>]
158 Reply to a "PING" command, indicate that the connection is alive.
160 The <token> is the arbitrary text received in the "PING" command and
161 can be used to identify the correct PONG sent as answer.
163 When the "PONG" command is received from a user session, the <target>
164 parameter is ignored; otherwise the PONG is forwarded to this client.
167 - RFC 2812, 3.7.3 "Pong message"
170 QUIT [<quit-message>]
172 Terminate a user session.
174 When received from a user, the server acknowledges this by sending
175 an "ERROR" message back to the client and terminates the connection.
177 When a <quit-message> has been given, it is sent to all the channels
178 that the client is a member of when leaving.
181 - RFC 2812, 3.1.7 "Quit"
182 - RFC 2813, 4.1.5 "Quit"
185 USER <username> <hostname> <unused> <realname>
187 Register (and authenticate) a new user session with a short <username>
188 and a human-readable <realname>.
190 The parameter <hostname> is only used when received by an other server
191 and ignored otherwise; and the parameter <unused> is always ignored.
192 But both parameters are required on each invocation by the protocol
193 and can be set to arbitrary characters/text when not used.
195 If <username> contains an "@" character, the full <username> is used
196 for authentication, but only the first part up to this character is
197 set as "user name" for this session.
200 - RFC 2812, 3.1.3 "User message"
203 WEBIRC <password> <username> <hostname> <ip-address>
205 Allow Web-to-IRC gateway software (for example) to set the correct
206 user name and host name of users instead of their own.
208 It must be the very first command sent to the server, even before
209 USER and NICK commands!
211 The <password> must be set in the server configuration file to prevent
212 unauthorized clients to fake their identity; it is an arbitrary string.
215 - IRC+, <http://ngircd.barton.de/doc/Protocol.txt>
216 - IRC+, doc/Protocol.txt
225 Provides the server with a message to automatically send in reply to a
226 PRIVMSG directed at the user, but not to a channel they are on.
228 If <message> is omitted, the away status is removed.
233 Show help information for a specific IRC <command>. The <command> name
236 Use the command "HELP Commands" to get a list of all available commands.
238 The HELP command isn't specified by any RFC but implemented by most
239 daemons. If no help text could be read in, ngIRCd outputs a list of all
240 implemented commands when receiving a plain "HELP" command as well as
243 ngIRCd replies using "NOTICE" commands like ircd 2.10/2.11; other
244 implementations are using numerics 704, 705, and 706.
248 MODE <nickname> <flags> (user)
249 MODE <channel> <flags> [<args>]
251 The MODE command is dual-purpose. It can be used to set both (user) and
254 See doc/Modes.txt for more information.
257 NOTICE <target>[,<target>[,...]] <message>
259 Send a <message> to a given <target>, which can be a user or a
260 channel, but DON'T report any error.
262 The "NOTICE" command exactly behaves like the "PRIVMSG" command, but
263 doesn't report any errors it encounters (like an unknown <target>).
264 Please see the help text of the "PRIVMSG" command for a detailed
265 description of the parameters!
268 - RFC 2812, 2.3.1 "Message format in Augmented BNF"
269 - RFC 2812, 3.3 "Sending messages"
270 - RFC 2812, 3.3.2 "Notice"
273 PRIVMSG <target>[,<target>[,...]] <message>
275 Send a <message> to a given <target>, which can be a user or a
276 channel, and report all errors.
278 The <target> must follow one of these syntax variants:
282 - <user>[%<host>]@<server>
284 - <nickname>!<user>@<host>
286 If the <target> is a user, a private message is sent directly to this
287 user; if it resolves to a channel name, a public message is sent
288 to all the members of that channel.
290 In addition, IRC Ops can use these two forms to specify the <target>:
295 The <mask> can contain the wildcard characters "*" and "?", but must
296 contain at least one dot (".") and no wildcard after the last one.
297 Then, the <message> is sent to all users matching this <mask>.
299 All warnings and errors are reported back to the initiator using
300 numeric status codes, which is the only difference to the "NOTICE"
301 command, which doesn't report back any errors or warnings at all.
303 Please note that clients often use "MSG" as an alias to PRIVMSG, and
304 a command "QUERY <nick> [<message>]" to initiate private chats. Both
305 are command extensions of the client and never sent to the server.
308 - RFC 2812, 2.3.1 "Message format in Augmented BNF"
309 - RFC 2812, 3.3 "Sending messages"
310 - RFC 2812, 3.3.1 "Private messages"
312 Status and Informational Commands
313 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
318 Show administrative information about an IRC server in the network.
320 <target> can be a server name, the nickname of a client connected to
321 a specific server, or a mask matching a server name in the network.
322 The server of the current connection is used when <target> is omitted.
325 - RFC 2812, 3.4.9 "Admin command"
330 Show the version, birth & online time of an IRC server in the network.
332 <target> can be a server name, the nickname of a client connected to
333 a specific server, or a mask matching a server name in the network.
334 The server of the current connection is used when <target> is omitted.
337 - RFC 2812, 3.4.10 "Info command"
340 ISON <nickname> [<nickname> [...]]
342 Query online status of a list of nicknames. The server replies with
343 a list only containing nicknames actually connected to a server in
344 the network. If no nicknames of the given list are online, an empty
345 list is returned to the client requesting the information.
347 Please note that "all" IRC daemons even parse separate nicknames in
348 a single parameter (like ":nick1 nick2"), and therefore ngIRCd
349 implements this behaviour, too.
352 - RFC 2812, 4.9 "Ison message"
355 LINKS [[<target>] [<mask>]
357 List all servers currently registered in the network matching <mask>,
358 or all servers if <mask> has been omitted, as seen by the server
359 specified by <target> or the local server when <target> is omitted.
361 <target> can be a server name, the nickname of a client connected to
362 a specific server, or a mask matching a server name in the network.
365 - RFC 2812, 3.4.5 "Links message"
368 LUSERS [<mask> [<target>]]
370 Return statistics about the number of clients (users, servers,
371 services, ...) in the network as seen by the server <target>.
373 <target> can be a server name, the nickname of a client connected to
374 a specific server, or a mask matching a server name in the network.
375 The server of the current connection is used when <target> is omitted.
377 Please note that ngIRCd ignores the <mask> parameter entirely: it
378 is not possible to get information for a part of the network only.
381 - RFC 2812, 3.4.2 "Lusers message"
386 Show the "Message of the Day" (MOTD) of an IRC server in the network.
388 <target> can be a server name, the nickname of a client connected to
389 a specific server, or a mask matching a server name in the network.
390 The server of the current connection is used when <target> is omitted.
393 - RFC 2812, 3.4.1 "Motd message"
396 NAMES [<channel>[,<channel>[,...]] [<target>]]
398 Show the list of users that are members of a particular <channel>
399 (and that are visible for the client requesting this information) as
400 seen by the server <target>. More than one <channel> can be given
401 separated by "," (but not whitespaces!).
403 If <channel> has been omitted, all visible users are shown, grouped
404 by channel name, and all visible users not being members of at least
405 one channel are shown as members of the pseudo channel "*".
407 <target> can be a server name, the nickname of a client connected to
408 a specific server, or a mask matching a server name in the network.
409 The server of the current connection is used when <target> is omitted.
412 - RFC 2812, 3.2.5 "Names message"
415 STATS [<query> [<target>]]
417 Show statistics and other information of type <query> of a particular
418 IRC server in the network.
420 The following <query> types are supported (case-insensitive):
422 - g Network-wide bans ("G-Lines").
423 - k Server-local bans ("K-Lines").
424 - l Link status (parent server and own link only).
425 - m Command usage count.
428 <target> can be a server name, the nickname of a client connected to
429 a specific server, or a mask matching a server name in the network.
430 The server of the current connection is used when <target> is omitted.
433 - RFC 2812, 3.4.4 "Stats message"
438 Show the local time of an IRC server in the network.
440 <target> can be a server name, the nickname of a client connected to
441 a specific server, or a mask matching a server name in the network.
442 The server of the current connection is used when <target> is omitted.
445 - RFC 2812, 3.4.6 "Time message"
450 Trace a path across the IRC network of the current server, or if given
451 of a specific <server>, in a similar method to traceroute.
454 USERHOST <nickname> [<nickname> [...]]
456 Show flags and the hostmasks (<user>@<host>) of the <nickname>s,
457 separated by spaces. The following flags are used:
459 - "-" The client is "away" (the mode "+a" is set on this client).
460 - "+" Client seems to be available, at least it isn't marked "away".
461 - "*" The client is an IRC operator (the mode "+o" is set).
464 - RFC 2812, 4.8 "Userhost message"
469 Show version information about a particular IRC server in the network.
471 <target> can be a server name, the nickname of a client connected to
472 a specific server, or a mask matching a server name in the network.
473 The server of the current connection is used when <target> is omitted.
475 Please note: in normal operation, the version number ends in a dot
476 (".", for example "ngIRCd-20.1."). If it ends in ".1" (for example
477 "ngIRCd-20.1.1", same version than before!), the server is running in
478 debug-mode; and if it ends in ".2", the "network sniffer" is active!
479 Keep your privacy in mind ...
482 - RFC 2812, 3.4.3 "Version message"
487 Show a list of users who match the <mask>, or all visible users when
488 the <mask> has been omitted. (Special case: the <mask> "0" is
491 If the flag "o" is given, the server will only return information about
495 - RFC 2812, 3.6.1 "Who query"
498 WHOIS [<target>] <mask>[,<mask>[,...]]
500 Query information about users matching the <mask> parameter(s) as seen
501 by the server <target>; up to 3 <masks> are supported.
503 <target> can be a server name, the nickname of a client connected to a
504 specific server, or a mask matching a server name in the network. The
505 server of the current connection is used when <target> is omitted.
508 - RFC 2812, 3.6.2 "Whois query"
511 WHOWAS <nickname>[,<nickname>[,...]] [<count> [<target>]]
513 Query information about nicknames no longer in use in the network,
514 either because of nickname changes or disconnects. The history is
515 searched backwards, returning the most recent entry first. If there
516 are multiple entries, up to <count> entries will be shown (or all of
517 them, if no <count> has been given).
519 <target> can be a server name, the nickname of a client connected to a
520 specific server, or a mask matching a server name in the network. The
521 server of the current connection is used when <target> is omitted.
524 - RFC 2812, 3.6.3 "Whowas"
531 INVITE <nickname> <channel>
533 Invite <nickname> to join channel <channel>.
535 <channel> does not have to exist, but if it does, only members of the
536 channel are allowed to invite other users. If the channel mode "+i"
537 is set, only channel "half-ops" (and above) may invite other clients,
538 and if channel mode "+V" is set, nobody can invite other users.
541 - RFC 2812, 3.2.7 "Invite message"
544 JOIN <channels> [<channel-keys>]
546 Makes the client join the <channels> (comma-separated list), specifying
547 the passwords, if needed, in the comma-separated <channel-keys> list.
548 A <channel-key> is only needed, if the <channel> mode "+k" is set.
550 If the channel(s) do not exist, then they will be created.
553 KICK <channel>[,<channel>[,...]] <nickname>[,<nickname>[,...]] [<reason>]
555 Remove users(s) with <nickname>(s) from <channel>(s).
557 There must be either exactly one <channel> parameter and multiple
558 <nickname> parameters, or as many <channel> parameters as there are
559 <nickname> parameters. The <reason> is shown to the users being
560 kicked, and the nickname of the current user is used when <reason>
564 - RFC 2812, 3.2.8 "Kick command"
567 LIST [<channels> [<server>]]
569 List all visible <channels> (comma-seperated list) on the current
571 If <server> is given, the command will be forwarded to <server> for
575 PART <channels> [<part-message>]
577 Leave <channels> (comma-separated list), optional with a
581 TOPIC <channel> <topic>
583 Set a <topic> for <channel>.
585 Only <channel> operators are able to set a <topic>.
588 Administrative Commands
589 ~~~~~~~~~~~~~~~~~~~~~~~
592 CONNECT <target server> [<port> [<remote server> [<mypwd> <peerpwd>]]]
594 Instructs the current server, or <remote server> if specified,
595 to connect to <target server>.
597 To connect <remote server> you need to have remote oper status.
598 If <port> is omitted, it uses the server port of the configuration.
599 If <mypwd> and <peerpwd> is given, it uses those passwords instead
600 of the ones in the configuration.
605 Instructs the server to shut down.
608 DISCONNECT [<remote server>]
610 Disconnects the current server, or <remote server> if specified.
611 To disconnect a <remote server> you need to have remote oper status.
614 GLINE <nick!user@hostmask> <seconds> :<reason>
616 This command provides timed G-Lines (Network-wide bans).
617 If a client matches a G-Line, it cannot connect to any server on
618 the IRC network. If you put 0 as <seconds>, it makes the G-Line
621 To remove a G-Line, type "GLINE <nick!user@hostmask>".
622 To list the G-Lines, type "STATS g".
625 KILL <nickname> <reason>
627 Forcibly remove all users with a given <nickname> from the IRC
628 network and display the given <reason> to them.
630 This command is used internally between servers, too, for example
631 to disconnect duplicate <nickname>'s after a "net split".
634 - RFC 2812, 3.7.1 "Kill message"
637 KLINE <nick!user@hostmask> <seconds> :<reason>
639 This command provides timed K-Lines (Server-local bans).
640 If a client matches a K-Line, it cannot connect to the issued server.
641 If you put 0 as <seconds>, it makes the K-Line permanent.
643 To remove a K-Line, type "KLINE <nick!user@hostmask>".
644 To list the K-Lines, type "STATS k".
647 OPER <user> <password>
649 Authenticates <user> as an IRC operator on the current server/network.
654 Causes the server to re-read and re-process its configuration file(s).
664 Sends <message> to all users with user mode "+w".
671 SERVICE <name> <reserved1> <distribution> <type> <reserved2> <info>
672 SERVICE <name> <servertoken> <distribution> {<type>|+<modes>} <hops> <info>
674 Register a new service in the network.
676 The first form is used by directly linked services and isn't supported
677 by ngIRCd at the moment. The second form announces services connected
678 to remote "pseudo-servers" ("services hubs").
680 The <distribution> and <type> parameters are ignored by ngIRCd.
683 - RFC 2812, 3.1.6 "Service message"
684 - RFC 2813, 4.1.4 "Service message"
687 SERVLIST [<mask> [<type>]]
689 List all IRC services currently registered in the network.
691 The optional <mask> and <type> parameters can be used to limit the
692 listing to services matching the <mask> and that are of type <type>.
694 Please note that ngIRCd doesn't use any service types at the moment
695 and therefore all services are of type "0".
698 - RFC 2812, 3.5.1 "Servlist message"
701 SQUERY <target>[,<target>[,...]] <message>
703 Send a <message> to a given <target> IRC service, and report all
706 The "SQUERY" command exactly behaves like the "PRIVMSG" command, but
707 enforces that the <target> of the <message> is an IRC service.
708 Please see the help text of the "PRIVMSG" command for a detailed
709 description of the parameters!
711 If a user wants to interact with IRC services, he should use "SQUERY"
712 instead of "PRIVMSG" or "NOTICE": only "SQUERY makes sure that no
713 regular user, which uses the nickname of an IRC service, receives
714 the command in error, for example during a "net split"!
717 - RFC 2812, 2.3.1 "Message format in Augmented BNF"
718 - RFC 2812, 3.3 "Sending messages"
719 - RFC 2812, 3.3.2 "Notice"
722 SVSNICK <oldnick> <newnick>
724 Forcefully change foreign user nicknames. This command is allowed
727 The "SVSNICK" command is forwarded to the server to which the user
728 with nickname <oldnick> is connected to, which in turn generates a
729 regular "NICK" command that then is sent to the client, so no special
730 support in the client software is required.
733 - ngIRCd GIT commit e3f300d3231f
736 Server Protocol Commands
737 ~~~~~~~~~~~~~~~~~~~~~~~~
740 CHANINFO <channel> +<modes> [[<key> <limit>] <topic>]
742 CHANINFO is used by servers to inform each other about a channel:
743 its modes, channel key, user limits and its topic.
746 - IRC+, <http://ngircd.barton.de/doc/Protocol.txt>
747 - IRC+, doc/Protocol.txt
750 ERROR [<message> [<> [...]]]
752 Inform a client or a server about an error condition. The first
753 parameter, if given, is logged by the server receiving the message,
754 all other parameters are silently ignored.
756 This command is silently ignored on non-server and non-service links
757 and shouldn't be used by regular IRC clients.
759 The ERROR message is also sent before terminating a regular client
763 - RFC 2812, 3.7.4 "Error message"
766 METADATA <target> <key> <value>
768 The METADATA command is used on server-links to update "metadata"
769 information of clients, like the hostname, the info text ("real name"),
773 - IRC+, <http://ngircd.barton.de/doc/Protocol.txt>
774 - IRC+, doc/Protocol.txt
783 Disconnects an IRC Server from the network.
790 SUMMON <user> [<target> [<channel>]]
792 This command was intended to call people into IRC who are directly
793 connected to the terminal console of the IRC server -- but is
794 deprecated today. Therefore ngIRCd doesn't really implement this
795 command and always returns an error message, regardless of the
799 - RFC 2812, 4.5 "Summon message"
804 This command was intended to list users directly logged in into the
805 console of the IRC server -- but is deprecated today. Therefore ngIRCd
806 doesn't really implement this command and always returns an error
807 message, regardless of the parameters given.
810 - RFC 2812, 4.6 "Users"