IRC Server Commands

[an error occurred while processing this directive]

This is a partial HTML version of the help available on 
the IRC server by typing /HELPOP. This document covers 
user commands and modes, and channel modes in UnrealIRCd3.2. 
See Unreal3.2.3 Release Notes for new and changed 
features.

Written by hAtbLaDe
Revised by CC (07/2002)
HTML fragment by deoxy.org

Also see Modules and Services.

Server Commands
/HELPOP USERCMDS - To get the list of User Commands
/HELPOP UMODES   - To get the list of User Modes
/HELPOP CHMODES  - To get the list of Channel Modes

Usercmds
Currently the following User commands are available.
Use /HELPOP <command name> to get more information about
a specific command.

ADMIN   KICK    MOTD    QUIT     VERSION
AWAY    KNOCK   NAMES   RULES    VHOST
CREDITS LICENSE NICK    SETNAME  WATCH
CYCLE   LINKS   NOTICE  SILENCE  WHO
DALINFO LIST    PART    STATS    WHOIS
INVITE  LUSERS  PING    TIME     WHOWAS
ISON    MAP     PONG    TOPIC
JOIN    MODE    PRIVMSG USERHOST


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>


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


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> in <#channel> only
 Ex: /NOTICE @#room This goes to all ops
     /NOTICE +%@#room This goes to all +v, +h and +o's.
-
/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 $*.mynet.net 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.fyremoon.net
         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.fyremoon.net irc2.dynam.ac
         (PONG message from irc.fyremoon.net 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> in <#channel> only
 Ex: /PRIVMSG @#room This goes to all ops
     /PRIVMSG +%@#room This goes to all +v, +h and +o's.
-
/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 $*.mynet.net 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


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.
-
Synatx:  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 the watchlist)


Who

Retrieves information about users
-
Syntax:
/WHO [+|-][acghmnsuCM] [args]
Flags are specified like channel modes, the flags cgmnsu all have arguments
Flags are set to a positive check by +, a negative check by -
-
The flags available:
Flag a: user is away
Flag c <channel>: user is on <channel>, no wildcards accepted
Flag g <gcos/realname>: user has string <gcos> in their GCOS,wildcards accepted, oper only
Flag h <host>: user has string <host> in their hostname, wildcards are accepted
Flag m <usermodes>: user has <usermodes> set on them, only o/A/a for nonopers
Flag n <nick>: user has string <nick> in their nickname, wildcards accepted
Flag s <server>: user is on server <server>, wildcards not accepted
Flag u <user>: user has string <user> in their username, wildcards accepted
-
Behavior flags:
Flag C: show first visible channel user is in
Flag M: check for user in channels I am a member of
-
For backwards compatibility, /who 0 o still shows +o users
Example: WHO +m o


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


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


Umodes

Here is a list of all the usermodes which are available for use.
-
o = Global IRC Operator
O = Local IRC Operator
a = Is a Services Administrator
A = Is a Server Administrator
N = Is a Network Administrator
C = Is a Co Administrator
-
d = Makes it so you can not receive channel PRIVMSGs (Deaf)
g = Can read & send to GlobOps, and LocOps
h = Available for Help (Help Operator)
i = Invisible (Not shown in /WHO searches)
p = Hide all channels in /whois and /who
q = Only U:lines can kick you (Services Admins/Net Admins only)
r = Identifies the nick as being Registered (settable by services only)
s = Can listen to Server notices
t = Says that you are using a /VHOST
v = Receive infected DCC send rejection notices
w = Can listen to Wallop messages
x = Gives the user Hidden Hostname (security)
z = Marks the client as being on a Secure Connection (SSL)
B = Marks you as being a Bot
G = Filters out all Bad words in your messages with <censored>
H = Hide IRCop status in /WHO and /WHOIS. (IRC Operators only)
R = Allows you to only receive PRIVMSGs/NOTICEs from registered (+r) users
S = For Services only. (Protects them)
T = Prevents you from receiving CTCPs
V = Marks the client as a WebTV user
W = Lets you see when people do a /WHOIS on you (IRC Operators only)


Chmodes

This section lists all of the possible channel modes that may be used with /MODE
-
v <nickname> = Gives Voice to the user (May talk if chan is +m)
h <nickname> = Gives HalfOp status to the user (Limited op access)
o <nickname> = Gives Operator status to the user
a <nickname> = Gives Channel Admin to the user
q <nickname> = Gives Owner status to the user
-
b <nick!ident@host> = Bans the nick!ident@host from the channel [h]
c = Block messages containing mIRC color codes [o]
e <nick!ident@host> = Overrides a ban for matching users [h]
I <nick!ident@host> = Overrides +i for matching users [h]
f <floodparams> = Flood protection (for more info see /HELPOP CHMODEF) [o]
i = A user must be invited to join the channel [h]
j <joins:sec> = Throttle joins per-user to 'joins' per 'sec' seconds [o]
k <key> = Users must specify <key> to join [h]
l <number of max users> = Channel may hold at most <number> of users [o]
m = Moderated channel (only +vhoaq users may speak) [h]
n = Users outside the channel can not send PRIVMSGs to the channel [h]
p = Private channel [o]
r = The channel is registered (settable by services only)
s = Secret channel [o]
t = Only +hoaq may change the topic [h]
z = Only Clients on a Secure Connection (SSL) can join [o]
A = Server/Net Admin only channel (settable by Admins)
C = No CTCPs allowed in the channel [o]
G = Filters out all Bad words in messages with <censored> [o]
M = Must be using a registered nick (+r) to talk [o]
K = /KNOCK is not allowed [o]
L <chan2> = Channel link (If +l is full, the next user will auto-join <chan2>) [q]
N = No Nickname changes are permitted in the channel [o]
O = IRC Operator only channel (settable by IRCops)
Q = No kicks allowed [o]
R = Only registered (+r) users may join the channel [o]
S = Strips mIRC color codes [o]
T = No NOTICEs allowed in the channel [o]
V = /INVITE is not allowed [o]
u = Auditorium mode (/names and /who #channel only show channel ops) [q]
-
[h] requires at least halfop, [o] requires at least chanop, [q] requires owner



***** Chmodef *****
-
The +f channel mode provides comprehensive flood protection for a channel.
This mode allows you to prevent join, nick change, CTCP, text, and knock
floods. The syntax for this mode's parameter is as follows:
-
+f [<amount><type>{#<action>}{,...}]:<seconds>
-
The amount specifies the number of times the specified flood must occur
before action is taken. Below are the available types:
-
==-----Type-----Name--------Default Action---Other Actions-----==
        c        CTCP        +C               m, M
        j        Join        +i               R
        k        Knock       +k
        m        Messages    +m               M
        n        Nickchange  +N
        t        Text        kick             b
-
The difference between type m and t is that m is tallied for the entire
channel whereas t is tallied per user.
-
If you choose to specify an action for a mode, you may also specify a
time (in minutes) after which the specific action will be reversed.
-
EXAMPLES:

Perform the default action (kick) for "t" (text) if 5 lines are sent in 5 seconds:

	/mode #chan +f [5t]:5

Kick and enforce a ban for sending 5 lines in 5 seconds:

	/mode #chan +f [5t#b]:5

Perform default actions for 5 joins (+i) or 5 nick changes (+N) in 5 seconds:

	/mode #chan +f [5j,5n]:5

Also see BotServ KICK