Usercommand
ADMIN
Provides Administrative information regarding the server.
Syntax:
ADMIN ADMIN <server>
AWAY
Sets your online status to "Away".
Syntax:
AWAY <reason> (Sets you Away with the reason given) AWAY (Un-Sets you as Away)
Example:
AWAY Lunch time!
CREDITS
This command will list the Credits to all the people who helped create UnrealIRCd.
Syntax:
CREDITS CREDITS <server>
CYCLE
Cycles the given channel(s). This command is equivilent to sending a PART then a JOIN command.
Syntax:
CYCLE <chan1>,<chan2>,<chan3>
Example:
CYCLE #help
Example:
CYCLE #main,#chat
DALINFO
This command will show historical credits (from ircu, etc..)
Syntax:
DALINFO
Syntax:
DALINFO <server>
DCCALLOW
/DCCALLOW [<+|->nick[,<+|->nick, ...]] [list] [help]
You may allow DCCs of files which are otherwise blocked by the IRC server by specifying a DCC allow for the user you want to recieve files from. For instance, to allow the user Bob to send you file.exe, you would type:
/DCCALLOW +bob
and Bob would then be able to send you files. Bob will have to resend the file if the server gave him an error message before you added him to your allow list.
/DCCALLOW -bob
Will do the exact opposite, removing him from your dcc allow list.
/dccallow list
Will list the users currently on your dcc allow list.
INVITE
Sends a user an Invitation to join a particular channel. If the channel is +i, you must be an Operator to use this command, otherwise any user may use the command. Invite without parameters lists the channels you have been invited to.
Syntax:
INVITE [<user> <channel>]
Example:
INVITE hAtbLaDe #Support
Example:
INVITE
ISON
Used to determine if certain user(s) are currently online based upon their nickname.
Syntax:
ISON <user> <user2> <user3> <user4>
Example:
ISON hAtbLaDe Stskeeps OperServ AOLBot
JOIN
Used to enter one or more channels on an IRC server. All occupants of the channel will be notified of your arrival. JOIN with 0 as a parameter makes you Part all channels. If you specify one or more keys, they will be used to join a +k channel
Syntax:
JOIN <chan>,<chan2>,<chan3> <key1>,<key2>,<key3> JOIN 0 (Parts all channels)
Example:
JOIN #Support JOIN #Lobby,#IRCd JOIN #IRCd,#Support,#main letmein,somepass,anotherpass
KICK
Removes a user from a channel. Can only be used by Operators or Half-Ops. If no reason is specified, your nickname becomes the reason.
Syntax:
KICK <channel> <user> [reason]
Example:
KICK #Lobby foobar Lamer..
KNOCK
For channels which are invite only, you can "Knock" on the channel to request an invite.
Syntax:
KNOCK <channel> <message>
Example:
KNOCK #secret_chan I'm an op, let me in!
LICENSE
This command displays information about the license UnrealIRCd is released under. Syntax:
LICENSE LICENSE <server>
LINKS
Lists all of the servers currently linked to the network. Only IRCops can see linked U-Lined servers.
Syntax:
LINKS
LIST
Provides a complete listing of all channels on the network. If a search string is specified, it will only show those matching the search string.
Syntax:
LIST <search string>
Example:
LIST LIST *ircd*
Some additional flags are also supported.
>number List channels with more than <number> people <number List channels with less than <number> people !*mask* List channels that do not match *mask*
Any of those may be used instead of a standard mask.
LUSERS
Provides Local and Global user information (Such as Current and Maximum user count).
Syntax:
LUSERS [server]
MAP
Provides a graphical "Network Map" of the IRC network. Mainly used for routing purposes.
Syntax:
MAP
MODE
Sets a mode on a Channel or User. Use /HELPOP CHMODES or /HELPOP UMODES to see a list of Modes
Syntax:
MODE <channel/user> <mode>
Example:
MODE #Support +tn MODE #Support +ootn hAtbLaDe XYZ
MODULE
This will show the list of modules loaded on the server. By default it will only list 3rd party modules, unless you use -all
Syntax:
MODULE [-all] [server]
Example:
MODULE
The output depends on whether you are a normal user or IRCOp: -- Normal user --
*** name - (description) [3RD] The [3RD] flag is present if it's a 3rd party module.
-- IRCOp --
*** name - version (description) [optional flags] The optional flags may contain: [PERM]: Permanent module, not possible to unload/reload. [PERM-BUT-RELOADABLE]: Module can be reloaded but not unloaded. [3RD] 3rd party module, module is not part of UnrealIRCd.
Additionally you will see a list of which hooks and command overrides are present (the hook number can be looked up in include/modules.h).
MOTD
Displays the Message Of The Day of the IRC Server you are logged onto.
Syntax:
MOTD MOTD <server>
NAMES
Provides a list of users on the specified channel.
Syntax:
NAMES <channel>
Example:
NAMES #Support
NICK
Changes your "Online Identity" on a server. All those in the channel you are in will be alerted of your nickname change.
Syntax:
NICK <new nickname>
Example:
NICK hAtbLaDe
NOTICE
Send a notice to a user, channel or server.
/NOTICE <nick> <text>
Send a notice to a user.
Ex: /NOTICE Blah hi, how are you?
/NOTICE <#channel> <text>
Send a notice to a channel.
Ex: /NOTICE #room Hi all, this is annoying
/NOTICE <prefix><#channel> <text>
Send a notice to users with <prefix> and higher in <#channel> only
Ex: /NOTICE @#room This goes to +oaq /NOTICE +#room This goes to +vhoaq
NOTE: You need at least voice in order to send to +#chan/%#chan/@#chan and at least ops to send to &#chan/~#chan.
/NOTICE $<mask> <text>
Send a notice to all users on servers matching <mask> [Oper only] This is shown in the status window by most clients. Ex:
/NOTICE $*.example.org We will be upgrading our net in the next hour
Note that in most cases services (/OS GLOBAL) is a better alternative.
Multiple targets are also supported, like /NOTICE <nick1>,<nick2>,<nick3>.
NOTE: In case of some old clients (eg: ircII) you cannot use /notice to use any of the 'advanced features', you'll then have to use: '/QUOTE NOTICE @#channel blah' or something similar.
PART
Used to part (or leave) a channel you currently occupy. All those in the channel will be notified of your departure. If you specify a reason it will be displayed to the users on the channel
Syntax:
PART <chan>,<chan2>,<chan3>,<chan4> <reason>
Example:
PART #Support PART #Lobby,#IRCd See ya later!
PING
The PING command is used to test the presence of an active client or server at the other end of the connection. Servers send a PING message at regular intervals if no other activity detected coming from a connection. If a connection fails to respond to a PING message within a set amount of time, that connection is closed. A PING message MAY be sent even if the connection is active. Note that this is different from a CTCP PING command..
Syntax:
PING <server> <server2>
Example:
PING irc.example.org PING hAtbLaDe PING hAtbLaDe irc2.dynam.ac
PONG
PONG message is a reply to PING message. If parameter <server2> is given, this message will be forwarded to given target. The <server> parameter is the name of the entity who has responded to PING message and generated this message.
Syntax:
PONG <server> <server2>
Example:
PONG irc.example.org irc2.dynam.ac (PONG message from irc.example.org to irc2.dynam.ac)
PRIVMSG
Send a message to a user, channel or server.
/PRIVMSG <nick> <text>
Send a private message. Ex:
/PRIVMSG Blah hi, how are you?
/PRIVMSG <#channel> <text>
Send a message to a channel. Ex:
/PRIVMSG #room Hi all
/PRIVMSG <prefix><#channel> <text>
Send a message to users with <prefix> and higher in <#channel> only Ex:
/PRIVMSG @#room This goes to +oaq /PRIVMSG +#room This goes to +vhoaq
NOTE: You need at least voice in order to send to +#chan/%#chan/@#chan and at least ops to send to &#chan/~#chan.
/PRIVMSG $<mask> <text>
Send a message to all users on servers matching <mask> [Oper only] This is shown in the status window by most clients. Ex:
/PRIVMSG $*.example.org We will be upgrading our net in the next hour
Note that in most cases services (/OS GLOBAL) is a better alternative.
Multiple targets are also supported, like /PRIVMSG <nick1>,<nick2>,<nick3>.
NOTE: In case of some old clients (eg: ircII) you cannot use /msg or /privmsg to use any of the 'advanced features', you'll then have to use: '/QUOTE PRIVMSG @#channel blah' or something similar.
QUIT
Disconnects you from the IRC server. Those in the channels you occupy will be notified of your departure. If you do not specify a reason, your nickname becomes the reason.
Syntax:
QUIT <reason>
Example:
QUIT Leaving!
RULES
Shows you the Rules of the Network.
Syntax:
RULES RULES <server>
SETNAME
Allows users to change their "Real name" (GECOS) directly online at IRC without reconnecting
Syntax:
SETNAME <New Real Name>
SILENCE
Ignores messages from a user or list of users at the Server itself.
Syntax:
SILENCE +nickname (Adds a nickname to SILENCE list) SILENCE -nickname (Removes a nickname from the SILENCE list) SILENCE (Lists the current SILENCE list)
STATS
Provides certain Statistical information about the server
Syntax:
STATS <flags>
Example:
STATS u
Type /stats without parameters to get a list of available flags.
TIME
Displays the current Server Date and Time.
Syntax:
TIME TIME <server>
TOPIC
Sets/Changes the topic of the channel in question, or just display the current Topic.
Syntax:
TOPIC <channel> (Displays the current topic) TOPIC <channel> <topic> (Changes topic)
Example:
TOPIC #Operhelp TOPIC #Lobby Welcome to #Lobby!!
USERHOST
Returns the userhost of the user in question. Usually used by scripts or bots.
Syntax:
USERHOST <nickname>
Example:
USERHOST hAtbLaDe
USERIP
Returns the userip of the user in question. Usually used by scripts or bots.
Syntax:
USERIP <nickname>
Example:
USERIP codemastr
VERSION
Provides Version information of the IRCd software in usage.
Syntax:
VERSION VERSION <server>
VHOST
Hides your real hostname with a virtual hostname provided by the IRC server , using SETHOST.
Syntax:
VHOST <login> <password>
Example:
VHOST openbsd ilovecypto
WATCH
Watch is a notify-type system on the server which is both faster and uses less network resources than any old-style notify system. The server will send you a message when any nickname in your watch list logs on or off. The watch list DOES NOT REMAIN BETWEEN SESSIONS - You (or your script or client) must add the nicknames to your watch list every time you connect to an IRC server.
Syntax:
WATCH +nick1 +nick2 +nick3 (Add nicknames) WATCH -nick (Delete nicknames) WATCH (View which users are online)
WHO
Retrieves information about users In its most simple form the syntax is 'WHO #channel' or 'WHO nickname' However we also support the extended who syntax (WHOX):
Syntax:
/WHO <mask> [options] /WHO <mask> [options [mask2]]
The mask can contain wildcards such as * and ?
The options consist of [<flags>][%[<fields>[,<querytype>]]] Where: The <flags> define where to SEARCH on, and may contain one or more letters:
n: nick name u: user name (ident) h: host name [*] i: IP address [*] s: server name [*] r: real name (gecos) a: account name (services account) m: user modes (the mask contains for example +z or -z) [*] R: sets output to show real hostnames [*] I: sets output to show IP addresses [*] Items marked with [*] mean that IRCOp privileges are (possibly) required.
The <fields> decide which fields appear in the WHO output (note that any fields are always outputed in this order:)
t: querytype (the <querytype> parameter that was provided in <options>) c: first channel name the user is on u: user name (ident) i: IP Address [*] h: hostname [*] H: real hostname [*] s: server name n: nick name f: status flags (explained later) m: user modes [*] d: number of server hops (eg: 0 means user is on same server) l: seconds idle (only for users on the same server as you, otherwise 0) a: account name (services account) o: operclass name [*] r: real name (gecos) Items marked with [*] mean that IRCOp privileges are (possibly) required.
And finally, the <querytype> is a word that clients can use to tag WHO requests so they can easily see which WHO response belongs to what WHO request.
Examples of simple WHO requests:
WHO #channel - To list all users in a channel WHO 1.2.3.4 - To show all users with this IP address (IRCOp only)
Examples of WHOX requests:
WHO Servic* n - Show all users which name starts with Servic (Only IRCOps are likely to see the full list) WHO #chan cI - Show all users in channel #chan with their IP address instead of hostname (IRCOp only) WHO z m - Show all users with user mode z set, that is: all users on SSL/TLS. (IRCOp only command) WHO -z m - Show all insecure users, without umode z. (IRCOp only command)
Examples of WHOX requests using output modifiers:
WHO #test %acfhnru - Show all users in the channel #test and show various fields, among which 'a' (services account) is not displayed by normal WHO.
Status flags: The WHO command shows several flags in the returned result to indicate different information about the user. These flags are explained below: G - User is /away (gone) H - User is not /away (here) r - User is using a registered nickname B - User is a bot (+B) s - User is securely connected (SSL/TLS)
- - User is an IRC Operator
~ - User is a Channel Owner (+q) & - User is a Channel Admin (+a) @ - User is a Channel Operator (+o) % - User is a Halfop (+h) + - User is Voiced (+v) ! - User is +H and you are an IRC Operator
WHOIS
Shows information about the user in question, such as their "Name", channels they are currently in, their hostmask, etc.
Syntax:
WHOIS <user>
Example:
WHOIS hAtbLaDe
Status flags: The list of channels shown in the WHOIS reply can include one or more status flags to indicate information about the channel. These flags are described below:
~ - User is a Channel Owner (+q) & - User is a Channel Admin (+a) @ - User is a Channel Operator (+o) % - User is a Halfop (+h) + - User is Voiced (+v) ! - User has channels hidden in whois (+p) and you are an IRC Operator ? - The channel is secret (+s) and you are an IRC Operator
WHOWAS
Retrieves previous WHOIS information for users no longer connected to the server.
Syntax:
WHOWAS <nickname> WHOWAS <nickname> <max number of replies>
Example:
WHOWAS hAtbLaDe
