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
40 LIST NAMES WHO MOTD RULES
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 R Blocks private messages from unregistered users
106 (requires services account module).
107 S Strips mIRC color/bold/underline codes out of private
108 messages to the user (requires stripcolor module).
109 W Receives notification when a user uses WHOIS on them
110 (IRCop only, requires showwhois module).">
112 <helpop key="chmodes" value="Channel Modes
115 v [nickname] Gives voice to [nickname], allowing them to speak
116 while the channel is +m.
117 h [nickname] Gives halfop status to [nickname] (this mode can
119 o [nickname] Gives op status to [nickname].
120 a [nickname] Gives protected status to [nickname], preventing
121 them from them from being kicked (+q only,
122 requires chanprotect module).
123 q [nickname] Gives owner status to [nickname], preventing them
124 from being kicked (Services or only, requires
127 b [hostmask] Bans [hostmask] from the channel.
128 e [hostmask] Excepts [hostmask] from bans (requires
129 banexception module).
130 I [hostmask] Excepts [hostmask] from +i, allowing matching
131 users to join while the channel is invite-only
132 (requires inviteexception module).
134 c Blocks messages containing mIRC color codes
135 (requires blockcolor module).
136 f [*][lines]:[sec] Kicks on text flood equal to or above the
137 specified rate. With *, the user is banned
138 (requires messageflood module).
139 g [mask] Blocks messages matching the given blob mask
140 (requires chanfilter module).
141 i Makes the channel invite-only.
142 Users can only join if an operator
143 uses /INVITE to invite them.
144 j [joins]:[sec] Limits joins to the specified rate (requires
146 k [key] Set the channel key (password) to [key].
147 l [limit] Set the maximum allowed users to [limit].
148 m Enable moderation. Only users with +v, +h, or +o
150 n Blocks users who are not members of the channel
152 p Make channel private, hiding it in user's whoises
153 and replacing it with * in /LIST.
154 r Marks the channel as registered with Services
155 (requires services account module).
156 s Make channel secret, hiding it in user's whoises
158 t Prevents users without +h or +o from changing the
160 u Makes the channel an auditorium; normal users only
161 see themselves or themselves and the operators,
162 while operators see all the users (requires
164 w [flag]:[banmask] Adds basic channel access controls of [flag] to
165 [banmask], via the +w listmode.
166 For example, +w o:R:Brain will op anyone identified
167 to the account 'Brain' on join.
168 (requires autoop module)
169 z Blocks non-SSL clients from joining the channel.
171 A Allows anyone to invite users to the channel
172 (normally only chanops can invite, requires
174 B Blocks messages with too many capital letters,
175 as determined by the network configuration
176 (requires blockcaps module).
177 C Blocks any CTCPs to the channel (requires noctcp
179 D Delays join messages from users until they
180 message the channel (requires delayjoin module).
181 F [changes]:[sec] Blocks nick changes when they equal or exceed the
182 specified rate (requires nickflood module).
183 G Censors messages to the channel based on the
184 network configuration (requires censor module).
185 J [seconds] Prevents rejoin after kick for the specified
186 number of seconds. This prevents auto-rejoin
187 (requires kicknorejoin module).
188 K Blocks /KNOCK on the channel.
189 L [channel] If the channel reaches its limit set by +l,
190 redirect users to [channel] (requires redirect
192 M Blocks unregistered users from speaking (requires
193 services account module).
194 N Prevents users on the channel from chainging nick
195 (requires nonicks module).
196 O Channel is IRCops only (can only be set by IRCops,
197 requires operchans module).
198 P Makes the channel permanent; Bans, invites, the
199 topic, modes, and such will not be lost when it
200 empties (can only be set by IRCops, requires
201 permchannels module).
202 Q Only ulined servers and their users can kick
203 (requires nokicks module)
204 R Blocks unregistered users from joining (requires
205 services account module).
206 S Strips mIRC color codes from messages to the
207 channel (requirs stripcolor module).
208 T Blocks /NOTICEs to the channel from users who are
209 not at least halfop (requires nonotice module).
212 NOTE: A large number of these modes are dependent upon server-side modules
213 being loaded by a server/network administrator. The actual modes available
214 on your network may be very different to this list. Please consult your
215 help channel if you have any questions.">
217 <helpop key="snomasks" value="Server Notice Masks
219 a Allows receipt of local announcement messages.
220 A Allows receipt of remote announcement messages.
221 c Allows receipt of local connect messages.
222 C Allows receipt of remote connect messages.
223 d Allows receipt of general (and sometimes random) debug
225 f Allows receipt of flooding notices.
226 g Allows receipt of globops (requires globops module).
227 j Allows receipt of channel creation notices (requires
229 J Allows receipt of remote channel creation notices (requires
231 k Allows receipt of local kill messages.
232 K Allows receipt of remote kill messages.
233 l Allows receipt of local linking related
235 L Allows receipt of remote linking related
237 n See local nickname changes (requires seenicks module).
238 N See remote nickname changes (requires seenicks modules).
239 o Allows receipt of oper-up, oper-down, and oper-failure
241 O Allows receipt of remote oper-up, oper-down, and oper-failure
243 q Allows receipt of local quit messages.
244 Q Allows receipt of remote quit messages.
245 t Allows receipt of attempts to use /STATS (local and remote).
246 v Allows receipt of oper-override notices (requires override module).
247 x Allows receipt of local Xline notices (g/Z/q/k/e/R/shuns).
248 X Allows receipt of remote Xline notices (g/Z/q/k/e/R/shuns).">
250 <helpop key="extbans" value="Extended Bans
253 c:n!u@h Blocks any messages that contain color codes from
254 matching users (requires blockcolor module).
255 j:#channel Prevents anyone in #channel from joining the channel
256 (requires channelban module).
257 m:n!u@h Blocks messages from matching users (requires muteban
259 p:n!u@h Blocks part messages from matching users (requires
261 r:realname Prevents users with a matching realname from joining
262 the channel (requires gecosban module).
263 s:server Prevents users on a matching server from joining the
264 channel (requires services account).
266 A:n!u@h Blocks invites by matching users even when +A is set
267 (requires allowinvite module).
268 B:n!u@h Blocks all capital or nearly all capital messages from
269 matching users (requires blockcaps module).
270 C:n!u@h Blocks CTCPs from matching users (requires noctcp
272 M:account Blocks messages from users logged into a matching
273 account (requires services account module).
274 N:n!u@h Blocks nick changes from matching users (requires
276 O:opertype Prevents IRCops of the specified opertype from joining
277 the channel, mostly useful as an invite exception (IRCop
278 only, requires operchans module).
279 Q:n!u@h Blocks kicks by matching users (requires nokicks
281 R:account Prevents users logged into a matching account from
282 joining the channel (requires services account module).
283 S:n!u@h Strips color/bold/underline from messages from matching
284 users (requires stripcolor module).
285 T:n!u@h Blocks notices from matching users (requires nonotice
287 U:n!u@h Blocks unregistered users matching the given ban.
288 (requires m_services_account)
289 z:certfp Blocks users having the given certificate fingerprint
290 (requires m_sslmodes)
292 Redirect n!u@h#channel will redirect the banned user to #channel
293 when they try to join (requires banredirect module).
295 All extbans that prevent users from joining may by used for ban
296 exceptions and invite exceptions (invex), and extbans blocking
297 specific actions may be used for ban exceptions to exempt people from
298 either wider extbans or the restrictive mode matching the extban,