ChanServ Command Reference

ChanServ allows you to register and control various aspects of channels. ChanServ can often prevent malicious users from "taking over" channels by limiting who is allowed channel operator priviliges. Available commands are listed below; to use them, type /msg ChanServ command. For more information on a specific command, type /msg ChanServ HELP command.

REGISTER

Syntax:

REGISTER channel password description

Registers a channel in the ChanServ database. In order to use this command, you must first be a channel operator on the channel you're trying to register. The password is used with the IDENTIFY command to allow you to make changes to the channel settings at a later time. The last parameter, which must be included, is a general description of the channel's purpose.

When you register a channel, you are recorded as the "founder" of the channel. The channel founder is allowed to change all of the channel settings for the channel; ChanServ will also automatically give the founder channel-operator privileges when s/he enters the channel. See the ACCESS command (/msg ChanServ HELP ACCESS) for information on giving a subset of these privileges to other channel users.

NOTICE: In order to register a channel, you must have first registered and identified for your nickname. If you haven't, /msg NickServ HELP for information on how to do so.

SENDPASS

Syntax:

SENDPASS channel

Sends you an E-mail message containing the password for the given channel. You must be the founder of the channel to use this command, and you must first identify for your nickname with the NickServ IDENTIFY command.

IDENTIFY

Syntax:

IDENTIFY channel password

Authenticates you to ChanServ as the founder of the given channel. Many commands require you to use this command before using them. The password should be the same one you sent with the REGISTER command.

DROP

Syntax:

DROP channel

Unregisters the named channel. Can only be used by channel founder, who must use the IDENTIFY command first.

SET

Syntax:

SET channel option parameters

Allows the channel founder to set various channel options and other information. The founder must use the IDENTIFY command before using SET.

Available options:

FOUNDER

Set the founder of a channel

SUCCESSOR

Set the successor for a channel

PASSWORD

Set the founder password

DESC

Set the channel description

URL

Associate a URL with the channel

EMAIL

Associate an E-mail address with the channel

ENTRYMSG

Set a message to be sent to users when they enter the channel

TOPIC

Change the topic on the channel

KEEPTOPIC

Retain topic when channel is not in use

TOPICLOCK

Topic can only be changed with SET TOPIC

MLOCK

Lock channel modes on or off

PRIVATE

Hide channel from LIST command

RESTRICTED

Restrict access to the channel

SECURE

Activate ChanServ security features

SECUREOPS

Stricter control of chanop status

LEAVEOPS

Do not de-op users on channel entry

OPNOTICE

Send a notice when OP/DEOP commands are used

ENFORCE

Enforce auto-op, auto-voice status

SET FOUNDER

Syntax:

SET channel FOUNDER nick

Changes the founder of a channel. The new nickname must be a registered one.

SET SUCCESSOR

Syntax:

SET channel SUCCESSOR nick

Changes the successor of a channel. If the founder's nickname expires or is dropped while the channel is still registered, the successor will become the new founder of the channel. However, if the successor already has too many channels registered (20 by default, changeable with the CSMaxReg directive in modules.conf), the channel will be dropped instead, just as if no successor had been set. The nickname must be a registered one.

SET PASSWORD

Syntax:

SET channel PASSWORD password

Sets the password used to identify as the founder of the channel.

SET URL

Syntax:

SET channel URL url

Associates the given URL with the channel. This URL will be displayed whenever someone requests information on the channel with the INFO command.

SET EMAIL

Syntax:

SET channel EMAIL address

Associates the given E-mail address with the channel. This address will be displayed whenever someone requests information on the channel with the INFO command.

SET ENTRYMSG

Syntax:

SET channel ENTRYMSG message

Sets the message which will be sent via /NOTICE to users when they enter the channel.

SET TOPIC

Syntax:

SET channel TOPIC topic

Causes ChanServ to set the channel topic to the one specified. This command is most useful in conjunction with SET TOPICLOCK.

SET KEEPTOPIC

Syntax:

SET channel KEEPTOPIC {ON | OFF}

Enables or disables the topic retention option for a channel. When topic retention is set, the topic for the channel will be remembered by ChanServ even after the last user leaves the channel, and will be restored the next time the channel is created.

SET TOPICLOCK

Syntax:

SET channel TOPICLOCK {ON | OFF}

Enables or disables the topic lock option for a channel. When topic lock is set, ChanServ will not allow the channel topic to be changed except via the SET TOPIC command.

SET MLOCK

Syntax:

SET channel MLOCK modes

Sets the mode-lock parameter for the channel. ChanServ allows you to define certain channel modes to be always on (or off). The modes that can be locked are i, k, l, m, n, p, s, and t; each of these modes can be locked on, locked off, or not locked. The modes parameter is constructed exactly the same way as a /MODE command; that is, modes followed by a + are locked on, and modes followed by a - are locked off.

Warning: If you set a mode-locked key, as in the second example below, you should also set the RESTRICTED option for the channel (see HELP SET RESTRICTED), or anyone entering the channel when it is empty will be able to see the key!

Examples:

SET #channel MLOCK +nt-iklps

Forces modes n and t on, and modes i, k, l, p, and s off. Mode m is left free to be either on or off.

SET #channel MLOCK +knst-ilmp my-key

Forces modes k, n, s, and t on, and modes i, l, m, and p off. Also forces the channel key to be "my-key".

SET #channel MLOCK +

Removes the mode lock; all channel modes are free to be either on or off.

SET HIDE

Syntax:

SET channel HIDE {EMAIL | TOPIC | MLOCK} {ON | OFF}

Allows you to prevent certain pieces of information from being displayed when someone does a ChanServ INFO on the given channel. You can hide the channel's E-mail address (EMAIL), last topic (TOPIC), and mode lock (MLOCK). The second parameter specifies whether the information should be displayed (OFF) or hidden (ON).

Note that the topic will always be hidden if the channel is mode-locked +p or +s.

SET PRIVATE

Syntax:

SET channel PRIVATE {ON | OFF}

Enables or disables the private option for a channel. When private is set, a /msg ChanServ LIST will not include the channel in any lists.

SET RESTRICTED

Syntax:

SET channel RESTRICTED {ON | OFF}

Enables or disables the restricted access option for a channel. When restricted access is set, users who would normally be disallowed from having channel operator privileges (users with negative access levels and, if secure ops is set, users not on the access list) will instead be kicked and banned from the channel.

SET SECURE

Syntax:

SET channel SECURE {ON | OFF}

Enables or disables ChanServ's security features for a channel. When SECURE is set, only users who have registered their nicknames with NickServ and IDENTIFY'd with their password will be given privileges on the channel as controlled by the access list.

SET SECUREOPS

Syntax:

SET channel SECUREOPS {ON | OFF}

Enables or disables the secure ops option for a channel. When secure ops is set, users who are not on the userlist will not be allowed chanop status.

SET LEAVEOPS

Syntax:

SET channel LEAVEOPS {ON | OFF}

Enables or disables the leave ops option for a channel. When leave ops is set, ChanServ will leave server ops (+o for the first person in the channel) in place even if the user would not normally get auto-opped. The SECUREOPS option and AUTODEOP access level will still be enforced. Notice: This can allow users to "steal" ops during a netsplit.

SET OPNOTICE

Syntax:

SET channel OPNOTICE {ON | OFF}

Enables or disables the op-notice option for a channel. When op-notice is set, ChanServ will send a notice to the channel whenever the OP or DEOP commands are used for a user in the channel.

SET ENFORCE

Syntax:

SET channel ENFORCE {ON | OFF}

Enables or disables the enforce option for a channel. When enforce is set, ChanServ will enforce the auto-op and auto-voice levels for all users. For example, if a user with auto-op privileges is deopped, ChanServ will automatically op the user again, and ChanServ will also not allow the DEOP command to be used on that user.

UNSET

Syntax:

UNSET channel {SUCCESSOR | URL | EMAIL | ENTRYMSG}

Clears the given setting for a channel.

SOP  

Syntax:

SOP channel ADD nick
SOP channel DEL nick
SOP channel LIST [mask | list]
SOP channel COUNT

Maintains the SuperOp (SOP) list for a channel. Users with SOP status are automatically opped (set mode +o) and protected (mode +a, if supported by the IRC server) when they join the channel.

An SOP can modify the AOP, HOP (if the IRC server supports halfops), and VOP lists. Only a channel's founder can modify the SOP list.

The SOP LIST command displays the SOP list. If a wildcard mask is given, only those entries matching the mask are displayed. If a list of entry numbers is given, only those entries are shown; for example:

SOP #channel LIST 2-5,7-9

Lists SOP list entries numbered 2 through 5 and 7 through 9.

AOP

Syntax:

AOP channel ADD nick
AOP channel DEL nick
AOP channel LIST [mask | list]
AOP channel COUNT

Maintains the AutoOp (AOP) list for a channel. Users with AOP status are automatically opped (set mode +o) when they join the channel.

An AOP can modify the HOP (if the IRC server supports halfops) and VOP lists; SOPs can modify the AOP list.

The AOP LIST command displays the AOP list. If a wildcard mask is given, only those entries matching the mask are displayed. If a list of entry numbers is given, only those entries are shown; for example:

AOP #channel LIST 2-5,7-9

Lists AOP list entries numbered 2 through 5 and 7 through 9.

HOP  

Syntax:

HOP channel ADD nick
HOP channel DEL nick
HOP channel LIST [mask | list]
HOP channel COUNT

Maintains the HalfOp (HOP) list for a channel. Users with HOP status are automatically halfopped (set mode +h) when they join the channel.

An HOP can modify the VOP list; SOPs and AOPs can modify the HOP list.

The HOP LIST command displays the HOP list. If a wildcard mask is given, only those entries matching the mask are displayed. If a list of entry numbers is given, only those entries are shown; for example:

HOP #channel LIST 2-5,7-9

Lists HOP list entries numbered 2 through 5 and 7 through 9.

Note that this command is only available if the IRC server in use supports halfops.

VOP  

Syntax:

VOP channel ADD nick
VOP channel DEL nick
VOP channel LIST [mask | list]
VOP channel COUNT

Maintains the VoiceOp (VOP) list for a channel. Users with VOP status are automatically voiced (set mode +v) when they join the channel.

The VOP LIST command displays the VOP list. If a wildcard mask is given, only those entries matching the mask are displayed. If a list of entry numbers is given, only those entries are shown; for example:

VOP #channel LIST 2-5,7-9

Lists VOP list entries numbered 2 through 5 and 7 through 9.

ACCESS  

Syntax:

ACCESS channel ADD nick level
ACCESS channel DEL {nick | entry-num | list}
ACCESS channel LIST [mask | list]
ACCESS channel COUNT

Maintains the access list for a channel. The access list specifies which users are allowed chanop status or access to ChanServ commands on the channel. Different user levels allow for access to different subsets of privileges; /msg ChanServ HELP ACCESS LEVELS for more specific information. Any nick not on the access list has a user level of 0.

The ACCESS ADD command adds the given nickname to the access list with the given user level; if the nick is already present on the list, its access level is changed to the level specified in the command. The level specified must be less than that of the user giving the command, and if the nick is already on the access list, the current access level of that nick must be less than the access level of the user giving the command.

The ACCESS DEL command removes the given nick from the access list. If a list of entry numbers is given, those entries are deleted. (See the example for LIST below.)

The ACCESS LIST command displays the access list. If a wildcard mask is given, only those entries matching the mask are displayed. If a list of entry numbers is given, only those entries are shown; for example:

ACCESS #channel LIST 2-5,7-9

Lists access entries numbered 2 through 5 and 7 through 9.

The ACCESS COUNT command returns the number of entries there are on the access list.

Note that the access list may also be manipulated with the SOP, AOP, and HOP, and VOP commands, which correspond to levels of 10, 5, 4, and 3 respectively, if the chanserv/access-xop module is also loaded.

LEVELS  

Syntax:

LEVELS channel SET type level
LEVELS channel {DIS | DISABLE} type
LEVELS channel LIST
LEVELS channel RESET

The LEVELS command allows fine control over the meaning of the numeric access levels used by the ACCESS command. With this command, you can define the access level required for most of ChanServ's functions. (The SET FOUNDER and SET PASSWORD commands, as well as this command, are always restricted to the channel founder.)

Caution: This command is for advanced users only! Changing level settings with this command may cause the SOP, AOP, and VOP commands to stop working correctly.

LEVELS SET allows the access level for a function or group of functions to be changed. LEVELS DISABLE (or DIS for short) disables an automatic feature or disallows access to a function by anyone other than the channel founder. LEVELS LIST shows the current levels for each function or group of functions. LEVELS RESET resets the levels to the default levels of a newly-created channel (see HELP ACCESS LEVELS).

For a list of the features and functions whose levels can be set, see HELP LEVELS DESC.

AKICK

Syntax:

AKICK channel ADD mask [reason]
AKICK channel DEL mask
AKICK channel LIST [mask | list]
AKICK channel VIEW [mask | list]
AKICK channel ENFORCE
AKICK channel COUNT

Maintains the AutoKick list for a channel. If a user on the AutoKick list attempts to join the channel, ChanServ will ban that user from the channel, then kick the user.

The AKICK ADD command adds the given nick or usermask to the AutoKick list. If a reason is given with the command, that reason will be used when the user is kicked; if not, the default reason is "You have been banned from the channel".

The AKICK DEL command removes the given nick or mask from the AutoKick list. It does not, however, remove any bans placed by an AutoKick; those must be removed manually.

The AKICK LIST command displays the AutoKick list, or optionally only those AutoKick entries which match the given mask. AKICK VIEW is similar, but shows more details.

The AKICK ENFORCE command causes ChanServ to enforce the current AKICK list by removing those users who match an AKICK mask.

The AKICK COUNT command returns how many entries there are on the AutoKick list.

INFO

Syntax:

INFO channel [ALL]

Lists information about the named registered channel, including its founder, time of registration, last time used, description, and mode lock, if any. If you are identified as the founder of the channel you're getting information for and ALL is specified, the entry message and successor will also be displayed.

OP

Syntax:

OP #channel [nick]

Ops a selected nick on a channel. If nick is not given, ops you. By default, limited to users with level 5 access and above on the channel.

DEOP

Syntax:

DEOP #channel [nick]

Deops a selected nick on a channel. If nick is not given, deops you. By default, limited to users with level 5 access and above on the channel.

VOICE

Syntax:

VOICE #channel [nick]

Voices a selected nick on a channel. If nick is not given, voices you. By default, limited to users with level 3 access and above on the channel.

DEVOICE

Syntax:

DEVOICE #channel [nick]

Devoices a selected nick on a channel. If nick is not given, devoices you. By default, limited to users with level 3 access and above on the channel.

HALFOP

Syntax:

HALFOP #channel [nick]

Gives halfop access to a selected nick on a channel. If nick is not given, gives you halfop access. By default, limited to users with level 4 access and above on the channel. Only available with IRC servers which support halfops.

DEHALFOP

Syntax:

DEHALFOP #channel [nick]

Removes halfop access from a selected nick on a channel. If nick is not given, removes halfop access from you. By default, limited to users with level 4 access and above on the channel. Only available with IRC servers which support halfops.

PROTECT

Syntax:

PROTECT #channel [nick]

Gives channel protection (mode +a) to a selected nick on a channel. If nick is not given, gives channel protection to you. By default, limited to users with level 10 access and above on the channel. Only available with IRC servers which support this mode.

DEPROTECT

Syntax:

DEPROTECT #channel [nick]

Removes channel protection (mode +a) from a selected nick on a channel. If nick is not given, removes channel protection from you. By default, limited to users with level 10 access and above on the channel. Only available with IRC servers which support this mode.

INVITE

Syntax:

INVITE channel

Tells ChanServ to invite you into the given channel. By default, only works if your access level on that channel is at least 5.

Note: If you get a message saying that the channel is not in use, it means that the channel is empty, and you can join it freely without needing to use this command.

UNBAN

Syntax:

UNBAN channel

Tells ChanServ to remove all bans preventing you from entering the given channel. By default, only works if your access level on that channel is at least 5.

KICK

Syntax:

KICK channel nick [reason]

Tells ChanServ to kick the given nickname from the given channel. The message included in the kick will show who used the KICK command, as well as the reason given with the command, if any. By default, only works if your access level on that channel is at least 5.

Note that protected (+a) users cannot be kicked with this command, even by the channel founder.

CLEAR

Syntax:

CLEAR channel what

Tells ChanServ to clear certain settings on a channel. what can be any of the following:

MODES

Clears all modes on the channel except those set in the channel's mode lock.

BANS

Clears all bans on the channel.

EXCEPTIONS

Clears all exceptions on the channel (only available if the IRC server supports ban exceptions).

OPS

Removes channel-operator status (mode +o) from all users.

HALFOPS

Removes halfop status (mode +h) from all users (only available if the IRC server supports halfops).

VOICES

Removes "voice" status (mode +v) from all users.

USERS

Removes (kicks) all users from the channel.

By default, your access level on the channel must be at least 10 to use this command.