ChanServ Commands

From Foonetic

Jump to: navigation, search

This article will discuss the different options that can be used in ChanServ and how to execute those options.

Contents

Registering a Channel

In order to REGISTER a channel the following conditions must be met first:

1. The channel needs to be unregistered;
2. Your nickname needs to be registered with Nickserv;
3. You need to be a channel operator in that channel. 

Once these conditions are met you can use the following syntax to register a channel:

/msg ChanServ REGISTER <channel>

Note that it is required to include the # in the channel name in commands sent to ChanServ, including REGISTER.

Drop a Channel

If you no longer want to own a channel you can use the DROP command to release it. You can use the following syntax:

/msg ChanServ DROP <channel>

Note: You need to be a channel founder to drop a channel

Channel Options

If you would like to set some various options such as a new channel password or an entry message then you can use the SET command. Use the following syntax:

/msg ChanServ SET <channel> <options> <parameters>

These are some of the available options that can be set:


Setting FOUNDER allows you to set the new founder of a channel. The nickname that will be the new founder has to be registered. You can do this by entering the following syntax:

/msg ChanServ SET <channel> FOUNDER <nickname>

The new founder has to execute the same command to confirm the transfer. If the new founder has not yet confirmed the transfer, you can cancel it by specifying your own nick as the new founder.

Note: This option hands over your channel to someone else, so use this command with caution.


You can use the following syntax to associate an email address with your channel:

/msg ChanServ SET <channel> EMAIL <address>

Setting a channel ENTRY MESSAGE allows ChanServ to message the person joining the channel via the /NOTICE command with the channel message. You can use the following syntax:

/msg ChanServ SET <channel> ENTRYMSG <message>

Setting TOPIC LOCK allows you to lock the topic. This means that it is a setting which can be used to have ChanServ retain a certain topic so that any changes to the topic result in ChanServ changing the topic back to the locked topic.

ChanServ will not allow the channel topic to be changed except via the ChanServ/Topic command.

You can use the following syntax:

/msg ChanServ SET <channel> TOPICLOCK <ON | OFF>

Turning Topic Lock off:

/msg ChanServ SET <channel> TOPICLOCK OFF

Example:

 Test changes topic to: This is what happens when topic lock is off

Turning Topic Lock on:

/msg ChanServ SET <channel> TOPICLOCK ON

Example:

 Test changes topic to: This is what happens when topic lock is on
 ChanServ changes topic to: This is what happens when topic lock is off (Test)

Setting mode lock allows you to define certain channel modes to be always on or off. You can use the following syntax:

/msg ChanServ SET <channel> MLOCK <mode>

Always Locked mode/s Syntax:

Example:

/msg ChanServ SET <channel> MLOCK +i         (Forces the channel to always be invite-only)
/msg ChanServ SET <channel> MLOCK +ip        (Forces the channel to always be invite-only and private)
/msg ChanServ SET <channel> MLOCK +k <pass>  (Forces the channel to require the key "Pass" to enter)

Always Unlock mode/s Syntax:

Example:

/msg ChanServ SET <channel> MLOCK -i         (Forces the channel to never be invite-only)
/msg ChanServ SET <channel> MLOCK -ip        (Forces the channel to never be invite-only and private) 

Combination Lock/Unlock mode/s Syntax:

Example:

/msg ChanServ SET <channel> MLOCK -i+p       (Forces the channel to never be invite-only and always private )
         

To remove all locked modes, use this command:

/msg ChanServ SET <channel> MLOCK +

There are a couple of different ways in which you can hide or secure your channel from the LIST command or from stopping certain users from joining.

You can use the following syntax to set the channel as PRIVATE, hiding it from the LIST command:

/msg ChanServ SET <channel> PRIVATE <ON | OFF>

The RESTRICT command allows only people who are on the access list to join the channel. You can use the following syntax to RESTRICT access to the channel:

/msg ChanServ SET <channel> RESTRICTED <ON | OFF>

Another option to secure your channel would be to use the SECURE command. When this command is set only people who have registered with NickServ or identified with NickServ can use the given privileges for that channel as controlled by the access list. You can use the following syntax:

/msg ChanServ SET <channel> SECURE <ON | OFF>

GUARD will make Chanserv join your channel. Chanserv leaves when the channel is empty so this does NOT preserve channel modes (like +k, +e, +b, +I lists). You would need to run your own bot to make sure modes stay on.

/msg ChanServ SET <channel> GUARD <ON | OFF>

If you would like to get rid of some of these options you can use the ChanServ UNSET command. You can use the following syntax:

/msg ChanServ UNSET <channel> <successor | URL | Email | ENTRYMSG>

Channel Information

The Channel Information command lists information about the registered channel, including its founder, time of registration, last time used, description, and mode lock, if any. The the owner of the channel is looking up channel information and they are identified, they could see all channel information. You could use the following syntax to retrieve channel information:

/msg ChanServ INFO <channel> <ALL>

Access

Users can have many different privileges for a given channel. These privileges can be given individually, but ChanServ also supports roles, which are pre-set groups of privileges.

Listing users with channel access

To list the current database of users/hostmasks and their respective access:

/msg ChanServ ACCESS <channel> list

To see a specific user or hostmask's access privileges in detail:

/msg ChanServ ACCESS <channel> info <user>

Adding a User to the Access list

To add a new user to the access list with a given access privilege:

/msg ChanServ ACCESS <channel> ADD <nickname | hostmask> <role>

Modifying a User's current Access level

To change a user's previously set access level:

/msg ChanServ ACCESS <channel> SET <nickname | hostmask> <new-role>

Deleting a User from the Access list

/msg ChanServ ACCESS <channel> DEL <nickname | hostmask>

If you would like more information on the ACCESS command, the following syntax could be used:

/msg ChanServ HELP ACCESS

Roles

There are 5 default roles defined: FOUNDER, SOP, AOP, HOP and VOP, in decreasing order of power.

You can retrieve a list of the current roles and associated privileges as follows:

/msg ChanServ ROLE <channel> list

If you want to give a user named Joe +v in channel #test so he may talk even when the channel is moderated (+m) you would use the following command:

/msg ChanServ ACCESS #test ADD Joe VOP

Now assume you have 100 users in your channel and they all have the VOP role (i.e. get auto-voiced by ChanServ on joining of the channel) and you want to give all these users operator rights you have 2 options:

1. Change all users' roles to AOP (assuming default roles)

2. Add op and autoop to the VOP role [Note: not recommended, you'll probably end up confusing yourself. But useful for other privileges like ability to change topic]

Add the extra privilege to a role as follows:

/msg ChanServ ROLE <channel> add <role> <flags>

Specific to our example:

/msg ChanServ ROLE <channel> add VOP +oO

If you would like more information on roles before using them and changing them, you could use the following syntax:

/msg ChanServ HELP ROLES

And for more info on flags

/msg ChanServ HELP FLAGS

Here is a list of the default ChanServ roles:

FOUNDER: acl-view, founder, autoop, protect, acl-change, halfop, invite, op, remove, set, topic, voice (+AFOafhiorstv)
SOP: acl-view, autoop, protect, acl-change, halfop, invite, op, remove, set, topic, voice (+AOafhiorstv)
AOP: acl-view, autoop, halfop, invite, op, remove, topic, voice (+AOhiortv)
HOP: acl-view, autohalfop, autovoice, halfop, topic, voice (+AHVhtv)
VOP: acl-view, autovoice (+AV)

And a list of flags:

+v - Enables use of the voice/devoice commands.
+V - Enables automatic voice.
+h - Enables use of the halfop/dehalfop commands.
+H - Enables automatic halfop.
+o - Enables use of the op/deop commands.
+O - Enables automatic op.
+a - Enables use of the protect/deprotect commands.
+q - Enables use of the owner/deowner commands.
+s - Enables use of the set command.
+i - Enables use of the invite and getkey commands.
+r - Enables use of the kick, kickban, ban and unban commands.
+R - Enables use of the recover and clear commands.
+f - Enables modification of channel access lists.
+t - Enables use of the topic and topicappend commands.
+A - Enables viewing of channel access lists.
+F - Grants full founder access.
+b - Enables automatic kickban. 

The special permission +* adds all permissions except +b and +F.

The special permission -* removes all permissions including +b and +F.

Misc. Channel Commands

Note: These commands have not been tested on new services and hence, syntax may not be strictly correct

Sending the INVITE command to ChanServ tells ChanServ to invite you to that channel, regardless if you were invited or not. The only requirement for this command is that it is limited to users with the SOP role or above for the channel. You can use the following syntax:

/msg ChanServ INVITE <channel>

The UNBAN command tells ChanServ to remove all bans preventing you from entering the channel. This too is limited to users with level 50 access or above in the given channel. You can use the following syntax:

/msg ChanServ UNBAN <channel>

The KICK command tells ChanServ to kick a user from a channel. Once this command is executed the message included in the kick tells you who kicked you and the reason, if any, why they kicked you. This too is limited to only level 50 access or above. Protected users +a (100 access level) cannot be kicked with this command, even by the channel founder. You can use the following syntax:

/msg ChanServ KICK <channel> <user> [Reason]

Sending the TOPIC command to ChanServ tells ChanServ to change a channel's topic. This is useful when Topic-Lock is on. You can use the following syntax:

/msg ChanServ TOPIC <channel> [Topic]

The CLEAR command, a very handy one, allows you to clear a couple of different stuff in a certain channel. It tells ChanServ to clear any of the following modes:

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.
INVITES - Clears all invite masks on the channel.
OPS - Removes channel-operator status (mode +o) from all users.
HALFOPS - Removes halfop status (mode +h) from all users.
VOICES - Removes "voice" status (mode +v) from all users.
USERS - Removes (kicks) all users from the channel.

Note: This command is only limited to those who have level 100 access in a channel or above. You can use the following syntax:

/msg ChanServ CLEAR <channel> <what>

The STATUS command allows you to return the access level of a certain nickname in a channel. This too is limited to those who have level 100 access in a channel or above. You can use the following syntax:

/msg ChanServ STATUS <channel> <user> <access-level>

The AKICK command tells ChanServ to ban a certain user then kick them from a channel. If the ban is removed and the person attempts to rejoin the channel they will once again be banned then kicked. The default masks are user@host or nick!user@host. This is limited to those who have level 100 access in a channel or above. You can use the following syntax:

/msg ChanServ AKICK <channel> ADD <mask> [Reason]

For additional information on the AKICK command type:

/msg ChanServ HELP AKICK

For additional information on ChanServ commands, use the following syntax:

/msg Chanserv HELP COMMANDS
Personal tools