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.
231 - RFC 2812, 4.1 "Away"
236 Show help information for a specific IRC <command>. The <command> name
239 Use the command "HELP Commands" to get a list of all available commands.
241 The HELP command isn't specified by any RFC but implemented by most
242 daemons. If no help text could be read in, ngIRCd outputs a list of all
243 implemented commands when receiving a plain "HELP" command as well as
246 ngIRCd replies using "NOTICE" commands like ircd 2.10/2.11; other
247 implementations are using numerics 704, 705, and 706.
250 MODE <nickname> [{+|-}<mode>[<mode>] [{+|-}<mode>[<mode>] [...]]]
251 MODE <channel> [{+|-}<mode>[<mode>] [<arg> [<arg> [...]]] [{+|-}<mode>[<mode>] [<arg> [<arg> [...]]] [...]]]
253 Set and get user and channel modes.
255 When no mode parameters are given, the currently set user or channel
256 modes are returned. Otherwise the modes are adjusted accordingly
257 and the changes will be reported back to the client.
259 All user and chnnel "modes" are indicated by single case-sensitive
262 Please note that a user can only get and set his own modes, and not
263 all user "levels" are allowed to change all channel modes ...
265 The mode parameters can become quite complex, especially when dealing
266 with channel modes that require additional arguments:
268 {+|-}<mode(s}> -- set or unset one or more modes.
269 +<mode(s)> -<mode(s)> -- set some modes and unset others.
270 +<modes> <arg1> <arg2> -- set (at least) two modes with arguments.
274 MODE nick +i -- set user to "invisible".
275 MODE #chan +tn -- set "topic lock" and "no external messages".
276 MODE #chan -t +l 50 -- remove "topic lock", set "user limit" to 50.
277 MODE #chan +ov nick1 nick2 -- set "channel op" and "voice" mode
278 to nick1 and nick2 in channel #chan.
280 A complete list of all modes supported by ngIRCd can be found online
281 here: <http://ngircd.barton.de/doc/Modes.txt>.
284 - RFC 2811, 4. "Channel Modes"
285 - RFC 2812, 3.1.5 "User mode message"
286 - RFC 2812, 3.2.3 "Channel mode message"
287 - <http://ngircd.barton.de/doc/Modes.txt>
291 NOTICE <target>[,<target>[,...]] <message>
293 Send a <message> to a given <target>, which can be a user or a
294 channel, but DON'T report any error.
296 The "NOTICE" command exactly behaves like the "PRIVMSG" command, but
297 doesn't report any errors it encounters (like an unknown <target>).
298 Please see the help text of the "PRIVMSG" command for a detailed
299 description of the parameters!
302 - RFC 2812, 2.3.1 "Message format in Augmented BNF"
303 - RFC 2812, 3.3 "Sending messages"
304 - RFC 2812, 3.3.2 "Notice"
307 PRIVMSG <target>[,<target>[,...]] <message>
309 Send a <message> to a given <target>, which can be a user or a
310 channel, and report all errors.
312 The <target> must follow one of these syntax variants:
316 - <user>[%<host>]@<server>
318 - <nickname>!<user>@<host>
320 If the <target> is a user, a private message is sent directly to this
321 user; if it resolves to a channel name, a public message is sent
322 to all the members of that channel.
324 In addition, IRC Ops can use these two forms to specify the <target>:
329 The <mask> can contain the wildcard characters "*" and "?", but must
330 contain at least one dot (".") and no wildcard after the last one.
331 Then, the <message> is sent to all users matching this <mask>.
333 All warnings and errors are reported back to the initiator using
334 numeric status codes, which is the only difference to the "NOTICE"
335 command, which doesn't report back any errors or warnings at all.
337 Please note that clients often use "MSG" as an alias to PRIVMSG, and
338 a command "QUERY <nick> [<message>]" to initiate private chats. Both
339 are command extensions of the client and never sent to the server.
342 - RFC 2812, 2.3.1 "Message format in Augmented BNF"
343 - RFC 2812, 3.3 "Sending messages"
344 - RFC 2812, 3.3.1 "Private messages"
346 Status and Informational Commands
347 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
352 Show administrative information about an IRC server in the network.
354 <target> can be a server name, the nickname of a client connected to
355 a specific server, or a mask matching a server name in the network.
356 The server of the current connection is used when <target> is omitted.
359 - RFC 2812, 3.4.9 "Admin command"
364 Show the version, birth & online time of an IRC server in the network.
366 <target> can be a server name, the nickname of a client connected to
367 a specific server, or a mask matching a server name in the network.
368 The server of the current connection is used when <target> is omitted.
371 - RFC 2812, 3.4.10 "Info command"
374 ISON <nickname> [<nickname> [...]]
376 Query online status of a list of nicknames. The server replies with
377 a list only containing nicknames actually connected to a server in
378 the network. If no nicknames of the given list are online, an empty
379 list is returned to the client requesting the information.
381 Please note that "all" IRC daemons even parse separate nicknames in
382 a single parameter (like ":nick1 nick2"), and therefore ngIRCd
383 implements this behaviour, too.
386 - RFC 2812, 4.9 "Ison message"
389 LINKS [[<target>] [<mask>]
391 List all servers currently registered in the network matching <mask>,
392 or all servers if <mask> has been omitted, as seen by the server
393 specified by <target> or the local server when <target> is omitted.
395 <target> can be a server name, the nickname of a client connected to
396 a specific server, or a mask matching a server name in the network.
399 - RFC 2812, 3.4.5 "Links message"
402 LUSERS [<mask> [<target>]]
404 Return statistics about the number of clients (users, servers,
405 services, ...) in the network as seen by the server <target>.
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.
411 Please note that ngIRCd ignores the <mask> parameter entirely: it
412 is not possible to get information for a part of the network only.
415 - RFC 2812, 3.4.2 "Lusers message"
420 Show the "Message of the Day" (MOTD) of an IRC server in the network.
422 <target> can be a server name, the nickname of a client connected to
423 a specific server, or a mask matching a server name in the network.
424 The server of the current connection is used when <target> is omitted.
427 - RFC 2812, 3.4.1 "Motd message"
430 NAMES [<channel>[,<channel>[,...]] [<target>]]
432 Show the list of users that are members of a particular <channel>
433 (and that are visible for the client requesting this information) as
434 seen by the server <target>. More than one <channel> can be given
435 separated by "," (but not whitespaces!).
437 If <channel> has been omitted, all visible users are shown, grouped
438 by channel name, and all visible users not being members of at least
439 one channel are shown as members of the pseudo channel "*".
441 <target> can be a server name, the nickname of a client connected to
442 a specific server, or a mask matching a server name in the network.
443 The server of the current connection is used when <target> is omitted.
446 - RFC 2812, 3.2.5 "Names message"
449 STATS [<query> [<target>]]
451 Show statistics and other information of type <query> of a particular
452 IRC server in the network.
454 The following <query> types are supported (case-insensitive):
456 - g Network-wide bans ("G-Lines").
457 - k Server-local bans ("K-Lines").
458 - l Link status (parent server and own link only).
459 - m Command usage count.
462 <target> can be a server name, the nickname of a client connected to
463 a specific server, or a mask matching a server name in the network.
464 The server of the current connection is used when <target> is omitted.
467 - RFC 2812, 3.4.4 "Stats message"
472 Show the local time of an IRC server in the network.
474 <target> can be a server name, the nickname of a client connected to
475 a specific server, or a mask matching a server name in the network.
476 The server of the current connection is used when <target> is omitted.
479 - RFC 2812, 3.4.6 "Time message"
484 Find the route to a specific server and send information about its
485 peers. Each server that processes this command reports back to the
486 sender about it: the replies from pass-through servers form a chain
487 which shows the route to the destination.
490 - RFC 2812, 3.4.8 "Trace message"
493 USERHOST <nickname> [<nickname> [...]]
495 Show flags and the hostmasks (<user>@<host>) of the <nickname>s,
496 separated by spaces. The following flags are used:
498 - "-" The client is "away" (the mode "+a" is set on this client).
499 - "+" Client seems to be available, at least it isn't marked "away".
500 - "*" The client is an IRC operator (the mode "+o" is set).
503 - RFC 2812, 4.8 "Userhost message"
508 Show version information about a particular IRC server in the network.
510 <target> can be a server name, the nickname of a client connected to
511 a specific server, or a mask matching a server name in the network.
512 The server of the current connection is used when <target> is omitted.
514 Please note: in normal operation, the version number ends in a dot
515 (".", for example "ngIRCd-20.1."). If it ends in ".1" (for example
516 "ngIRCd-20.1.1", same version than before!), the server is running in
517 debug-mode; and if it ends in ".2", the "network sniffer" is active!
518 Keep your privacy in mind ...
521 - RFC 2812, 3.4.3 "Version message"
526 Show a list of users who match the <mask>, or all visible users when
527 the <mask> has been omitted. (Special case: the <mask> "0" is
530 If the flag "o" is given, the server will only return information about
534 - RFC 2812, 3.6.1 "Who query"
537 WHOIS [<target>] <mask>[,<mask>[,...]]
539 Query information about users matching the <mask> parameter(s) as seen
540 by the server <target>; up to 3 <masks> are supported.
542 <target> can be a server name, the nickname of a client connected to a
543 specific server, or a mask matching a server name in the network. The
544 server of the current connection is used when <target> is omitted.
547 - RFC 2812, 3.6.2 "Whois query"
550 WHOWAS <nickname>[,<nickname>[,...]] [<count> [<target>]]
552 Query information about nicknames no longer in use in the network,
553 either because of nickname changes or disconnects. The history is
554 searched backwards, returning the most recent entry first. If there
555 are multiple entries, up to <count> entries will be shown (or all of
556 them, if no <count> has been given).
558 <target> can be a server name, the nickname of a client connected to a
559 specific server, or a mask matching a server name in the network. The
560 server of the current connection is used when <target> is omitted.
563 - RFC 2812, 3.6.3 "Whowas"
570 INVITE <nickname> <channel>
572 Invite <nickname> to join channel <channel>.
574 <channel> does not have to exist, but if it does, only members of the
575 channel are allowed to invite other users. If the channel mode "+i"
576 is set, only channel "half-ops" (and above) may invite other clients,
577 and if channel mode "+V" is set, nobody can invite other users.
580 - RFC 2812, 3.2.7 "Invite message"
583 JOIN {<channel>[,<channel>[,...]] [<key>[,<key>[,...]]] | 0}
585 Makes the client join the <channel> (comma-separated list), specifying
586 the channel keys ("passwords"). A <channel-key> is only needed if the
587 <channel> has the mode "+k" set.
589 If the channel(s) do not exist, then they will be created.
591 Using "JOIN 0" parts all channels at once.
594 - RFC 2812, 3.2.1 "Join message" (client protocol)
595 - RFC 2813, 4.2.1 "Join message" (server protocol)
598 KICK <channel>[,<channel>[,...]] <nickname>[,<nickname>[,...]] [<reason>]
600 Remove users(s) with <nickname>(s) from <channel>(s).
602 There must be either exactly one <channel> parameter and multiple
603 <nickname> parameters, or as many <channel> parameters as there are
604 <nickname> parameters. The <reason> is shown to the users being
605 kicked, and the nickname of the current user is used when <reason>
609 - RFC 2812, 3.2.8 "Kick command"
612 LIST [<channel>[,<channel>[,...]] [<server>]]
614 List all visible <channels> (comma-seperated list).
616 If <server> is given, the command will be forwarded to <server> for
620 - RFC 2812, 3.2.6 "List message"
623 PART <channel>[,<channel>[,...]] [<part-message>]
625 Leave <channel> (comma-separated list), optionally with sending a
626 <part-message> to all the other channel members.
629 - RFC 2812, 3.2.2 "Part message"
632 TOPIC <channel> [<topic>]
634 Cchange or view the topic of a channel.
636 The topic for channel <channel> is returned if there is no <topic>
637 given. If the <topic> parameter is present, the topic for that
638 channel will be changed, if this action is allowed for the user
639 requesting it. If the <topic> parameter is an empty string, the
640 topic for that channel will be removed.
643 - RFC 2812, 3.2.4 "Topic message"
646 Administrative Commands
647 ~~~~~~~~~~~~~~~~~~~~~~~
650 CONNECT <target server> [<port> [<remote server> [<mypwd> <peerpwd>]]]
652 Instructs the current server, or <remote server> if specified,
653 to connect to <target server>.
655 To connect <remote server> you need to have remote oper status.
656 If <port> is omitted, it uses the server port of the configuration.
657 If <mypwd> and <peerpwd> is given, it uses those passwords instead
658 of the ones in the configuration.
663 Instructs the server to shut down.
666 DISCONNECT [<remote server>]
668 Disconnects the current server, or <remote server> if specified.
669 To disconnect a <remote server> you need to have remote oper status.
672 GLINE <nick!user@hostmask> <seconds> :<reason>
674 This command provides timed G-Lines (Network-wide bans).
675 If a client matches a G-Line, it cannot connect to any server on
676 the IRC network. If you put 0 as <seconds>, it makes the G-Line
679 To remove a G-Line, type "GLINE <nick!user@hostmask>".
680 To list the G-Lines, type "STATS g".
683 KILL <nickname> <reason>
685 Forcibly remove all users with a given <nickname> from the IRC
686 network and display the given <reason> to them.
688 This command is used internally between servers, too, for example
689 to disconnect duplicate <nickname>'s after a "net split".
692 - RFC 2812, 3.7.1 "Kill message"
695 KLINE <nick!user@hostmask> <seconds> :<reason>
697 This command provides timed K-Lines (Server-local bans).
698 If a client matches a K-Line, it cannot connect to the issued server.
699 If you put 0 as <seconds>, it makes the K-Line permanent.
701 To remove a K-Line, type "KLINE <nick!user@hostmask>".
702 To list the K-Lines, type "STATS k".
705 OPER <user> <password>
707 Authenticates <user> as an IRC operator on the current server/network.
712 Causes the server to re-read and re-process its configuration file(s).
722 Sends <message> to all users with user mode "+w".
729 SERVICE <name> <reserved1> <distribution> <type> <reserved2> <info>
730 SERVICE <name> <servertoken> <distribution> {<type>|+<modes>} <hops> <info>
732 Register a new service in the network.
734 The first form is used by directly linked services and isn't supported
735 by ngIRCd at the moment. The second form announces services connected
736 to remote "pseudo-servers" ("services hubs").
738 The <distribution> and <type> parameters are ignored by ngIRCd.
741 - RFC 2812, 3.1.6 "Service message"
742 - RFC 2813, 4.1.4 "Service message"
745 SERVLIST [<mask> [<type>]]
747 List all IRC services currently registered in the network.
749 The optional <mask> and <type> parameters can be used to limit the
750 listing to services matching the <mask> and that are of type <type>.
752 Please note that ngIRCd doesn't use any service types at the moment
753 and therefore all services are of type "0".
756 - RFC 2812, 3.5.1 "Servlist message"
759 SQUERY <target>[,<target>[,...]] <message>
761 Send a <message> to a given <target> IRC service, and report all
764 The "SQUERY" command exactly behaves like the "PRIVMSG" command, but
765 enforces that the <target> of the <message> is an IRC service.
766 Please see the help text of the "PRIVMSG" command for a detailed
767 description of the parameters!
769 If a user wants to interact with IRC services, he should use "SQUERY"
770 instead of "PRIVMSG" or "NOTICE": only "SQUERY makes sure that no
771 regular user, which uses the nickname of an IRC service, receives
772 the command in error, for example during a "net split"!
775 - RFC 2812, 2.3.1 "Message format in Augmented BNF"
776 - RFC 2812, 3.3 "Sending messages"
777 - RFC 2812, 3.3.2 "Notice"
780 SVSNICK <oldnick> <newnick>
782 Forcefully change foreign user nicknames. This command is allowed
785 The "SVSNICK" command is forwarded to the server to which the user
786 with nickname <oldnick> is connected to, which in turn generates a
787 regular "NICK" command that then is sent to the client, so no special
788 support in the client software is required.
791 - ngIRCd GIT commit e3f300d3231f
794 Server Protocol Commands
795 ~~~~~~~~~~~~~~~~~~~~~~~~
798 CHANINFO <channel> +<modes> [[<key> <limit>] <topic>]
800 CHANINFO is used by servers to inform each other about a channel:
801 its modes, channel key, user limits and its topic.
804 - IRC+, <http://ngircd.barton.de/doc/Protocol.txt>
805 - IRC+, doc/Protocol.txt
808 ERROR [<message> [<> [...]]]
810 Inform a client or a server about an error condition. The first
811 parameter, if given, is logged by the server receiving the message,
812 all other parameters are silently ignored.
814 This command is silently ignored on non-server and non-service links
815 and shouldn't be used by regular IRC clients.
817 The ERROR message is also sent before terminating a regular client
821 - RFC 2812, 3.7.4 "Error message"
824 METADATA <target> <key> <value>
826 The METADATA command is used on server-links to update "metadata"
827 information of clients, like the hostname, the info text ("real name"),
831 - IRC+, <http://ngircd.barton.de/doc/Protocol.txt>
832 - IRC+, doc/Protocol.txt
841 Disconnects an IRC Server from the network.
848 SUMMON <user> [<target> [<channel>]]
850 This command was intended to call people into IRC who are directly
851 connected to the terminal console of the IRC server -- but is
852 deprecated today. Therefore ngIRCd doesn't really implement this
853 command and always returns an error message, regardless of the
857 - RFC 2812, 4.5 "Summon message"
862 This command was intended to list users directly logged in into the
863 console of the IRC server -- but is deprecated today. Therefore ngIRCd
864 doesn't really implement this command and always returns an error
865 message, regardless of the parameters given.
868 - RFC 2812, 4.6 "Users"