ChanServ

From NYC Resistor Wiki
Jump to: navigation, search

This page documents the various functions of ChanServ and gives information about how to use them.

Register[edit]

/msg ChanServ REGISTER #channel password description

Registers a channel in the database.

In order to use this command, you must first be a channel operator on the channel you're trying to register and have registered your nickname and identified yourself to NickServ. The password you give when registering the channel 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 that channel. The channel founder is allowed to change all of the channel settings for the channel and will be given founder channel-operator privileges when s/he enters the channel. See the ACCESS command for information on giving a subset of these privileges to other channel users.

Identify[edit]

/msg ChanServ 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[edit]

/msg ChanServ DROP #channel

Unregisters the named channel.

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

Default Access Levels[edit]

User access levels. This is not a command, but is the default levels set by ChanServ. Most people may never change these, however some may want to fine tune their' channels access levels. By default, the following access levels are defined: Founder Full access to ChanServ functions; automatic opping upon entering channel. Note that only one person may have founder status (it cannot be given using the ACCESS command).

  • 10 - Access to AKICK command; automatic opping.
  • 5 - Automatic opping.
  • 3 - Automatic voicing.
  • 0 - No special privileges; can be opped by other ops (unless secure-ops is set).
  • -1 - May not be opped.

These levels may be changed, or new ones added, using the LEVELS.

Levels[edit]

/msg ChanServ LEVELS #channel SET type level
/msg ChanServ LEVELS #channel {DIS | DISABLE} type
/msg ChanServ LEVELS #channel LIST
/msg ChanServ LEVELS #channel RESET

The LEVELS command allows fine control over the meaning of the numeric access levels used for channels. 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.) 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 ACCESS LEVELS).

AKick[edit]

/msg ChanServ AKICK #channel ADD mask [reason]
/msg ChanServ AKICK #channel DEL mask
/msg ChanServ AKICK #channel LIST [mask | list]
/msg ChanServ AKICK #channel VIEW [mask | list]
/msg ChanServ AKICK #channel ENFORCE
/msg ChanServ 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 and then kick the user.

AKICK ADD adds the given nick or usermask to the AutoKick list. If a reason is given with the command then that reason will be used when the user is kicked; if not, the default reason is "You have been banned from the channel". AKICK DEL 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. AKICK LIST displays the AutoKick list, or optionally only those AutoKick entries which match the given mask. AKICK VIEW simply shows more details about the AutoKick. AKICK ENFORCE causes ChanServ to enforce the current AKICK list by removing those users who match an AKICK mask. AKICK COUNT returns how many entries there are on the AutoKick list.

Info[edit]

/msg ChanServ 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.

List[edit]

/msg ChanServ LIST #pattern

Lists all registered channels matching the given pattern. (Channels with the PRIVATE option set are not listed.)

Op[edit]

/msg ChanServ OP #channel [nick]

Ops a selected nick on a channel. By default, limited to those with level 5 access and above on the channel. If nick is omitted, this command will attempt to op you in the specified channel.

Deop[edit]

/msg ChanServ DEOP #channel [nick]

Deops a selected nick on a channel. By default, limited to those with level 5 access and above on the channel. If nick is omitted, this command will attempt to deop you in the specified channel.

Voice[edit]

/msg ChanServ VOICE #channel [nick]

Gives the voice privilege to a user of the channel. By default, limited to use by those with level 5 access and above on the channel. If nick is omitted, this command will attempt to voice you in the specified channel, this by default requires level 3 access.

Devoice[edit]

/msg ChanServ DEVOICE #channel [nick]

Devoices a selected nick on a channel. If nick is omitted, this command will attempt to devoice you in the specified channel. Devoicing yourself by default requires level 3 access, devoicing others requires level 5 access by default.

Invite[edit]

/msg ChanServ INVITE #channel

Tells ChanServ to invite you into the given channel. By default, only works if your access level on that channel is greater than zero.

Unban[edit]

/msg ChanServ 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 greater than zero.

Clear[edit]

/msg ChanServ CLEAR #channel setting

Tells ChanServ to clear certain settings on a channel. By default, your access level on the channel must be at least 10 to use this command. The options available are as follows:

  • MODES Resets all modes on the channel (i.e. clears modes i,k,l,m,n,p,s,t).
  • BANS Clears all bans on the channel.
  • OPS Removes channel-operator status (mode +o) from all channel operators.
  • VOICES Removes "voice" status (mode +v) from anyone with that mode set.
  • USERS Removes (kicks) all users from the channel.

Set[edit]

/msg ChanServ 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.

The available options are as follows:

FOUNDER[edit]

/msg ChanServ SET #channel FOUNDER nick

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

SUCCESSOR[edit]

/msg ChanServ 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, the channel will be dropped instead, just as if no successor had been set. The new nickname must be a registered one.

PASSWORD[edit]

/msg ChanServ SET #channel PASSWORD password

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

DESC[edit]

/msg ChanServ SET #channel DESC description

Sets the description for the channel, which shows up with the LIST and INFO commands.

URL[edit]

/msg ChanServ 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. If no parameter is given, deletes any current URL for the channel.

EMAIL[edit]

/msg ChanServ 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. If no parameter is given, deletes any current E-mail address for the channel.

ENTRYMSG[edit]

/msg ChanServ SET #channel ENTRYMSG message

Sets the message which will be sent via /notice to users when they enter the channel. If no parameter is given, causes no message to be sent upon entering the channel.

TOPIC[edit]

/msg ChanServ 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.

KEEPTOPIC[edit]

/msg ChanServ 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.

TOPICLOCK[edit]

/msg ChanServ 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.

MLOCK[edit]

/msg ChanServ 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, or anyone entering the channel when it is empty will be able to see the key!

Examples:

/msg ChanServ 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.

/msg ChanServ 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".

/msg ChanServ SET #channel MLOCK +

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

PRIVATE[edit]

/msg ChanServ 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.

RESTRICTED[edit]

/msg ChanServ 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.

SECURE[edit]

/msg ChanServ #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 ChanServ and IDENTIFIED with their password will be given access to the channel as controlled by the access list.

SECUREOPS[edit]

/msg ChanServ 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.

LEAVEOPS[edit]

/msg ChanServ SET #channel LEAVEOPS {ON | OFF}

Enables or disables the leave ops option for a channel. When leave ops is set, ChanServ will never de-op a user in that channel except with the DEOP command.

VERBOSE[edit]

/msg ChanServ SET #channel VERBOSE {ON | OFF}

Enables or disables the verbose option for a channel. When verbose is set, ChanServ will send a notice to the channel's operators when certain commands are used on the channel.

Access[edit]

/msg ChanServ ACCESS #channel ADD nick level
/msg ChanServ ACCESS #channel DEL { nick | entry-num | list }
/msg ChanServ ACCESS #channel LIST { mask | list }
/msg ChanServ 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; See 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 this would list channel access access entries numbered 2 through 5 and 7 through 9.

/msg ChanServ ACCESS #channel LIST 2-5,7-9

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

VOP[edit]

/msg ChanServ VOP #channel ADD nick

The VOP ADD command adds the given nick to the access list using the channel's default level for auto voice (default level 3).

AOP[edit]

/msg ChanServ AOP #channel ADD nick

The AOP ADD command adds the given nick to the access list using the channel's default level for auto op (default level 5). This command is meant as a quick alias to ACCESS ADD.

SOP[edit]

/msg ChanServ SOP #channel ADD nick

The SOP ADD command adds the given nick to the access list using the channel's default level for AKICK add (default level 10). This command is meant as a quick alias to ACCESS ADD.

SENDPASS[edit]

/msg ChanServ SENDPASS #channel

E-mails the channel password to the founder of the channel, using the address they set on their nickname.