[ViewVC] Annotation of: svn/ircd-hybrid/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.
Heed this warning!

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_mkpasswd.c     --  This module will generate a DES or MD5 encrypted password
                     similar to the console version bundled with hybrid.

                     Syntax: MKPASSWD <plaintext> [MD5|DES]


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


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


Spy Modules ::
-----------------------------------------------

The following modules are the 'spy' parts and are accessible via the +y
user mode.

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 at the same time you will get two messages. So only load one
or the other to avoid duplicate NOTICE events.

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.

challange.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.

setup-win32.h    -- This header file is a win32 compatible include/setup.h
                    suitable for building ircd-hybrid on Windows with MSVC/BCC.

win32build.bat   -- Automated BATCH script designed to aid in the building of
                    ircd-hybrid on Windows with MSVC/BCC
Revision:	43
Committed:	Mon Oct 3 00:12:29 2005 UTC (20 years, 10 months ago) by adx
File size:	9348 byte(s)
Log Message:	- well I don't think "one or two of these modules will core your ircd". too much bullshit.
#	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	adx	43	reasons why many of these are not in the main ircd-hybrid tree.
16			Heed this warning!
17	adx	30
18			Modules ::
19			-----------------------------------------------
20			ip_cloaking.c -- This module enables IP/hostname cloaking support for
21			ircd-hybrid. It adds a CRC32 encrypted based cloaking
22			known to be used by other daemons such as Unreal IRCd
23			but with some modifications and different hashing
24			methods. Please read README.cloaking before you compile
25			and load this module, it contains VERY important
26			information.
27
28
29			m_capture.c -- This module will essentially capture a client (making it
30			impossible for a user to send commands to the server).
31
32			Syntax: CAPTURE <nickname/mask>
33			UNCAPTURE <nickname/mask>
34
35			Example: (UN)CAPTURE scriptkiddie
36			(UN)CAPTURE !@abuser.host
37
38
39			m_change.c -- This module will allow IRC operators to alter the ident,
40			hostname or gecos (realname) fields of a given user.
41
42			Syntax: CHGIDENT <nickname> <newident>
43			CHGHOST <nickname> <newhostname>
44			CHGNAME <nickname> <newname>
45
46			Example: CHGIDENT lart llama
47			CHGHOST lart i.hate.packets
48			CHGNAME lart oorgle
49
50
51			m_classlist.c -- This module will show the number of clients connected in
52			a specific class. Valid classes would be servers, users,
53			operators, or any custom one you defined in class {}
54			blocks.
55
56			Syntax: CLASSLIST <class>
57
58			Example: CLASSLIST users
59
60
61			m_clearchan.c -- Similar to the OperServ command CLEARCHAN, this module
62			will clear all users out of a channel, joins the person
63			who issued it, and locks the channel. It should be noted
64			that this command can be abused heavily.
65
66			Syntax: CLEARCHAN <channel>
67
68			Example: CLEARCHAN #warez
69
70
71			m_ctrace.c -- This module will perform a trace on a certain class. Valid
72			classes would be servers, users, operators or any custom
73			one you defined in class {} blocks.
74
75			Syntax: CTRACE <class>
76
77			Example: CTRACE users
78
79
80			m_flags.c -- This module adds csircd like support for changing
81			usermodes. If passed without any arguments, it will
82			show what flags are enabled and which are available.
83
84			Syntax: FLAGS [+\|-FLAG]
85
86			Example: FLAGS +CALLERID
87
88
89			m_force.c -- This module will force a user to either part or join a
90			channel with an optional status (@%+)
91
92			Syntax: FORCEJOIN <nickname> [status]<channel>
93			FORCEPART <nickname> <channel>
94
95			Example: FORCEJOIN nick @#chitchat
96			FORCEPART lamer #chitchat
97
98
99			m_jupe.c -- Similar to the OperServ command JUPE, this module adds the
100			ability to jupiter (ban) a server from your network. It can
101			be extremely dangerous if not used correctly or without
102			proper information. So use it with EXTREME care.
103
104			Syntax: JUPE <server> :[reason]
105
106			Example: JUPE node.server.net :get lost
107
108
109			m_killhost.c -- Similar to the OperServ command KILLHOST, allows you to
110			issue (mass) KILLs to a specific hostname or hostmask that is
111			connected to the server.
112
113			Syntax: KILLHOST <hostmask> [reason]
114
115			Example: KILLHOST *@cloners.com clones
116
117
118			m_ltrace.c -- This module will give a limited trace. This is similar to
119			TRACE except that it only reports current operators and servers.
120
121			Syntax: LTRACE [nick\|mask [server]]
122
123			Example: LTRACE god
124			LTRACE node.server.com
125
126
127			m_mkpasswd.c -- This module will generate a DES or MD5 encrypted password
128			similar to the console version bundled with hybrid.
129
130			Syntax: MKPASSWD <plaintext> [MD5\|DES]
131
132
133			m_ojoin.c -- This module will add the ability to join any channel no
134			matter what modes or limits are set with an optional
135			status (@%+) It should be noted that this command can be
136			abused heavily.
137
138			Syntax: OJOIN [status]<channel>
139
140			Example: OJOIN @#private
141
142
143			m_operspy.c -- This module will allow operators with access to spy on
144			users. It should be noted the notion of this module
145			practically invalidates any form of privacy.
146
147			Syntax: OPERSPY <LIST/WHO/MODE/WHOIS/NAMES> <parameter>
148
149
150			m_opme.c -- This module will allow an IRC operator to op themselves in
151			an opless channel should the need arise.
152
153			Syntax: OPME <channel>
154			Example: OPME #orphanchan
155
156
157			m_services.c -- This module will add services hook support to hybrid. It
158			will add secure messaging aliases to services like such
159			as NickServ, OperServ and so on. It also adds SVSNICK
160			support to allow NickServ to change nicknames should
161			a user fail to identify or if an operator chooses
162			to want to change a user's nickname if it is offensive.
163			To use the aliases simply do ServiceName without MSG,
164			e.g. /NickServ IDENTIFY instead of /MSG NickServ IDENTIFY.
165
166			Syntax: SVSNICK <nickname> <newnick>
167
168			Example: SVSNICK fsck lamer
169
170
171			m_spoof.c -- This module adds automated auth {} block configurations
172			on local and over-local levels. Check m_spoof.c for
173			more information and the help pages for SPOOF and
174			DELSPOOF.
175
176			Syntax: SPOOF <umask@hmask> <spoof> [flags [password]]
177			DELSPOOF <umask@hmask>
178
179			Example: SPOOF *@some.host.org i.hate.packets lkgf
180			DELSPOOF *@other.host.edu
181
182
183			example_module.c -- This is an example module template to help users create
184			their own modules.
185
186
187			Spy Modules ::
188			-----------------------------------------------
189
190			The following modules are the 'spy' parts and are accessible via the +y
191			user mode.
192
193			spy_admin_notice.c -- Spy on clients doing ADMIN
194			spy_info_notice.c -- Spy on clients doing INFO
195			spy_links_notice.c -- Spy on clients doing LINKS
196			spy_motd_notice.c -- Spy on clients doing MOTD
197			spy_stats_notice.c -- Spy on clients doing all STATS
198			spy_stats_p_notice.c -- Spy on clients doing STATS p only
199			spy_trace_notice.c -- Spy on clients doing TRACE/LTRACE
200			spy_whois_notice.c -- Spy on local clients who WHOIS you.
201
202			Note: If you have both spy_stats_notice.c and spy_stats_p_notice.c
203			loaded at the same time you will get two messages. So only load one
204			or the other to avoid duplicate NOTICE events.
205
206			Help Files ::
207			-----------------------------------------------
208
209			Each contrib module listed here has an accompanying help page or set of
210			help pages. They will be installed when you issue 'make install' inside
211			the contrib directory. To view them do /QUOTE HELP COMMAND.
212
213
214			Other Files ::
215			-----------------------------------------------
216
217			Other files that have been put into the contrib directory but do not have
218			a specific category are listed here with a brief description of what they
219			are and what they do.
220
221			challange.irc -- ircII script that works in conjunction with rsa_respond
222			so you can authenticate within your client.
223
224			ircd-hybrid.spec -- RPM specifications file that can be used to build an RPM of
225			ircd-hybrid.
226
227			ircd.init.in -- rc-init style file used with the spec file to allow system
228			loading of ircd-hybrid.
229
230			setup-win32.h -- This header file is a win32 compatible include/setup.h
231			suitable for building ircd-hybrid on Windows with MSVC/BCC.
232
233			win32build.bat -- Automated BATCH script designed to aid in the building of
234			ircd-hybrid on Windows with MSVC/BCC