$Id: README,v 1.1.1.1 2007-06-24 19:03:48 jailbird Exp $

This directory contains modules and patches that have been contributed
by other people, or aren't suitable for including into the 
ircd-ratbox tree.  The coding team do not officially support the contrib/ 
modules, or guarantee any of them will actually work.


Modules
-------

m_clearchan.c  - CLEARCHAN - clears all users out of a channel and joins person
                             issuing command
                 Syntax: CLEARCHAN <channel> 

m_flags.c      - FLAGS - csircd like support of changing usermodes
                 Syntax:  FLAGS :+OWALLOPS -SWALLOPS

m_force.c      - FORCE - forces a user to either part or join a channel with
                         an optional status (@%+)
                 Syntax: FORCEJOIN <nick> [status]<channel>
                         FORCEPART <nick> <channel>

m_jupe.c       - JUPE - Server juping command
                 Syntax:  JUPE juped.server.name :Reason

m_ltrace.c     - LTRACE - Limited trace.  Similar to TRACE except only reports
                          current opers and servers.
                 Syntax: LTRACE [nick|mask [server]]

m_map.c        - MAP - Display the server routing graph in a visually pleasing
                       format
                 Syntax:  MAP
		 
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

m_owho.c       - OWHO -  Just like WHO but doesn't hide things from opers

m_owhois.c     - OWHOIS - Allows an oper to do a whois on any user and see
		          all channels they are in. The syntax is the same
			  as WHOIS

m_tburst.c     - TBURST - module that will make servers send channel topics
                          to each other after a netsplit/restart.

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.

