1 # Sample configuration file for the helpop module.
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 OPER 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">
47 <helpop key="coper" value="Oper Commands
50 OPERMOTD CHECK CLONES USERIP TLINE
51 ALLTIME WALLOPS GLOBOPS MODENOTICE
54 SETHOST SETIDENT CHGHOST CHGIDENT CHGNAME
57 SANICK NICKLOCK NICKUNLOCK
59 SAJOIN SAPART SAMODE SATOPIC SAKICK
61 KILL SAQUIT GLINE ZLINE QLINE
62 KLINE RLINE ELINE CBAN SHUN
65 CONNECT SQUIT RCONNECT RSQUIT
68 LOADMODULE UNLOADMODULE
69 RELOADMODULE GLOADMODULE GUNLOADMODULE
70 GRELOADMODULE CLOSE JUMPSERVER
73 <helpop key="umodes" value="User Modes
76 c Blocks private messages and notices from users who do
77 not share a common channel with you (requires the
79 d Deaf mode. User will not receive any messages or notices
80 from channels they are in (requires the deaf module).
81 g In combination with /ACCEPT, provides for server side
82 ignore (requires the callerid module).
83 h Marks as 'available for help' in WHOIS (IRCop only,
84 requires the helpop module).
85 i Makes invisible to /WHO if the user using /WHO is not in
87 k Prevents the user from being kicked from channels, or
88 having op modes removed from them (services only,
89 requires the servprotect module).
90 o Marks as a IRC operator.
91 s <mask> Receives server notices specified by <mask>
93 r Marks as a having a registered nickname
94 (requires the services account module).
95 w Receives wallops messages.
96 x Gives a cloaked hostname (requires the cloaking module).
97 z Only allow private messages from SSL users (requires the
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 E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similar messages.
188 Kicks as default, blocks with ~ and bans with *
189 The last two parameters are optional.
191 F <changes>:<sec> Blocks nick changes when they equal or exceed the
192 specified rate (requires the nickflood module).
193 G Censors messages to the channel based on the
194 network configuration (requires the censor module).
195 H <num>:<duration> Displays the last <num> lines of chat to joining
196 users. <duration> is the maximum time to keep
197 lines in the history buffer (requires the
199 J <seconds> Prevents rejoin after kick for the specified
200 number of seconds. This prevents auto-rejoin
201 (requires the kicknorejoin module).
202 K Blocks /KNOCK on the channel.
203 L <channel> If the channel reaches its limit set by +l,
204 redirect users to <channel> (requires the
206 M Blocks unregistered users from speaking (requires
207 the services account module).
208 N Prevents users on the channel from changing nick
209 (requires the nonicks module).
210 O Channel is IRCops only (can only be set by IRCops,
211 requires the operchans module).
212 P Makes the channel permanent; Bans, invites, the
213 topic, modes, and such will not be lost when it
214 empties (can only be set by IRCops, requires
215 the permchannels module).
216 Q Only ulined servers and their users can kick
217 (requires the nokicks module)
218 R Blocks unregistered users from joining (requires
219 the services account module).
220 S Strips formatting codes from messages to the
221 channel (requires the stripcolor module).
222 T Blocks /NOTICEs to the channel from users who are
223 not at least halfop (requires the nonotice module).
224 X <type>:<status> Makes users of <status> or higher exempt to the
225 specified restriction <type>. For example: flood:h
226 (requires the exemptchanops module).
229 NOTE: A large number of these modes are dependent upon server-side modules
230 being loaded by a server/network administrator. The actual modes available
231 on your network may be very different to this list. Please consult your
232 help channel if you have any questions.">
234 <helpop key="snomasks" value="Server Notice Masks
236 a Allows receipt of local announcement messages.
237 A Allows receipt of remote announcement messages.
238 c Allows receipt of local connect messages.
239 C Allows receipt of remote connect messages.
240 d Allows receipt of local DNSBL messages (requires the dnsbl module).
241 D Allows receipt of remote DNSBL messages (requires the dnsbl module).
242 f Allows receipt of local filter messages (requires the filter module).
243 F Allows receipt of remote filter messages (requires the filter module).
244 g Allows receipt of globops (requires the globops module).
245 j Allows receipt of channel creation notices (requires the chancreate module).
246 J Allows receipt of remote channel creation notices (requires the chancreate module).
247 k Allows receipt of local kill messages.
248 K Allows receipt of remote kill messages.
249 l Allows receipt of local linking related messages.
250 L Allows receipt of remote linking related messages.
251 n See local nickname changes (requires the seenicks module).
252 N See remote nickname changes (requires the seenicks modules).
253 o Allows receipt of oper-up, oper-down, and oper-failure messages.
254 O Allows receipt of remote oper-up, oper-down, and oper-failure messages.
255 q Allows receipt of local quit messages.
256 Q Allows receipt of remote quit messages.
257 r Allows receipt of local oper commands (requires the operlog module).
258 R Allows receipt of remote oper commands (requires the operlog module).
259 t Allows receipt of attempts to use /STATS (local and remote).
260 v Allows receipt of oper-override notices (requires the override module).
261 x Allows receipt of local Xline notices (g/Z/q/k/e/R/shuns).
262 X Allows receipt of remote Xline notices (g/Z/q/k/e/R/shuns).">
264 <helpop key="extbans" value="Extended Bans
267 Extbans are split into two types; matching extbans, which match on
268 users in additional ways, and acting extbans, which restrict users
269 in different ways to a standard ban.
271 To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
272 instead of a normal nick!user@host mask, to ban or exempt matching
273 users. Ban exceptions on acting extbans exempt that user from matching
274 an extban of that type, and from any channel mode corresponding to the
275 restriction. Matching extbans may also be used for invite exceptions by
280 a:<mask> Matches user with both a matching banmask and realname,
281 where <mask> is in the format nick!user@host+realname
282 (requires gecosban module).
283 j:<channel> Matches anyone in the given channel. Does not support
284 wildcards (requires the channelban module).
285 n:<class> Matches users in a matching connect class (requires
286 the classban module).
287 r:<realname> Matches users with a matching real name (requires the
289 s:<server> Matches users on a matching server (requires the
291 z:<certfp> Matches users having the given SSL certificate
292 fingerprint (requires the sslmodes module).
293 O:<opertype> Matches IRCops of a matching type, mostly useful as an
294 an invite exception (requires the operchans module).
295 R:<account> Matches users logged into a matching account (requires
296 the services account module).
297 U:<banmask> Matches unregistered users matching the given banmask.
298 (requires the services account module).
302 c:<banmask> Blocks any messages that contain formatting codes from
303 matching users (requires the blockcolor module).
304 m:<banmask> Blocks messages from matching users (requires the muteban
305 module). Users with +v or above are not affected.
306 p:<banmask> Blocks part messages from matching users (requires
307 the nopartmsg module).
308 A:<banmask> Blocks invites by matching users even when +A is set
309 (requires the allowinvite module).
310 B:<banmask> Blocks all capital or nearly all capital messages from
311 matching users (requires the blockcaps module).
312 C:<banmask> Blocks CTCPs from matching users (requires the noctcp
314 N:<banmask> Blocks nick changes from matching users (requires
316 Q:<banmask> Blocks kicks by matching users (requires the nokicks
318 S:<banmask> Strips formatting codes from messages from matching
319 users (requires the stripcolor module).
320 T:<banmask> Blocks notices from matching users (requires the
323 A ban given to an Acting extban may either be a nick!user@host mask
324 (unless stated otherwise), matched against users as for a normal ban,
325 or a Matching extban.
327 There is an additional special type of extended ban, a redirect ban:
329 Redirect n!u@h#channel will redirect the banned user to #channel
330 when they try to join (requires the banredirect module).">