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_classlist.c    --  This module will show the number of clients connected in
                     a specific class. Valid classes would be servers, users,
                     operators, or any custom one you defined in class {} 
                     blocks.

                     Syntax: CLASSLIST <class>

                     Example: CLASSLIST users


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_flags.c        --  This module adds csircd like support for changing
                     usermodes. If passed without any arguments, it will
                     show what flags are enabled and which are available.

                     Syntax: FLAGS [+|-FLAG]

                     Example: FLAGS +CALLERID


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_killhost.c     --  Similar to the OperServ command KILLHOST, allows you to
                     issue (mass) KILLs to a specific hostname or hostmask that is 
                     connected to the server.

                     Syntax: KILLHOST <hostmask> [reason]

                     Example: KILLHOST *@cloners.com clones


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


m_spoof.c        --  This module adds automated auth {} block configurations
                     on local and over-local levels. Check m_spoof.c for
                     more information and the help pages for SPOOF and
                     DELSPOOF.

                     Syntax: SPOOF <umask@hmask> <spoof> [flags [password]]
                             DELSPOOF <umask@hmask>

                     Example: SPOOF *@some.host.org i.hate.packets lkgf
                              DELSPOOF *@other.host.edu


m_webirc.c       --  Adds CGI:IRC/WebIRC support. A special auth{} block is
                     required in order to enable WebIRC support. For more
                     details check m_webirc.c


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.


Other Files ::
-----------------------------------------------

Other files that have been put into the contrib directory but do not have
a specific category are listed here with a brief description of what they
are and what they do.

challenge.irc    -- ircII script that works in conjunction with rsa_respond
                    so you can authenticate within your client.

ircd-hybrid.spec -- RPM specifications file that can be used to build an RPM of
                    ircd-hybrid.

ircd.init.in     -- rc-init style file used with the spec file to allow system
                    loading of ircd-hybrid.
Revision:	1282
Committed:	Thu Feb 2 21:33:28 2012 UTC (14 years, 5 months ago) by michael
Original Path:	*ircd-hybrid-8/contrib/README*
File size:	7024 byte(s)
Log Message:	- Update contrib/README
#	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_classlist.c -- This module will show the number of clients connected in
47			a specific class. Valid classes would be servers, users,
48			operators, or any custom one you defined in class {}
49			blocks.
50
51			Syntax: CLASSLIST <class>
52
53			Example: CLASSLIST users
54
55
56			m_clearchan.c -- Similar to the OperServ command CLEARCHAN, this module
57			will clear all users out of a channel, joins the person
58			who issued it, and locks the channel. It should be noted
59			that this command can be abused heavily.
60
61			Syntax: CLEARCHAN <channel>
62
63			Example: CLEARCHAN #warez
64
65
66			m_ctrace.c -- This module will perform a trace on a certain class. Valid
67			classes would be servers, users, operators or any custom
68			one you defined in class {} blocks.
69
70			Syntax: CTRACE <class>
71
72			Example: CTRACE users
73
74
75			m_flags.c -- This module adds csircd like support for changing
76			usermodes. If passed without any arguments, it will
77			show what flags are enabled and which are available.
78
79			Syntax: FLAGS [+\|-FLAG]
80
81			Example: FLAGS +CALLERID
82
83
84			m_force.c -- This module will force a user to either part or join a
85			channel with an optional status (@%+)
86
87			Syntax: FORCEJOIN <nickname> [status]<channel>
88			FORCEPART <nickname> <channel>
89
90			Example: FORCEJOIN nick @#chitchat
91			FORCEPART lamer #chitchat
92
93
94			m_killhost.c -- Similar to the OperServ command KILLHOST, allows you to
95			issue (mass) KILLs to a specific hostname or hostmask that is
96			connected to the server.
97
98			Syntax: KILLHOST <hostmask> [reason]
99
100			Example: KILLHOST *@cloners.com clones
101
102
103			m_ltrace.c -- This module will give a limited trace. This is similar to
104			TRACE except that it only reports current operators and servers.
105
106			Syntax: LTRACE [nick\|mask [server]]
107
108			Example: LTRACE god
109			LTRACE node.server.com
110
111
112			m_ojoin.c -- This module will add the ability to join any channel no
113			matter what modes or limits are set with an optional
114			status (@%+) It should be noted that this command can be
115			abused heavily.
116
117			Syntax: OJOIN [status]<channel>
118
119			Example: OJOIN @#private
120
121
122			m_operspy.c -- This module will allow operators with access to spy on
123			users. It should be noted the notion of this module
124			practically invalidates any form of privacy.
125
126			Syntax: OPERSPY <LIST/WHO/MODE/WHOIS/NAMES> <parameter>
127
128
129			m_opme.c -- This module will allow an IRC operator to op themselves in
130			an opless channel should the need arise.
131
132			Syntax: OPME <channel>
133			Example: OPME #orphanchan
134
135
136			m_spoof.c -- This module adds automated auth {} block configurations
137			on local and over-local levels. Check m_spoof.c for
138			more information and the help pages for SPOOF and
139			DELSPOOF.
140
141			Syntax: SPOOF <umask@hmask> <spoof> [flags [password]]
142			DELSPOOF <umask@hmask>
143
144			Example: SPOOF *@some.host.org i.hate.packets lkgf
145			DELSPOOF *@other.host.edu
146
147
148	michael	1282	m_webirc.c -- Adds CGI:IRC/WebIRC support. A special auth{} block is
149			required in order to enable WebIRC support. For more
150			details check m_webirc.c
151
152
153	adx	30	example_module.c -- This is an example module template to help users create
154			their own modules.
155
156
157			Help Files ::
158			-----------------------------------------------
159
160			Each contrib module listed here has an accompanying help page or set of
161			help pages. They will be installed when you issue 'make install' inside
162			the contrib directory. To view them do /QUOTE HELP COMMAND.
163
164
165			Other Files ::
166			-----------------------------------------------
167
168			Other files that have been put into the contrib directory but do not have
169			a specific category are listed here with a brief description of what they
170			are and what they do.
171
172	michael	1282	challenge.irc -- ircII script that works in conjunction with rsa_respond
173	adx	30	so you can authenticate within your client.
174
175			ircd-hybrid.spec -- RPM specifications file that can be used to build an RPM of
176			ircd-hybrid.
177
178			ircd.init.in -- rc-init style file used with the spec file to allow system
179			loading of ircd-hybrid.