ircd-hybrid-7.3/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_capture.c      --  This module will essentially capture a client (making it
                     impossible for a user to send commands to the server).

                     Syntax: CAPTURE <nickname/mask>
                             UNCAPTURE <nickname/mask>

                     Example: (UN)CAPTURE scriptkiddie
                              (UN)CAPTURE *!*@abuser.host


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_jupe.c         --  Similar to the OperServ command JUPE, this module adds the
                     ability to jupiter (ban) a server from your network. It can
                     be extremely dangerous if not used correctly or without 
                     proper information. So use it with EXTREME care.

                     Syntax: JUPE <server> :[reason]

                     Example: JUPE node.server.net :get lost


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_services.c     --  This module will add services hook support to hybrid. It
                     will add secure messaging aliases to services like such
                     as NickServ, OperServ and so on. It also adds SVSNICK
                     support to allow NickServ to change nicknames should
                     a user fail to identify or if an operator chooses
                     to want to change a user's nickname if it is offensive.
                     To use the aliases simply do ServiceName without MSG,
                     e.g. /NickServ IDENTIFY instead of /MSG NickServ IDENTIFY.

                     Syntax: SVSNICK <nickname> <newnick>

                     Example: SVSNICK fsck lamer


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:	1281
Committed:	Thu Feb 2 21:33:23 2012 UTC (14 years, 6 months ago) by michael
File size:	8520 byte(s)
Log Message:	- Update contrib/README
#	Content
1	$Id$
2	-----------------------------------------------
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_capture.c -- This module will essentially capture a client (making it
35	impossible for a user to send commands to the server).
36
37	Syntax: CAPTURE <nickname/mask>
38	UNCAPTURE <nickname/mask>
39
40	Example: (UN)CAPTURE scriptkiddie
41	(UN)CAPTURE !@abuser.host
42
43
44	m_change.c -- This module will allow IRC operators to alter the ident,
45	hostname or gecos (realname) fields of a given user.
46
47	Syntax: CHGIDENT <nickname> <newident>
48	CHGHOST <nickname> <newhostname>
49	CHGNAME <nickname> <newname>
50
51	Example: CHGIDENT lart llama
52	CHGHOST lart i.hate.packets
53	CHGNAME lart oorgle
54
55
56	m_classlist.c -- This module will show the number of clients connected in
57	a specific class. Valid classes would be servers, users,
58	operators, or any custom one you defined in class {}
59	blocks.
60
61	Syntax: CLASSLIST <class>
62
63	Example: CLASSLIST users
64
65
66	m_clearchan.c -- Similar to the OperServ command CLEARCHAN, this module
67	will clear all users out of a channel, joins the person
68	who issued it, and locks the channel. It should be noted
69	that this command can be abused heavily.
70
71	Syntax: CLEARCHAN <channel>
72
73	Example: CLEARCHAN #warez
74
75
76	m_ctrace.c -- This module will perform a trace on a certain class. Valid
77	classes would be servers, users, operators or any custom
78	one you defined in class {} blocks.
79
80	Syntax: CTRACE <class>
81
82	Example: CTRACE users
83
84
85	m_flags.c -- This module adds csircd like support for changing
86	usermodes. If passed without any arguments, it will
87	show what flags are enabled and which are available.
88
89	Syntax: FLAGS [+\|-FLAG]
90
91	Example: FLAGS +CALLERID
92
93
94	m_force.c -- This module will force a user to either part or join a
95	channel with an optional status (@%+)
96
97	Syntax: FORCEJOIN <nickname> [status]<channel>
98	FORCEPART <nickname> <channel>
99
100	Example: FORCEJOIN nick @#chitchat
101	FORCEPART lamer #chitchat
102
103
104	m_jupe.c -- Similar to the OperServ command JUPE, this module adds the
105	ability to jupiter (ban) a server from your network. It can
106	be extremely dangerous if not used correctly or without
107	proper information. So use it with EXTREME care.
108
109	Syntax: JUPE <server> :[reason]
110
111	Example: JUPE node.server.net :get lost
112
113
114	m_killhost.c -- Similar to the OperServ command KILLHOST, allows you to
115	issue (mass) KILLs to a specific hostname or hostmask that is
116	connected to the server.
117
118	Syntax: KILLHOST <hostmask> [reason]
119
120	Example: KILLHOST *@cloners.com clones
121
122
123	m_ltrace.c -- This module will give a limited trace. This is similar to
124	TRACE except that it only reports current operators and servers.
125
126	Syntax: LTRACE [nick\|mask [server]]
127
128	Example: LTRACE god
129	LTRACE node.server.com
130
131
132	m_ojoin.c -- This module will add the ability to join any channel no
133	matter what modes or limits are set with an optional
134	status (@%+) It should be noted that this command can be
135	abused heavily.
136
137	Syntax: OJOIN [status]<channel>
138
139	Example: OJOIN @#private
140
141
142	m_operspy.c -- This module will allow operators with access to spy on
143	users. It should be noted the notion of this module
144	practically invalidates any form of privacy.
145
146	Syntax: OPERSPY <LIST/WHO/MODE/WHOIS/NAMES> <parameter>
147
148
149	m_opme.c -- This module will allow an IRC operator to op themselves in
150	an opless channel should the need arise.
151
152	Syntax: OPME <channel>
153	Example: OPME #orphanchan
154
155
156	m_services.c -- This module will add services hook support to hybrid. It
157	will add secure messaging aliases to services like such
158	as NickServ, OperServ and so on. It also adds SVSNICK
159	support to allow NickServ to change nicknames should
160	a user fail to identify or if an operator chooses
161	to want to change a user's nickname if it is offensive.
162	To use the aliases simply do ServiceName without MSG,
163	e.g. /NickServ IDENTIFY instead of /MSG NickServ IDENTIFY.
164
165	Syntax: SVSNICK <nickname> <newnick>
166
167	Example: SVSNICK fsck lamer
168
169
170	m_spoof.c -- This module adds automated auth {} block configurations
171	on local and over-local levels. Check m_spoof.c for
172	more information and the help pages for SPOOF and
173	DELSPOOF.
174
175	Syntax: SPOOF <umask@hmask> <spoof> [flags [password]]
176	DELSPOOF <umask@hmask>
177
178	Example: SPOOF *@some.host.org i.hate.packets lkgf
179	DELSPOOF *@other.host.edu
180
181
182	m_webirc.c -- Adds CGI:IRC/WebIRC support. A special auth{} block is
183	required in order to enable WebIRC support. For more
184	details check m_webirc.c
185
186
187	example_module.c -- This is an example module template to help users create
188	their own modules.
189
190
191	Help Files ::
192	-----------------------------------------------
193
194	Each contrib module listed here has an accompanying help page or set of
195	help pages. They will be installed when you issue 'make install' inside
196	the contrib directory. To view them do /QUOTE HELP COMMAND.
197
198
199	Other Files ::
200	-----------------------------------------------
201
202	Other files that have been put into the contrib directory but do not have
203	a specific category are listed here with a brief description of what they
204	are and what they do.
205
206	challenge.irc -- ircII script that works in conjunction with rsa_respond
207	so you can authenticate within your client.
208
209	ircd-hybrid.spec -- RPM specifications file that can be used to build an RPM of
210	ircd-hybrid.
211
212	ircd.init.in -- rc-init style file used with the spec file to allow system
213	loading of ircd-hybrid.