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 MODENOTICE
56 SETHOST SETIDENT CHGHOST CHGIDENT CHGNAME
59 SANICK NICKLOCK NICKUNLOCK
61 SAJOIN SAPART SAMODE SATOPIC SAKICK
63 KILL SAQUIT GLINE ZLINE QLINE
64 KLINE RLINE ELINE CBAN SHUN
67 CONNECT SQUIT RCONNECT RSQUIT
70 CLEARCACHE LOADMODULE UNLOADMODULE
71 RELOADMODULE GLOADMODULE GUNLOADMODULE
72 GRELOADMODULE CLOSE JUMPSERVER
75 <helpop key="umodes" value="User Modes
78 c Blocks private messages and notices from users who do
79 not share a common channel with you (requires the
81 d Deaf mode. User will not receive any messages or notices
82 from channels they are in (requires the deaf module).
83 g In combination with /ACCEPT, provides for server side
84 ignore (requires the callerid module).
85 h Marks as 'available for help' in WHOIS (IRCop only,
86 requires the helpop module).
87 i Makes invisible to /WHO if the user using /WHO is not in
89 k Prevents the user from being kicked from channels, or
90 having op modes removed from them (services only,
91 requires the servprotect module).
92 o Marks as a IRC operator.
93 s <mask> Receives server notices specified by <mask>
95 r Marks as a having a registered nickname
96 (requires the services account module).
97 w Receives wallops messages.
98 x Gives a cloaked hostname (requires the cloaking module).
99 B Marks as a bot (requires the botmode module).
100 G Censors messages sent to the user based on filters
101 configured for the network (requires the censor module).
102 H Hides an oper's oper status from WHOIS (requires the
104 I Hides a user's entire channel list in WHOIS from
105 non-IRCops (requires the hidechans module).
106 L Stops redirections done by m_redirect (mode must be
107 enabled in the config).
108 R Blocks private messages from unregistered users
109 (requires the services account module).
110 S Strips formatting codes out of private messages
111 to the user (requires the stripcolor module).
112 W Receives notification when a user uses WHOIS on them
113 (IRCop only, requires the 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 the
121 customprefix module).
122 o <nickname> Gives op status to <nickname>.
123 a <nickname> Gives protected status to <nickname>, preventing
124 them from being kicked (+q only, requires the
125 customprefix module).
126 q <nickname> Gives owner status to <nickname>, preventing them
127 from being kicked (Services or +q only, requires
128 the customprefix module).
130 b <hostmask> Bans <hostmask> from the channel.
131 e <hostmask> Excepts <hostmask> from bans (requires the
132 banexception module).
133 I <hostmask> Excepts <hostmask> from +i, allowing matching
134 users to join while the channel is invite-only
135 (requires the inviteexception module).
137 c Blocks messages that contain formatting codes
138 (requires the blockcolor module).
139 d <time> Blocks messages to a channel from new users
140 until they have been in the channel for <time>
141 seconds (requires the delaymsg module).
142 f [*]<lines>:<sec> Kicks on text flood equal to or above the
143 specified rate. With *, the user is banned
144 (requires the messageflood module).
145 g <mask> Blocks messages matching the given glob mask
146 (requires the chanfilter module).
147 i Makes the channel invite-only.
148 Users can only join if an operator
149 uses /INVITE to invite them.
150 j <joins>:<sec> Limits joins to the specified rate (requires
151 the joinflood module).
152 k <key> Set the channel key (password) to <key>.
153 l <limit> Set the maximum allowed users to <limit>.
154 m Enable moderation. Only users with +v, +h, or +o
156 n Blocks users who are not members of the channel
158 p Make channel private, hiding it in users' whoises
159 and replacing it with * in /LIST.
160 r Marks the channel as registered with Services
161 (requires the services account module).
162 s Make channel secret, hiding it in users' whoises
164 t Prevents users without +h or +o from changing the
166 u Makes the channel an auditorium; normal users only
167 see themselves or themselves and the operators,
168 while operators see all the users (requires the
170 w <flag>:<banmask> Adds basic channel access controls of <flag> to
171 <banmask>, via the +w listmode.
172 For example, +w o:R:Brain will op anyone identified
173 to the account 'Brain' on join.
174 (requires the autoop module)
175 z Blocks non-SSL clients from joining the channel.
177 A Allows anyone to invite users to the channel
178 (normally only chanops can invite, requires
179 the allowinvite module).
180 B Blocks messages with too many capital letters,
181 as determined by the network configuration
182 (requires the blockcaps module).
183 C Blocks any CTCPs to the channel (requires the
185 D Delays join messages from users until they message
186 the channel (requires the delayjoin module).
187 F <changes>:<sec> Blocks nick changes when they equal or exceed the
188 specified rate (requires the nickflood module).
189 G Censors messages to the channel based on the
190 network configuration (requires the censor module).
191 H <num>:<duration> Displays the last <num> lines of chat to joining
192 users. <duration> is the maximum time to keep
193 lines in the history buffer (requires the
195 J <seconds> Prevents rejoin after kick for the specified
196 number of seconds. This prevents auto-rejoin
197 (requires the kicknorejoin module).
198 K Blocks /KNOCK on the channel.
199 L <channel> If the channel reaches its limit set by +l,
200 redirect users to <channel> (requires the
202 M Blocks unregistered users from speaking (requires
203 the services account module).
204 N Prevents users on the channel from changing nick
205 (requires the nonicks module).
206 O Channel is IRCops only (can only be set by IRCops,
207 requires the operchans module).
208 P Makes the channel permanent; Bans, invites, the
209 topic, modes, and such will not be lost when it
210 empties (can only be set by IRCops, requires
211 the permchannels module).
212 Q Only ulined servers and their users can kick
213 (requires the nokicks module)
214 R Blocks unregistered users from joining (requires
215 the services account module).
216 S Strips formatting codes from messages to the
217 channel (requires the stripcolor module).
218 T Blocks /NOTICEs to the channel from users who are
219 not at least halfop (requires the nonotice module).
220 X <type>:<status> Makes users of <status> or higher exempt to the
221 specified restriction <type>. For example: flood:h
222 (requires the exemptchanops module).
225 NOTE: A large number of these modes are dependent upon server-side modules
226 being loaded by a server/network administrator. The actual modes available
227 on your network may be very different to this list. Please consult your
228 help channel if you have any questions.">
230 <helpop key="snomasks" value="Server Notice Masks
232 a Allows receipt of local announcement messages.
233 A Allows receipt of remote announcement messages.
234 c Allows receipt of local connect messages.
235 C Allows receipt of remote connect messages.
236 d Allows receipt of general (and sometimes random) debug messages.
237 f Allows receipt of flooding notices.
238 g Allows receipt of globops (requires the globops module).
239 j Allows receipt of channel creation notices (requires the chancreate module).
240 J Allows receipt of remote channel creation notices (requires the chancreate module).
241 k Allows receipt of local kill messages.
242 K Allows receipt of remote kill messages.
243 l Allows receipt of local linking related messages.
244 L Allows receipt of remote linking related messages.
245 n See local nickname changes (requires the seenicks module).
246 N See remote nickname changes (requires the seenicks modules).
247 o Allows receipt of oper-up, oper-down, and oper-failure messages.
248 O Allows receipt of remote oper-up, oper-down, and oper-failure messages.
249 q Allows receipt of local quit messages.
250 Q Allows receipt of remote quit messages.
251 r Allows receipt of local oper commands (requires the operlog module).
252 R Allows receipt of remote oper commands (requires the operlog module).
253 t Allows receipt of attempts to use /STATS (local and remote).
254 v Allows receipt of oper-override notices (requires the override module).
255 x Allows receipt of local Xline notices (g/Z/q/k/e/R/shuns).
256 X Allows receipt of remote Xline notices (g/Z/q/k/e/R/shuns).">
258 <helpop key="extbans" value="Extended Bans
261 Extbans are split into two types; matching extbans, which match on
262 users in additional ways, and acting extbans, which restrict users
263 in different ways to a standard ban.
265 To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
266 instead of a normal nick!user@host mask, to ban or exempt matching
267 users. Ban exceptions on acting extbans exempt that user from matching
268 an extban of that type, and from any channel mode corresponding to the
269 restriction. Matching extbans may also be used for invite exceptions by
274 j:<channel> Matches anyone in the given channel. Does not support
275 wildcards (requires the channelban module).
276 r:<realname> Matches users with a matching realname (requires the
278 s:<server> Matches users on a matching server (requires the
280 z:<certfp> Matches users having the given SSL certificate
281 fingerprint (requires the sslmodes module).
282 O:<opertype> Matches IRCops of a matching type, mostly useful as an
283 an invite exception (requires the operchans module).
284 R:<account> Matches users logged into a matching account (requires
285 the services account module).
286 U:<banmask> Matches unregistered users matching the given banmask.
287 (requires the services account module).
291 c:<banmask> Blocks any messages that contain formatting codes from
292 matching users (requires the blockcolor module).
293 m:<banmask> Blocks messages from matching users (requires the muteban
294 module). Users with +v or above are not affected.
295 p:<banmask> Blocks part messages from matching users (requires
296 the nopartmsg module).
297 A:<banmask> Blocks invites by matching users even when +A is set
298 (requires the allowinvite module).
299 B:<banmask> Blocks all capital or nearly all capital messages from
300 matching users (requires the blockcaps module).
301 C:<banmask> Blocks CTCPs from matching users (requires the noctcp
303 N:<banmask> Blocks nick changes from matching users (requires
305 Q:<banmask> Blocks kicks by matching users (requires the nokicks
307 S:<banmask> Strips formatting codes from messages from matching
308 users (requires the stripcolor module).
309 T:<banmask> Blocks notices from matching users (requires the
312 A ban given to an Acting extban may either be a nick!user@host mask
313 (unless stated otherwise), matched against users as for a normal ban,
314 or a Matching extban.
316 There is an additional special type of extended ban, a redirect ban:
318 Redirect n!u@h#channel will redirect the banned user to #channel
319 when they try to join (requires the banredirect module).">