Difference between revisions of "2.0/Modules/cs akick"

Latest revision as of 16:12, 6 May 2014

Description

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.

Commands

AKICK channel ADD {nick | mask} [reason]

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 "User has been banned from the channel". When akicking a registered nick the NickServ account will be added to the akick list instead of the mask. All users within that nickgroup will then be akicked.

AKICK channel DEL {nick | mask | entry-num | list}

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.

AKICK channel LIST [mask | entry-num | list]

The AKICK LIST command displays the AutoKick list, or optionally only those AutoKick entries which match the given mask.

AKICK channel VIEW [mask | entry-num | list]

The AKICK VIEW command is a more verbose version of the AKICK LIST command.

AKICK channel ENFORCE

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

AKICK channel CLEAR

The AKICK CLEAR command clears all entries of the akick list.

Examples

/msg ChanServ AKICK #myChannel ADD *Fred@*.example.com Idiot

/msg ChanServ AKICK #myChannel DEL *Fred@*.example.com

/msg ChanServ AKICK #myChannel LIST 1-12

/msg ChanServ AKICK #myChannel ENFORCE

/msg ChanServ AKICK #myChannel CLEAR

Default Configuration

/*
 * cs_akick
 *
 * Provides the command chanserv/akick.
 *
 * Used for preventing users from joining channels.
 */
module
{
        name = "cs_akick"
 
        /*
         * The maximum number of entries on a channel's autokick list.
         */
        autokickmax = 32
 
        /*
         * The default reason for an autokick if none is given.
         */
        autokickreason = "User has been banned from the channel"
}
command { service = "ChanServ"; name = "AKICK"; command = "chanserv/akick"; group = "chanserv/management"; }