List of IRC commands

(Redirected from USERIP)

This is a list of all Internet Relay Chat commands from RFC 1459, RFC 2812, and extensions added to major IRC daemons. Most IRC clients require commands to be preceded by a slash ("/"). Some commands are actually sent to IRC bots; these are treated by the IRC protocol as ordinary messages, not as /-commands.

Conventions used here: Angle brackets ("<" and ">") are used here to indicate a placeholder for some value, and are not a literal part of a command. Square brackets ("[" and "]") are used to indicate that a value is optional.

User commands

edit

ADMIN

edit

Syntax:

ADMIN [<target>]

Instructs the server to return information about the administrators of the server specified by <target>, where <target> is either a server or a user. If <target> is omitted, the server should return information about the administrators of the current server.[1]

AWAY

edit

Syntax:

AWAY [<message>]

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.[2] If <message> is omitted, the away status is removed. Defined in RFC 1459.

CNOTICE

edit

Syntax:

CNOTICE <nickname> <channel> :<message>

Sends a channel NOTICE message to <nickname> on <channel> that bypasses flood protection limits. The target nickname must be in the same channel as the client issuing the command, and the client must be a channel operator.

Normally an IRC server will limit the number of different targets a client can send messages to within a certain time frame to prevent spammers or bots from mass-messaging users on the network, however this command can be used by channel operators to bypass that limit in their channel. For example, it is often used by help operators that may be communicating with a large number of users in a help channel at one time.

This command is not formally defined in an RFC, but is in use by some IRC networks. Support is indicated in a RPL_ISUPPORT reply (numeric 005) with the CNOTICE keyword

CPRIVMSG

edit

Syntax:

CPRIVMSG <nickname> <channel> :<message>

Sends a private message to <nickname> on <channel> that bypasses flood protection limits. The target nickname must be in the same channel as the client issuing the command, and the client must be a channel operator.

Normally an IRC server will limit the number of different targets a client can send messages to within a certain time frame to prevent spammers or bots from mass-messaging users on the network, however this command can be used by channel operators to bypass that limit in their channel. For example, it is often used by help operators that may be communicating with a large number of users in a help channel at one time.

This command is not formally defined in an RFC, but is in use by some IRC networks. Support is indicated in a RPL_ISUPPORT reply (numeric 005) with the CPRIVMSG keyword

CONNECT

edit

Syntax:

CONNECT <target server> [<port> [<remote server>]] (RFC 1459)
CONNECT <target server> <port> [<remote server>] (RFC 2812)

Instructs the server <remote server> (or the current server, if <remote server> is omitted) to connect to <target server> on port <port>.[3][4] This command should only be available to IRC operators. Defined in RFC 1459; the <port> parameter became mandatory in RFC 2812.

Syntax:

DIE

Instructs the server to shut down.[5] This command may only be issued by IRC server operators. Defined in RFC 2812.

ENCAP

edit

Syntax:

:<source> ENCAP <destination> <subcommand> <parameters>

This command is for use by servers to encapsulate commands so that they will propagate across hub servers not yet updated to support them, and indicates the subcommand and its parameters should be passed unaltered to the destination, where it will be unencapsulated and parsed. This facilitates implementation of new features without a need to restart all servers before they are usable across the network.[6]

ERROR

edit

Syntax:

ERROR <error message>

This command is for use by servers to report errors to other servers. It is also used before terminating client connections.[7] Defined in RFC 1459.

HELP

edit

Syntax:

HELP

Requests the server to display the help file. This command is not formally defined in an RFC, but is in use by most[which?] major IRC daemons.

INFO

edit

Syntax:

INFO [<target>]

Returns information about the <target> server, or the current server if <target> is omitted.[8] Information returned includes the server's version, when it was compiled, the patch level, when it was started, and any other information which may be considered to be relevant. Defined in RFC 1459.

INVITE

edit

Syntax:

INVITE <nickname> <channel>

Invites <nickname> to the channel <channel>.[9] <channel> does not have to exist, but if it does, only members of the channel are allowed to invite other clients. If the channel mode i is set, only channel operators may invite other clients. Defined in RFC 1459.

ISON

edit

Syntax:

ISON <nicknames>

Queries the server to see if the clients in the space-separated list <nicknames> are currently on the network.[10] The server returns only the nicknames 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. Defined in RFC 1459.

JOIN

edit

Syntax:

JOIN <channels> [<keys>]

Makes the client join the channels in the comma-separated list <channels>, specifying the passwords, if needed, in the comma-separated list <keys>.[11] If the channel(s) do not exist then they will be created. Defined in RFC 1459.

KICK

edit

Syntax:

KICK <channel> <client> :[<message>]

Forcibly removes <client> from <channel>.[12] This command may only be issued by channel operators. Defined in RFC 1459.

KILL

edit

Syntax:

KILL <client> <comment>

Forcibly removes <client> from the network.[13] This command may only be issued by IRC operators. Defined in RFC 1459.

KNOCK

edit

Syntax:

KNOCK <channel> [<message>]

Sends a NOTICE to an invitation-only <channel> with an optional <message>, requesting an invite. This command is not formally defined by an RFC, but is supported by most[which?] major IRC daemons. Support is indicated in a RPL_ISUPPORT reply (numeric 005) with the KNOCK keyword.

edit

Syntax:

LINKS [<remote server> [<server mask>]]

Lists all server links matching <server mask>, if given, on <remote server>, or the current server if omitted.[14] Defined in RFC 1459.

LIST

edit

Syntax:

LIST [<channels> [<server>]]

Lists all channels on the server.[15] If the comma-separated list <channels> is given, it will return the channel topics. If <server> is given, the command will be forwarded to <server> for evaluation. Defined in RFC 1459.

LUSERS

edit

Syntax:

LUSERS [<mask> [<server>]]

Returns statistics about the size of the network.[16] If called with no arguments, the statistics will reflect the entire network. If <mask> is given, it will return only statistics reflecting the masked subset of the network. If <target> is given, the command will be forwarded to <server> for evaluation. Defined in RFC 2812.

MODE

edit

Syntax:

MODE <nickname> <flags> (user)
MODE <channel> <flags> [<args>]

The MODE command is dual-purpose. It can be used to set both user and channel modes.[17] Defined in RFC 1459.

MOTD

edit

Syntax:

MOTD [<server>]

Returns the message of the day on <server> or the current server if it is omitted.[18] Defined in RFC 2812.

NAMES

edit

Syntax:

NAMES [<channels>] (RFC 1459)
NAMES [<channels> [<server>]] (RFC 2812)

Returns a list of who is on the comma-separated list of <channels>, by channel name.[19] If <channels> 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 <server> is specified, the command is sent to <server> for evaluation.[20] Defined in RFC 1459; the optional <server> parameter was added in RFC 2812.

The response contains all nicknames in the channel prefixed with the highest channel status prefix of that user, for example like this (with @ being the highest status prefix)

:irc.server.net 353 Phyre = #SomeChannel :@WiZ

If a client wants to receive all the channel status prefixes of a user and not only their current highest one, the IRCv3 multi-prefix extension can be enabled (@ is the channel operator prefix, and + the lower voice status prefix):[21]

:irc.server.net 353 Phyre = #SomeChannel :@+WiZ

See also NAMESX below for an alternate, older approach to achieve the same effect. However, by today most clients and servers support the new IRCv3 standard.[22]

NICK

edit

Syntax:

NICK <nickname> [<hopcount>] (RFC 1459)
NICK <nickname> (RFC 2812)

Allows a client to change their IRC nickname. Hopcount is for use between servers to specify how far away a nickname is from its home server.[23][24] Defined in RFC 1459; the optional <hopcount> parameter was removed in RFC 2812.

NOTICE

edit

Syntax:

NOTICE <msgtarget> <message>

This command works similarly to PRIVMSG, except automatic replies must never be sent in reply to NOTICE messages.[25] Defined in RFC 1459.

OPER

edit

Syntax:

OPER <username> <password>

Authenticates a user as an IRC operator on that server/network.[26] Defined in RFC 1459.

PART

edit

Syntax:

PART <channels> [<message>]

Causes a user to leave the channels in the comma-separated list <channels>.[27] Defined in RFC 1459.

PASS

edit

Syntax:

PASS <password>

Sets a connection password.[28] This command must be sent before the NICK/USER registration combination. Defined in RFC 1459.

PING

edit

Syntax:

PING <server1> [<server2>]

Tests the presence of a connection.[29] A PING message results in a PONG reply. If <server2> is specified, the message gets passed on to it. Defined in RFC 1459.

PONG

edit

Syntax:

PONG <server1> [<server2>]

This command is a reply to the PING command and works in much the same way.[30] Defined in RFC 1459.

PRIVMSG

edit

Syntax:

PRIVMSG <msgtarget> :<message>

Sends <message> to <msgtarget>, which is usually a user or channel.[31] Defined in RFC 1459.

QUIT

edit

Syntax:

QUIT [<message>]

Disconnects the user from the server.[32] Defined in RFC 1459.

QUOTE

edit

Syntax:

QUOTE

Sends a command string to the server as-is, i.e. without parsing it in the client application. [33] [34]

REHASH

edit

Syntax:

REHASH

Causes the server to re-read and re-process its configuration file(s).[35] This command can only be sent by IRC operators. Defined in RFC 1459.

RULES

edit

Syntax:

RULES

Requests the server rules. This command is not formally defined in an RFC, but is used by most[which?] major IRC daemons.

SERVER

edit

Syntax:

SERVER <servername> <hopcount> <info>

The server message is used to tell a server that the other end of a new connection is a server.[36] This message is also used to pass server data over the whole network. <hopcount> details how many hops (server connections) away <servername> is. <info> contains addition human-readable information about the server.

Defined in RFC 1459.

SERVICE

edit

Syntax:

SERVLIST

edit

SQUERY

edit

Syntax:

SQUERY <servicename> <text>

Identical to PRIVMSG except the recipient must be a service.[37] Defined in RFC 2812.

SQUIT

edit

Syntax:

SQUIT <server> <comment>

Causes <server> to quit the network.[38] Defined in RFC 1459.

SETNAME

edit

Syntax:

SETNAME <new real name>

Allows a client to change the "real name" specified when registering a connection.

This command is not formally defined by an RFC, but is in use by some IRC daemons. Support is indicated in a RPL_ISUPPORT reply (numeric 005) with the SETNAME keyword

SILENCE

edit

Syntax:

SILENCE [+/-<hostmask>]

Adds or removes a host mask to a server-side ignore list that prevents matching users from sending the client messages. More than one mask may be specified in a space-separated list, each item prefixed with a "+" or "-" to designate whether it is being added or removed. Sending the command with no parameters returns the entries in the client's ignore list.

This command is not formally defined in an RFC, but is supported by most[which?] major IRC daemons. Support is indicated in a RPL_ISUPPORT reply (numeric 005) with the SILENCE keyword and the maximum number of entries a client may have in its ignore list. For example:

:irc.server.net 005 WiZ WALLCHOPS WATCH=128 SILENCE=15 MODES=12 CHANTYPES=#

STATS

edit

Syntax:

STATS <query> [<server>]

Returns statistics about the current server, or <server> if it's specified.[39] Defined in RFC 1459.

SUMMON

edit

Syntax:

SUMMON <user> [<server>] (RFC 1459)
SUMMON <user> [<server> [<channel>]] (RFC 2812)

Gives users who are on the same host as <server> a message asking them to join IRC.[40][41] Defined in RFC 1459; the optional <channel> parameter was added in RFC 2812.

TIME

edit

Syntax:

TIME [<server>]

Returns the local time on the current server, or <server> if specified.[42] Defined in RFC 1459.

TOPIC

edit

Syntax:

TOPIC <channel> [<topic>]

Allows the client to query or set the channel topic on <channel>.[43] If <topic> is given, it sets the channel topic to <topic>. If channel mode +t is set, only a channel operator may set the topic. Defined in RFC 1459.

TRACE

edit

Syntax:

TRACE [<target>]

Trace a path across the IRC network to a specific server or client, in a similar method to traceroute.[44] Defined in RFC 1459.

USER

edit

Syntax:

USER <username> <hostname> <servername> <realname> (RFC 1459)
USER <user> <mode> <unused> <realname> (RFC 2812)

This command is used at the beginning of a connection to specify the username, hostname, real name and initial user modes of the connecting client.[45][46] <realname> may contain spaces, and thus must be prefixed with a colon. Defined in RFC 1459, modified in RFC 2812.

USERHOST

edit

Syntax:

USERHOST <nickname> [<nickname> <nickname> ...]

Returns a list of information about the nicknames specified.[47] Defined in RFC 1459.

USERIP

edit

Syntax:

USERIP <nickname>

Requests the direct IP address of the user with the specified nickname. This command is often used to obtain the IP of an abusive user to more effectively perform a ban. It is unclear what, if any, privileges are required to execute this command on a server.

This command is not formally defined by an RFC, but is in use by some IRC daemons. Support is indicated in a RPL_ISUPPORT reply (numeric 005) with the USERIP keyword.

USERS

edit

Syntax:

USERS [<server>]

Returns a list of users and information about those users in a format similar to the UNIX commands who, rusers and finger.[48] Defined in RFC 1459.

VERSION

edit

Syntax:

VERSION [<server>]

Returns the version of <server>, or the current server if omitted.[49] Defined in RFC 1459.

WALLOPS

edit

Syntax:

WALLOPS <message>

Sends <message> to all operators connected to the server (RFC 1459), or all users with user mode 'w' set (RFC 2812).[50][51] Defined in RFC 1459.

WATCH

edit

Syntax:

WATCH [+/-<nicknames>]

Adds or removes a user to a client's server-side friends list. More than one nickname may be specified in a space-separated list, each item prefixed with a "+" or "-" to designate whether it is being added or removed. Sending the command with no parameters returns the entries in the client's friends list.

This command is not formally defined in an RFC, but is supported by most[which?] major IRC daemons. Support is indicated in a RPL_ISUPPORT reply (numeric 005) with the WATCH keyword and the maximum number of entries a client may have in its friends list. For example:

:irc.server.net 005 WiZ WALLCHOPS WATCH=128 SILENCE=15 MODES=12 CHANTYPES=#

Syntax:

WHO [<name> ["o"]]

Returns a list of users who match <name>.[52] If the flag "o" is given, the server will only return information about IRC operators. Defined in RFC 1459.

WHOIS

edit

Syntax:

WHOIS [<server>] <nicknames>

Returns information about the comma-separated list of nicknames masks <nicknames>.[53] If <server> is given, the command is forwarded to it for processing. Defined in RFC 1459.

WHOWAS

edit

Syntax:

WHOWAS <nickname> [<count> [<server>]]

Used to return information about a nickname that is no longer in use (due to client disconnection, or nickname changes).[54] If given, the server will return information from the last <count> times the nickname has been used. If <server> is given, the command is forwarded to it for processing. In RFC 2812, <nickname> can be a comma-separated list of nicknames.[55]

Defined in RFC 1459.

See also

edit

References

edit
  1. ^ Admin command. p. 31. sec. 4.3.7. doi:10.17487/RFC1459. RFC 1459.
  2. ^ Away. pp. 38 – 39. sec. 5.1. doi:10.17487/RFC1459. RFC 1459.
  3. ^ Connect message. pp. 29 – 30. sec. 4.3.5. doi:10.17487/RFC1459. RFC 1459.
  4. ^ Connect message. pp. 28 – 29. sec. 3.4.7. doi:10.17487/RFC2812. RFC 2812.
  5. ^ Die message. p. 39. sec. 4.3. doi:10.17487/RFC2812. RFC 2812.
  6. ^ "Archived copy". Archived from the original on 5 June 2013. Retrieved 6 December 2012.{{cite web}}: CS1 maint: archived copy as title (link)
  7. ^ Error. p. 38. sec. 4.6.4. doi:10.17487/RFC1459. RFC 1459.
  8. ^ Info command. pp. 31 – 32. sec. 4.3.8. doi:10.17487/RFC1459. RFC 1459.
  9. ^ Invite message. p. 25. sec. 4.2.7. doi:10.17487/RFC1459. RFC 1459.
  10. ^ Ison message. p. 42. sec. 5.8. doi:10.17487/RFC1459. RFC 1459.
  11. ^ Join message. pp. 19 – 20. sec. 4.2.1. doi:10.17487/RFC1459. RFC 1459.
  12. ^ Kick command. pp. 25 – 26. sec. 4.2.8. doi:10.17487/RFC1459. RFC 1459.
  13. ^ Kill message. p. 36. sec. 4.6.1. doi:10.17487/RFC1459. RFC 1459.
  14. ^ Links message. pp. 28 – 29. sec. 4.3.3. doi:10.17487/RFC1459. RFC 1459.
  15. ^ List message. pp. 24 – 25. sec. 4.2.6. doi:10.17487/RFC1459. RFC 1459.
  16. ^ Lusers message. pp. 25 – 26. sec. 3.4.2. doi:10.17487/RFC2812. RFC 2812.
  17. ^ Mode message. pp. 21 – 23. sec. 4.2.3. doi:10.17487/RFC1459. RFC 1459.
  18. ^ Motd message. p. 25. sec. 3.4.1. doi:10.17487/RFC2812. RFC 2812.
  19. ^ Names message. p. 24. sec. 4.2.5. doi:10.17487/RFC1459. RFC 1459.
  20. ^ Names message. pp. 20 – 21. sec. 3.2.5. doi:10.17487/RFC2812. RFC 2812.
  21. ^ Andrew Northall. "IRCv3 – Welcome". atheme.org. ircv3.net. Archived from the original on 9 January 2015. Retrieved 21 February 2016.
  22. ^ Andrew Northall. "IRCv3 – Welcome". atheme.org. Archived from the original on 17 February 2015. Retrieved 21 February 2016.
  23. ^ Nick message. pp. 14 – 15. sec. 4.1.2. doi:10.17487/RFC1459. RFC 1459.
  24. ^ Nick message. pp. 10 – 11. sec. 3.1.2. doi:10.17487/RFC2812. RFC 2812.
  25. ^ Notice. p. 33. sec. 4.4.2. doi:10.17487/RFC1459. RFC 1459.
  26. ^ Oper. p. 17. sec. 4.1.5. doi:10.17487/RFC1459. RFC 1459.
  27. ^ Part message. pp. 20 – 21. sec. 4.2.2. doi:10.17487/RFC1459. RFC 1459.
  28. ^ Password message. p. 14. sec. 4.1.1. doi:10.17487/RFC1459. RFC 1459.
  29. ^ Ping message. p. 37. sec. 4.6.2. doi:10.17487/RFC1459. RFC 1459.
  30. ^ Pong message. pp. 37 – 38. sec. 4.6.3. doi:10.17487/RFC1459. RFC 1459.
  31. ^ Private messages. pp. 32 – 33. sec. 4.4.1. doi:10.17487/RFC1459. RFC 1459.
  32. ^ Quit. pp. 17 – 18. sec. 4.1.6. doi:10.17487/RFC1459. RFC 1459.
  33. ^ Irssi developers. "quote - Irssi help page".
  34. ^ /quote is cited in the mIRC documentation ([1]) as an equivalent of mIRC's /raw command, but which is supported in the other IRC clients.
  35. ^ Rehash message. p. 39. sec. 5.2. doi:10.17487/RFC1459. RFC 1459.
  36. ^ Server message. pp. 16 – 17. sec. 4.1.4. doi:10.17487/RFC1459. RFC 1459.
  37. ^ Squery. p. 32. sec. 3.5.2. doi:10.17487/RFC2812. RFC 2812.
  38. ^ Server quit message. pp. 18 – 19. sec. 4.1.7. doi:10.17487/RFC1459. RFC 1459.
  39. ^ Stats message. pp. 27 – 28. sec. 4.3.2. doi:10.17487/RFC1459. RFC 1459.
  40. ^ Summon message. p. 40. sec. 5.4. doi:10.17487/RFC1459. RFC 1459.
  41. ^ Summon message. p. 40. sec. 4.5. doi:10.17487/RFC2812. RFC 2812.
  42. ^ Time message. p. 29. sec. 4.3.4. doi:10.17487/RFC1459. RFC 1459.
  43. ^ Topic message. pp. 23 – 24. sec. 4.2.4. doi:10.17487/RFC1459. RFC 1459.
  44. ^ Trace message. pp. 30 – 31. sec. 4.3.6. doi:10.17487/RFC1459. RFC 1459.
  45. ^ User message. pp. 15 – 16. sec. 4.1.3. doi:10.17487/RFC1459. RFC 1459.
  46. ^ User message. p. 11. sec. 3.1.3. doi:10.17487/RFC2812. RFC 2812.
  47. ^ Userhost message. p. 42. sec. 5.7. doi:10.17487/RFC1459. RFC 1459.
  48. ^ Users. pp. 40 – 41. sec. 5.5. doi:10.17487/RFC1459. RFC 1459.
  49. ^ Version message. pp. 26 – 27. sec. 4.3.1. doi:10.17487/RFC1459. RFC 1459.
  50. ^ Operwall message. p. 41. sec. 5.6. doi:10.17487/RFC1459. RFC 1459.
  51. ^ Operwall message. pp. 41 – 42. sec. 4.7. doi:10.17487/RFC2812. RFC 2812.
  52. ^ Who query. pp. 33 – 34. sec. 4.5.1. doi:10.17487/RFC1459. RFC 1459.
  53. ^ Whois query. pp. 34 – 35. sec. 4.5.2. doi:10.17487/RFC1459. RFC 1459.
  54. ^ Whowas. p. 35. sec. 4.5.3. doi:10.17487/RFC1459. RFC 1459.
  55. ^ Whowas. p. 34. sec. 3.6.3. doi:10.17487/RFC2812. RFC 2812.

Bibliography

edit

Further reading

edit