$Id: README,v 1.3 2002/09/16 04:57:38 fishwaldo Exp $

------------------------------------------------------------------------------

NOTICE: Currently, most of these modules *HAVE* not been tested with
NeoIRCd. I will port them later. Use at your own risk

------------------------------------------------------------------------------



This directory contains modules and patches that have been contributed
by other people, or aren't suitable for including into the 
hybrid 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> [vchanid]

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_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_opme.c       - OPME - Allows an admin to op themselves in an opless channel
                 Syntax: OPME <channel>

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.

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


VMS Files
---------

vms_*.c        - Misc files needed for VMS support.


Patches
-------

The following are the patches contained in contrib.  A short description
of the patch is contained here, along with any notes.

To apply a patch, first change to the ircd-hybrid-7 root directory, 
the directory one level above contrib/.  If you have already compiled 
the ircd, run 'make clean'.  Then for example to patch 
remote-unkline.diff type:
    patch -p0 < contrib/remote-unkline.diff

You must then run 'make' and 'make install' again, and restart your ircd.
The following patches are included:

lmh.diff 	- This patch adds remote unkline support, temp dline support,
                  better temp klines, /quote xline and global user@host
		  limits.

		  Please read README.LMH for more information as this patch
		  requires different methods to be applied and adds multiple
		  config options.

disable_identd.diff - This patch adds support for disabling identd queries.
                      See README.disable_identd for more information.