[irc/rqf/shadowircd.git] / extensions / README

$Id: README 1622 2006-06-04 03:01:05Z beu $

This directory contains extensions (modules) to charybdis ircd that
have been contributed by other people, or written by our development
team.  Unsupported extensions live under unsupported/.


Modules
-------

createauthonly.c - Only allow authenticated (identified) users to create
                   channels.

ip_cloaking.c  - Cloak (spoof) the host for users that have umode +h.

m_42.c         - The Answer to Life, the Universe, and Everything.
                 Syntax: 42

m_findforwards.c - Find channels that forward (+f) to a given channel.
                   Syntax: FINDFORWARDS <channel>

m_mkpasswd.c   - MKPASSWD - generate a DES or MD5 encryption of a password
                 Syntax:  MKPASSWD <plaintext> [MD5|DES]

m_ojoin.c      - OJOIN - Join a channel through any modes or limits with 
                         an optional status (@%+)
                 Syntax: OJOIN [status]<channel>

m_olist.c      - OLIST - Lists channels like LIST, but shows hidden
                         channels. Oper only of course.

m_opme.c       - OPME - Allows an admin to op themselves in an opless channel
                 Syntax: OPME <channel>

m_omode.c      - OMODE - Allows an admin to do all sorts of evil upon a
			 channel, sets modes with extreme prejudice

no_oper_invis.c - Disallow opers setting marking themselves as invisible
                  (+i) unless they have the hidden_oper flag.

example_module.c - An example module to be used for creating your own.
                   Syntax: TEST


Spy Modules
-----------

The following are the 'spy' parts, accessible via the +y usermode

spy_admin_notice.c   - Spy on clients doing ADMIN
spy_info_notice.c    - Spy on clients doing INFO
spy_links_notice.c   - Spy on clients doing LINKS
spy_motd_notice.c    - Spy on clients doing MOTD
spy_stats_notice.c   - Spy on clients doing all STATS
spy_stats_p_notice.c - Spy on clients doing STATS p only
spy_trace_notice.c   - Spy on clients doing TRACE/LTRACE
spy_whois_notice.c   - Spy on local clients who WHOIS you.
spy_whois_notice_global.c - Spy on remote clients who WHOIS you.

Note: if you have both spy_stats_notice.c and spy_stats_p_notice.c loaded
you will get two messages.

Snomask Modules
---------------

sno_farconnect.c  - Remote client connect/exit notices (snomask +F)
sno_globalkline.c - Global K/D/X-line activation notices
sno_globaloper.c  - Global oper-up notices
Commit	Line	Data
212380e3	1	$Id: README 1622 2006-06-04 03:01:05Z beu $
	2
	3	This directory contains extensions (modules) to charybdis ircd that
	4	have been contributed by other people, or written by our development
	5	team. Unsupported extensions live under unsupported/.
	6
	7
	8	Modules
	9	-------
	10
	11	createauthonly.c - Only allow authenticated (identified) users to create
	12	channels.
	13
	14	ip_cloaking.c - Cloak (spoof) the host for users that have umode +h.
	15
	16	m_42.c - The Answer to Life, the Universe, and Everything.
	17	Syntax: 42
	18
	19	m_findforwards.c - Find channels that forward (+f) to a given channel.
	20	Syntax: FINDFORWARDS <channel>
	21
	22	m_mkpasswd.c - MKPASSWD - generate a DES or MD5 encryption of a password
	23	Syntax: MKPASSWD <plaintext> [MD5\|DES]
	24
	25	m_ojoin.c - OJOIN - Join a channel through any modes or limits with
	26	an optional status (@%+)
	27	Syntax: OJOIN [status]<channel>
	28
	29	m_olist.c - OLIST - Lists channels like LIST, but shows hidden
	30	channels. Oper only of course.
	31
	32	m_opme.c - OPME - Allows an admin to op themselves in an opless channel
	33	Syntax: OPME <channel>
	34
	35	m_omode.c - OMODE - Allows an admin to do all sorts of evil upon a
	36	channel, sets modes with extreme prejudice
	37
	38	no_oper_invis.c - Disallow opers setting marking themselves as invisible
	39	(+i) unless they have the hidden_oper flag.
	40
	41	example_module.c - An example module to be used for creating your own.
	42	Syntax: TEST
	43
	44
	45	Spy Modules
	46	-----------
	47
	48	The following are the 'spy' parts, accessible via the +y usermode
	49
	50	spy_admin_notice.c - Spy on clients doing ADMIN
	51	spy_info_notice.c - Spy on clients doing INFO
	52	spy_links_notice.c - Spy on clients doing LINKS
	53	spy_motd_notice.c - Spy on clients doing MOTD
	54	spy_stats_notice.c - Spy on clients doing all STATS
	55	spy_stats_p_notice.c - Spy on clients doing STATS p only
	56	spy_trace_notice.c - Spy on clients doing TRACE/LTRACE
	57	spy_whois_notice.c - Spy on local clients who WHOIS you.
	58	spy_whois_notice_global.c - Spy on remote clients who WHOIS you.
	59
	60	Note: if you have both spy_stats_notice.c and spy_stats_p_notice.c loaded
	61	you will get two messages.
	62
	63	Snomask Modules
	64	---------------
65
66	sno_farconnect.c - Remote client connect/exit notices (snomask +F)
67	sno_globalkline.c - Global K/D/X-line activation notices
68	sno_globaloper.c - Global oper-up notices