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

From AnopeWiki
Jump to: navigation, search
(Created page with "{{Language|2.0/Modules/cs_list}} {{Syntax|cs_list|ChanServ|Anope}} == <div class="moduleheader">Description</div> == Lists all registered channels matching the given pattern....")
(No difference)

Revision as of 17:18, 6 May 2014

Language

English

Service ChanServ
Module cs_list
Author Anope

Description

Lists all registered channels matching the given pattern. Channels with the PRIVATE option set will only be displayed to Services Operators with the proper access. Channels with the NOEXPIRE option set will have a ! prefixed to the channel for Services Operators to see.

Note that a preceding '#' specifies a range, channel names are to be written without '#'.

If the SUSPENDED or NOEXPIRE options are given, only channels which, respectively, are SUSPENDED or have the NOEXPIRE flag set will be displayed. If multiple options are given, all channels matching at least one option will be displayed.

Note that these options are limited to Services Operators.

Commands

list pattern [SUSPENDED] [NOEXPIRE]

Examples

/msg ChanServ LIST *anope*

/,sg ChanServ LIST * NOEXPIRE

/msg ChanServ LIST #51-100


Default Configuration

/*
 * cs_list
 *
 * Provides the commands:
 *   chanserv/list - Used for retrieving and searching the registered channel list.
 *   chanserv/set/private - Used for setting whether channels should show up in chanserv/list.
 */
module
{
        name = "cs_list"
 
        /*
         * The maximum number of channels to be returned for a ChanServ LIST command.
         */
        listmax = 50
}
command { service = "ChanServ"; name = "LIST"; command = "chanserv/list"; }
command { service = "ChanServ"; name = "SET PRIVATE"; command = "chanserv/set/private"; }