8.0.x/contrib/README

$Id$
-----------------------------------------------

ircd-hybrid contributive add-ons ::

This directory contains contributive modules, patches and other add-ons 
that have been created by other people, or are not suitable to be included
into the main ircd-hybrid tree for various reasons. The coding team does
not officially support modules, patches and add-ons nor do they guarantee
that any of them will work to their intended capacity.

It is to be noted WITH feeling, that not all of these modules, patches
or add-ons have been thoroughly tested, only that they've been tested
enough to see if they compile or work. This is one of the main driving
reasons why many of these are not in the main ircd-hybrid tree. At least
one or two of the modules in contrib have been known to core servers when
used. Heed this warning!

To reiterate, ONE OR MORE OF THESE MAY AND PROBABLY WILL CORE YOUR SERVER.
USE AT YOUR OWN RISK. Reading this dicticates that you agree to the stated
fact.

Modules ::
-----------------------------------------------
ip_cloaking.c    --  This module enables IP/hostname cloaking support for
                     ircd-hybrid. It adds a CRC32 encrypted based cloaking
                     known to be used by other daemons such as Unreal IRCd
                     but with some modifications and different hashing
                     methods. Please read README.cloaking before you compile
                     and load this module, it contains VERY important
                     information.


m_change.c       --  This module will allow IRC operators to alter the ident,
                     hostname or gecos (realname) fields of a given user.

                     Syntax: CHGIDENT <nickname> <newident>
                             CHGHOST <nickname> <newhostname>
                             CHGNAME <nickname> <newname>

                     Example: CHGIDENT lart llama
                              CHGHOST lart i.hate.packets
                              CHGNAME lart oorgle


m_clearchan.c    --  Similar to the OperServ command CLEARCHAN, this module
                     will clear all users out of a channel, joins the person
                     who issued it, and locks the channel. It should be noted
                     that this command can be abused heavily.

                     Syntax: CLEARCHAN <channel>

                     Example: CLEARCHAN #warez


m_ctrace.c       --  This module will perform a trace on a certain class. Valid
                     classes would be servers, users, operators or any custom
                     one you defined in class {} blocks.

                     Syntax: CTRACE <class>

                     Example: CTRACE users


m_force.c        --  This module will force a user to either part or join a
                     channel with an optional status (@%+)

                     Syntax: FORCEJOIN <nickname> [status]<channel>
                             FORCEPART <nickname> <channel>

                     Example: FORCEJOIN nick @#chitchat
                              FORCEPART lamer #chitchat


m_ltrace.c       --  This module will give a limited trace. This is similar to
                     TRACE except that it only reports current operators and servers.

                     Syntax: LTRACE [nick|mask [server]]

                     Example: LTRACE god
                              LTRACE node.server.com


m_ojoin.c        --  This module will add the ability to join any channel no
                     matter what modes or limits are set with an optional 
                     status (@%+) It should be noted that this command can be
                     abused heavily.

                     Syntax: OJOIN [status]<channel>

                     Example: OJOIN @#private


m_operspy.c      --  This module will allow operators with access to spy on
                     users. It should be noted the notion of this module
                     practically invalidates any form of privacy.

                     Syntax: OPERSPY <LIST/WHO/MODE/WHOIS/NAMES> <parameter>


m_opme.c         --  This module will allow an IRC operator to op themselves in
                     an opless channel should the need arise.

                     Syntax: OPME <channel>
                     Example: OPME #orphanchan


example_module.c --  This is an example module template to help users create
                     their own modules.


Help Files ::
-----------------------------------------------

Each contrib module listed here has an accompanying help page or set of
help pages. They will be installed when you issue 'make install' inside
the contrib directory. To view them do /QUOTE HELP COMMAND.
Revision:	1773
Committed:	Thu Jan 24 12:07:05 2013 UTC (13 years, 6 months ago) by michael
File size:	4700 byte(s)
Log Message:	- move m_webirc.c from contrib/ to modules/ - Update NEWS
#	User	Rev	Content
1	knight	31	$Id$
2	adx	30	-----------------------------------------------
3
4			ircd-hybrid contributive add-ons ::
5
6			This directory contains contributive modules, patches and other add-ons
7			that have been created by other people, or are not suitable to be included
8			into the main ircd-hybrid tree for various reasons. The coding team does
9			not officially support modules, patches and add-ons nor do they guarantee
10			that any of them will work to their intended capacity.
11
12			It is to be noted WITH feeling, that not all of these modules, patches
13			or add-ons have been thoroughly tested, only that they've been tested
14			enough to see if they compile or work. This is one of the main driving
15			reasons why many of these are not in the main ircd-hybrid tree. At least
16			one or two of the modules in contrib have been known to core servers when
17			used. Heed this warning!
18
19			To reiterate, ONE OR MORE OF THESE MAY AND PROBABLY WILL CORE YOUR SERVER.
20			USE AT YOUR OWN RISK. Reading this dicticates that you agree to the stated
21			fact.
22
23			Modules ::
24			-----------------------------------------------
25			ip_cloaking.c -- This module enables IP/hostname cloaking support for
26			ircd-hybrid. It adds a CRC32 encrypted based cloaking
27			known to be used by other daemons such as Unreal IRCd
28			but with some modifications and different hashing
29			methods. Please read README.cloaking before you compile
30			and load this module, it contains VERY important
31			information.
32
33
34			m_change.c -- This module will allow IRC operators to alter the ident,
35			hostname or gecos (realname) fields of a given user.
36
37			Syntax: CHGIDENT <nickname> <newident>
38			CHGHOST <nickname> <newhostname>
39			CHGNAME <nickname> <newname>
40
41			Example: CHGIDENT lart llama
42			CHGHOST lart i.hate.packets
43			CHGNAME lart oorgle
44
45
46			m_clearchan.c -- Similar to the OperServ command CLEARCHAN, this module
47			will clear all users out of a channel, joins the person
48			who issued it, and locks the channel. It should be noted
49			that this command can be abused heavily.
50
51			Syntax: CLEARCHAN <channel>
52
53			Example: CLEARCHAN #warez
54
55
56			m_ctrace.c -- This module will perform a trace on a certain class. Valid
57			classes would be servers, users, operators or any custom
58			one you defined in class {} blocks.
59
60			Syntax: CTRACE <class>
61
62			Example: CTRACE users
63
64
65			m_force.c -- This module will force a user to either part or join a
66			channel with an optional status (@%+)
67
68			Syntax: FORCEJOIN <nickname> [status]<channel>
69			FORCEPART <nickname> <channel>
70
71			Example: FORCEJOIN nick @#chitchat
72			FORCEPART lamer #chitchat
73
74
75			m_ltrace.c -- This module will give a limited trace. This is similar to
76			TRACE except that it only reports current operators and servers.
77
78			Syntax: LTRACE [nick\|mask [server]]
79
80			Example: LTRACE god
81			LTRACE node.server.com
82
83
84			m_ojoin.c -- This module will add the ability to join any channel no
85			matter what modes or limits are set with an optional
86			status (@%+) It should be noted that this command can be
87			abused heavily.
88
89			Syntax: OJOIN [status]<channel>
90
91			Example: OJOIN @#private
92
93
94			m_operspy.c -- This module will allow operators with access to spy on
95			users. It should be noted the notion of this module
96			practically invalidates any form of privacy.
97
98			Syntax: OPERSPY <LIST/WHO/MODE/WHOIS/NAMES> <parameter>
99
100
101			m_opme.c -- This module will allow an IRC operator to op themselves in
102			an opless channel should the need arise.
103
104			Syntax: OPME <channel>
105			Example: OPME #orphanchan
106
107
108			example_module.c -- This is an example module template to help users create
109			their own modules.
110
111
112			Help Files ::
113			-----------------------------------------------
114
115			Each contrib module listed here has an accompanying help page or set of
116			help pages. They will be installed when you issue 'make install' inside
117			the contrib directory. To view them do /QUOTE HELP COMMAND.