1 # Sample configuration file for m_helpop.so
2 # You can either copy this into your conf folder and set up the module to use it,
3 # or you can customize the responses for your network and/or add more.
5 # The way the new helpop system works is simple. You use one or more helpop tags.
6 # <helpop key="moo" value="something here">.
7 # key is what the user is looking for (i.e. /helpop moo), and value is what they get back
8 # (note that it can span multiple lines!).
12 <alias text="HELP" replace="HELPOP $2-">
14 <helpop key="start" value="InspIRCd Help System
16 This system provides help for commands and modes.
17 Specify your question or a command name as the
18 parameter for this command.
20 /HELPOP CUSER - To see a list of user commands
21 /HELPOP COPER - To see a list of oper commands
22 /HELPOP UMODES - To see a list of user modes
23 /HELPOP CHMODES - To see a list of channel modes
24 /HELPOP SNOMASKS - To see a list of oper snotice masks
25 /HELPOP EXTBANS - To see a list of extended bans">
27 <helpop key="nohelp" value="There is no help for the topic
28 you searched for. Please try again.">
30 <helpop key="cuser" value="User Commands
33 PRIVMSG NOTICE NICK JOIN PART
34 CYCLE KNOCK MODE DEVOICE TOPIC
35 KICK FPART REMOVE TBAN INVITE
36 UNINVITE AWAY DCCALLOW SILENCE ACCEPT
37 MKPASSWD VHOST TITLE SETNAME
39 WHOIS WHOWAS ISON USERHOST WATCH
41 ADMIN MAP LINKS LUSERS TIME
42 STATS VERSION INFO MODULES COMMANDS
45 USER PASS PING PONG QUIT
49 <helpop key="coper" value="Oper Commands
52 OPERMOTD CHECK CLONES USERIP TLINE
53 ALLTIME WALLOPS GLOBOPS
55 SETHOST SETIDENT CHGHOST CHGIDENT CHGNAME
58 SANICK NICKLOCK NICKUNLOCK
60 SAJOIN SAPART SAMODE SATOPIC SAKICK
62 KILL SAQUIT GLINE ZLINE QLINE
63 KLINE RLINE ELINE CBAN SHUN
66 CONNECT SQUIT RCONNECT RSQUIT
69 CLEARCACHE LOADMODULE UNLOADMODULE
70 RELOADMODULE GLOADMODULE GUNLOADMODULE
71 GRELOADMODULE RELOAD CLOSE
72 LOCKSERV UNLOCKSERV JUMPSERVER">
74 <helpop key="umodes" value="User Modes
77 c Blocks private messages and notices from users who do
78 not share a common channel with you (requires
80 d Deaf mode. User will not receive any messages or notices
81 from channels they are in (requires deaf module).
82 g In combination with /allow, provides for server side
83 ignore (requires callerid module).
84 h Marks as 'available for help' in WHOIS (IRCop only,
85 requires helpop module).
86 i Makes invisible to /WHO if the user using /WHO is not in
88 k Prevents the user from being kicked from channels, or
89 having op modes removed from them (services only,
90 requires servprotect module).
91 o Marks as a IRC operator.
92 s [mask] Receives server notices specified by [mask]
94 r Marks as a having a registered nickname
95 (requires services account module).
96 w Receives wallops messages.
97 x Gives a cloaked hostname (requires cloaking module).
98 B Marks as a bot (requires botmode module).
99 G Censors messages sent to the user based on filters
100 configured for the network (requires censor module).
101 H Hides an oper's oper status from WHOIS (requires
103 I Hides a user's entire channel list in WHOIS from
104 non-IRCops (requires hidechans module).
105 Q Makes an operator invisible, preventing users from
106 seeing their presence, including in channel user lists
107 (IRCop only, requires invisible module).
108 R Blocks private messages from unregistered users
109 (requires services account module).
110 S Strips mIRC color/bold/underline codes out of private
111 messages to the user (requires stripcolor module).
112 W Receives notification when a user uses WHOIS on them
113 (IRCop only, requires showwhois module).">
115 <helpop key="chmodes" value="Channel Modes
118 v [nickname] Gives voice to [nickname], allowing them to speak
119 while the channel is +m.
120 h [nickname] Gives halfop status to [nickname] (requires
121 customprefix module).
122 o [nickname] Gives op status to [nickname].
123 a [nickname] Gives protected status to [nickname], preventing
124 them from them from being kicked (+q only,
125 requires customprefix module).
126 q [nickname] Gives owner status to [nickname], preventing them
127 from being kicked (Services or only, requires
128 customprefix module).
130 b [hostmask] Bans [hostmask] from the channel.
131 e [hostmask] Excepts [hostmask] from bans (requires
132 banexception module).
133 I [hostmask] Excepts [hostmask] from +i, allowing matching
134 users to join while the channel is invite-only
135 (requires inviteexception module).
137 c Blocks messages containing mIRC color codes
138 (requires blockcolor module).
139 f [*][lines]:[sec] Kicks on text flood equal to or above the
140 specified rate. With *, the user is banned
141 (requires messageflood module).
142 g [mask] Blocks messages matching the given blob mask
143 (requires chanfilter module).
144 i Makes the channel invite-only.
145 Users can only join if an operator
146 uses /INVITE to invite them.
147 j [joins]:[sec] Limits joins to the specified rate (requires
149 k [key] Set the channel key (password) to [key].
150 l [limit] Set the maximum allowed users to [limit].
151 m Enable moderation. Only users with +v, +h, or +o
153 n Blocks users who are not members of the channel
155 p Make channel private, hiding it in user's whoises
156 and replacing it with * in /LIST.
157 r Marks the channel as registered with Services
158 (requires services account module).
159 s Make channel secret, hiding it in user's whoises
161 t Prevents users without +h or +o from changing the
163 u Makes the channel an auditorium; normal users only
164 see themselves or themselves and the operators,
165 while operators see all the users (requires
167 w [flag]:[banmask] Adds basic channel access controls of [flag] to
168 [banmask], via the +w listmode.
169 For example, +w o:R:Brain will op anyone identified
170 to the account 'Brain' on join.
171 (requires autoop module)
172 z Blocks non-SSL clients from joining the channel.
174 A Allows anyone to invite users to the channel
175 (normally only chanops can invite, requires
177 B Blocks messages with too many capital letters,
178 as determined by the network configuration
179 (requires blockcaps module).
180 C Blocks any CTCPs to the channel (requires noctcp
182 D Delays join messages from users until they
183 message the channel (requires delayjoin module).
184 E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similiar messages.
185 Kicks as default, blocks with ~ and bans with *
186 The last two parameters are optional.
187 F [changes]:[sec] Blocks nick changes when they equal or exceed the
188 specified rate (requires nickflood module).
189 G Censors messages to the channel based on the
190 network configuration (requires censor module).
191 J [seconds] Prevents rejoin after kick for the specified
192 number of seconds. This prevents auto-rejoin
193 (requires kicknorejoin module).
194 K Blocks /KNOCK on the channel.
195 L [channel] If the channel reaches its limit set by +l,
196 redirect users to [channel] (requires redirect
198 M Blocks unregistered users from speaking (requires
199 services account module).
200 N Prevents users on the channel from chainging nick
201 (requires nonicks module).
202 O Channel is IRCops only (can only be set by IRCops,
203 requires operchans module).
204 P Makes the channel permanent; Bans, invites, the
205 topic, modes, and such will not be lost when it
206 empties (can only be set by IRCops, requires
207 permchannels module).
208 Q Only ulined servers and their users can kick
209 (requires nokicks module)
210 R Blocks unregistered users from joining (requires
211 services account module).
212 S Strips mIRC color codes from messages to the
213 channel (requirs stripcolor module).
214 T Blocks /NOTICEs to the channel from users who are
215 not at least halfop (requires nonotice module).
218 NOTE: A large number of these modes are dependent upon server-side modules
219 being loaded by a server/network administrator. The actual modes available
220 on your network may be very different to this list. Please consult your
221 help channel if you have any questions.">
223 <helpop key="snomasks" value="Server Notice Masks
225 a Allows receipt of local announcement messages.
226 A Allows receipt of remote announcement messages.
227 c Allows receipt of local connect messages.
228 C Allows receipt of remote connect messages.
229 d Allows receipt of general (and sometimes random) debug
231 f Allows receipt of flooding notices.
232 g Allows receipt of globops (requires globops module).
233 G Allows receipt of notices of use of oper-override (requires
235 j Allows receipt of channel creation notices (requires
237 J Allows receipt of remote channel creation notices (requires
239 k Allows receipt of local kill messages.
240 K Allows receipt of remote kill messages.
241 l Allows receipt of local linking related
243 L Allows receipt of remote linking related
245 n See local nickname changes (requires seenicks module).
246 N See remote nickname changes (requires seenicks modules).
247 o Allows receipt of oper-up, oper-down, and oper-failure
249 O Allows receipt of remote oper-up, oper-down, and oper-failure
251 q Allows receipt of local quit messages.
252 Q Allows receipt of remote quit messages.
253 t Allows receipt of attempts to use /STATS (local and remote).
254 v Allows receipt of oper-override notices (requires override module).
255 x Allows receipt of Xline notices (g/z/q/k/e/R/shuns).">
257 <helpop key="extbans" value="Extended Bans
260 c:n!u@h Blocks any messages that contain color codes from
261 matching users (requires blockcolor module).
262 j:#channel Prevents anyone in #channel from joining the channel
263 (requires channelban module).
264 m:n!u@h Blocks messages from matching users (requires muteban
266 p:n!u@h Blocks part messages from matching users (requires
268 r:realname Prevents users with a matching realname from joining
269 the channel (requires gecosban module).
270 s:server Prevents users on a matching server from joining the
271 channel (requires services account).
273 A:n!u@h Blocks invites by matching users even when +A is set
274 (requires allowinvite module).
275 B:n!u@h Blocks all capital or nearly all capital messages from
276 matching users (requires blockcaps module).
277 C:n!u@h Blocks CTCPs from matching users (requires noctcp
279 M:account Blocks messages from users logged into a matching
280 account (requires services account module).
281 N:n!u@h Blocks nick changes from matching users (requires
283 O:opertype Prevents IRCops of the specified opertype from joining
284 the channel, mostly useful as an invite exception (IRCop
285 only, requires operchans module).
286 Q:n!u@h Blocks kicks by matching users (requires nokicks
288 R:account Prevents users logged into a matching account from
289 joining the channel (requires services account module).
290 S:n!u@h Strips color/bold/underline from messages from matching
291 users (requires stripcolor module).
292 T:n!u@h Blocks notices from matching users (requires nonotice
294 U:n!u@h Blocks unregistered users matching the given ban.
295 (requires m_services_account)
297 Redirect n!u@h#channel will redirect the banned user to #channel
298 when they try to join (requires banredirect module).
300 All extbans that prevent users from joining may by used for ban
301 exceptions and invite exceptions (invex), and extbans blocking
302 specific actions may be used for ban exceptions to exempt people from
303 either wider extbans or the restrictive mode matching the extban,