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 <helpmsg missing="There is no help for the topic you searched for. Please try again.">
16 <helpop key="start" value="InspIRCd Help System
18 This system provides help for commands and modes.
19 Specify your question or a command name as the
20 parameter for this command.
22 /HELPOP CUSER - To see a list of user commands
23 /HELPOP COPER - To see a list of oper commands
24 /HELPOP UMODES - To see a list of user modes
25 /HELPOP CHMODES - To see a list of channel modes
26 /HELPOP SNOMASKS - To see a list of oper snotice masks
27 /HELPOP EXTBANS - To see a list of extended bans">
29 <helpop key="cuser" value="User Commands
32 PRIVMSG NOTICE NICK JOIN PART
33 CYCLE KNOCK MODE OPER TOPIC
34 KICK FPART REMOVE TBAN INVITE
35 UNINVITE AWAY DCCALLOW SILENCE ACCEPT
36 MKPASSWD VHOST TITLE SETNAME
38 WHOIS WHOWAS ISON USERHOST WATCH
40 ADMIN MAP LINKS LUSERS TIME
41 STATS VERSION INFO MODULES COMMANDS
44 USER PASS PING PONG QUIT">
46 <helpop key="coper" value="Oper Commands
49 OPERMOTD CHECK CLONES USERIP TLINE
50 ALLTIME WALLOPS GLOBOPS MODENOTICE
53 SETHOST SETIDENT CHGHOST CHGIDENT CHGNAME
56 SANICK NICKLOCK NICKUNLOCK
58 SAJOIN SAPART SAMODE SATOPIC SAKICK
60 KILL SAQUIT GLINE ZLINE QLINE
61 KLINE RLINE ELINE CBAN SHUN
64 CONNECT SQUIT RCONNECT RSQUIT
67 LOADMODULE UNLOADMODULE
68 RELOADMODULE GLOADMODULE GUNLOADMODULE
69 GRELOADMODULE CLOSE JUMPSERVER
72 <helpop key="umodes" value="User Modes
75 c Blocks private messages and notices from users who do
76 not share a common channel with you (requires the
78 d Deaf mode. User will not receive any messages or notices
79 from channels they are in (requires the deaf module).
80 g In combination with /ACCEPT, provides for server side
81 ignore (requires the callerid module).
82 h Marks as 'available for help' in WHOIS (IRCop only,
83 requires the helpop module).
84 i Makes invisible to /WHO if the user using /WHO is not in
86 k Prevents the user from being kicked from channels, or
87 having op modes removed from them (services only,
88 requires the servprotect module).
89 o Marks as a IRC operator.
90 s <mask> Receives server notices specified by <mask>
92 r Marks as a having a registered nickname
93 (requires the services account module).
94 w Receives wallops messages.
95 x Gives a cloaked hostname (requires the cloaking module).
96 z Only allow private messages from SSL users (requires the
98 B Marks as a bot (requires the botmode module).
99 G Censors messages sent to the user based on filters
100 configured for the network (requires the censor module).
101 H Hides an oper's oper status from WHOIS (requires the
103 I Hides a user's entire channel list in WHOIS from
104 non-IRCops (requires the hidechans module).
105 L Stops redirections done by m_redirect (mode must be
106 enabled in the config).
107 R Blocks private messages from unregistered users
108 (requires the services account module).
109 S Strips formatting codes out of private messages
110 to the user (requires the stripcolor module).
111 W Receives notification when a user uses WHOIS on them
112 (IRCop only, requires the showwhois module).">
114 <helpop key="chmodes" value="Channel Modes
117 v <nickname> Gives voice to <nickname>, allowing them to speak
118 while the channel is +m.
119 h <nickname> Gives halfop status to <nickname> (requires the
120 customprefix module).
121 o <nickname> Gives op status to <nickname>.
122 a <nickname> Gives protected status to <nickname>, preventing
123 them from being kicked (+q only, requires the
124 customprefix module).
125 q <nickname> Gives owner status to <nickname>, preventing them
126 from being kicked (Services or +q only, requires
127 the customprefix module).
129 b <hostmask> Bans <hostmask> from the channel.
130 e <hostmask> Excepts <hostmask> from bans (requires the
131 banexception module).
132 I <hostmask> Excepts <hostmask> from +i, allowing matching
133 users to join while the channel is invite-only
134 (requires the inviteexception module).
136 c Blocks messages that contain formatting codes
137 (requires the blockcolor module).
138 d <time> Blocks messages to a channel from new users
139 until they have been in the channel for <time>
140 seconds (requires the delaymsg module).
141 f [*]<lines>:<sec> Kicks on text flood equal to or above the
142 specified rate. With *, the user is banned
143 (requires the messageflood module).
144 g <mask> Blocks messages matching the given glob mask
145 (requires the chanfilter module).
146 i Makes the channel invite-only.
147 Users can only join if an operator
148 uses /INVITE to invite them.
149 j <joins>:<sec> Limits joins to the specified rate (requires
150 the joinflood module).
151 k <key> Set the channel key (password) to <key>.
152 l <limit> Set the maximum allowed users to <limit>.
153 m Enable moderation. Only users with +v, +h, or +o
155 n Blocks users who are not members of the channel
157 p Make channel private, hiding it in users' whoises
158 and replacing it with * in /LIST.
159 r Marks the channel as registered with Services
160 (requires the services account module).
161 s Make channel secret, hiding it in users' whoises
163 t Prevents users without +h or +o from changing the
165 u Makes the channel an auditorium; normal users only
166 see themselves or themselves and the operators,
167 while operators see all the users (requires the
169 w <flag>:<banmask> Adds basic channel access controls of <flag> to
170 <banmask>, via the +w listmode.
171 For example, +w o:R:Brain will op anyone identified
172 to the account 'Brain' on join.
173 (requires the autoop module)
174 z Blocks non-SSL clients from joining the channel.
176 A Allows anyone to invite users to the channel
177 (normally only chanops can invite, requires
178 the allowinvite module).
179 B Blocks messages with too many capital letters,
180 as determined by the network configuration
181 (requires the blockcaps module).
182 C Blocks any CTCPs to the channel (requires the
184 D Delays join messages from users until they message
185 the channel (requires the delayjoin module).
186 E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similar messages.
187 Kicks as default, blocks with ~ and bans with *
188 The last two parameters are optional.
190 F <changes>:<sec> Blocks nick changes when they equal or exceed the
191 specified rate (requires the nickflood module).
192 G Censors messages to the channel based on the
193 network configuration (requires the censor module).
194 H <num>:<duration> Displays the last <num> lines of chat to joining
195 users. <duration> is the maximum time to keep
196 lines in the history buffer (requires the
198 J <seconds> Prevents rejoin after kick for the specified
199 number of seconds. This prevents auto-rejoin
200 (requires the kicknorejoin module).
201 K Blocks /KNOCK on the channel.
202 L <channel> If the channel reaches its limit set by +l,
203 redirect users to <channel> (requires the
205 M Blocks unregistered users from speaking (requires
206 the services account module).
207 N Prevents users on the channel from changing nick
208 (requires the nonicks module).
209 O Channel is IRCops only (can only be set by IRCops,
210 requires the operchans module).
211 P Makes the channel permanent; Bans, invites, the
212 topic, modes, and such will not be lost when it
213 empties (can only be set by IRCops, requires
214 the permchannels module).
215 Q Only ulined servers and their users can kick
216 (requires the nokicks module)
217 R Blocks unregistered users from joining (requires
218 the services account module).
219 S Strips formatting codes from messages to the
220 channel (requires the stripcolor module).
221 T Blocks /NOTICEs to the channel from users who are
222 not at least halfop (requires the nonotice module).
223 X <type>:<status> Makes users of <status> or higher exempt to the
224 specified restriction <type>. For example: flood:h
225 (requires the exemptchanops module).
228 NOTE: A large number of these modes are dependent upon server-side modules
229 being loaded by a server/network administrator. The actual modes available
230 on your network may be very different to this list. Please consult your
231 help channel if you have any questions.">
233 <helpop key="snomasks" value="Server Notice Masks
235 a Allows receipt of local announcement messages.
236 A Allows receipt of remote announcement messages.
237 c Allows receipt of local connect messages.
238 C Allows receipt of remote connect messages.
239 d Allows receipt of local DNSBL messages (requires the dnsbl module).
240 D Allows receipt of remote DNSBL messages (requires the dnsbl module).
241 f Allows receipt of local filter messages (requires the filter module).
242 F Allows receipt of remote filter messages (requires the filter module).
243 g Allows receipt of globops (requires the globops module).
244 j Allows receipt of channel creation notices (requires the chancreate module).
245 J Allows receipt of remote channel creation notices (requires the chancreate module).
246 k Allows receipt of local kill messages.
247 K Allows receipt of remote kill messages.
248 l Allows receipt of local linking related messages.
249 L Allows receipt of remote linking related messages.
250 n See local nickname changes (requires the seenicks module).
251 N See remote nickname changes (requires the seenicks modules).
252 o Allows receipt of oper-up, oper-down, and oper-failure messages.
253 O Allows receipt of remote oper-up, oper-down, and oper-failure messages.
254 q Allows receipt of local quit messages.
255 Q Allows receipt of remote quit messages.
256 r Allows receipt of local oper commands (requires the operlog module).
257 R Allows receipt of remote oper commands (requires the operlog module).
258 t Allows receipt of attempts to use /STATS (local and remote).
259 v Allows receipt of oper-override notices (requires the override module).
260 x Allows receipt of local Xline notices (g/Z/q/k/e/R/shuns).
261 X Allows receipt of remote Xline notices (g/Z/q/k/e/R/shuns).">
263 <helpop key="extbans" value="Extended Bans
266 Extbans are split into two types; matching extbans, which match on
267 users in additional ways, and acting extbans, which restrict users
268 in different ways to a standard ban.
270 To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
271 instead of a normal nick!user@host mask, to ban or exempt matching
272 users. Ban exceptions on acting extbans exempt that user from matching
273 an extban of that type, and from any channel mode corresponding to the
274 restriction. Matching extbans may also be used for invite exceptions by
279 a:<mask> Matches user with both a matching banmask and realname,
280 where <mask> is in the format nick!user@host+realname
281 (requires gecosban module).
282 j:<channel> Matches anyone in the given channel. Does not support
283 wildcards (requires the channelban module).
284 n:<class> Matches users in a matching connect class (requires
285 the classban module).
286 r:<realname> Matches users with a matching real name (requires the
288 s:<server> Matches users on a matching server (requires the
290 z:<certfp> Matches users having the given SSL certificate
291 fingerprint (requires the sslmodes module).
292 O:<opertype> Matches IRCops of a matching type, mostly useful as an
293 an invite exception (requires the operchans module).
294 R:<account> Matches users logged into a matching account (requires
295 the services account module).
296 U:<banmask> Matches unregistered users matching the given banmask.
297 (requires the services account module).
301 c:<banmask> Blocks any messages that contain formatting codes from
302 matching users (requires the blockcolor module).
303 m:<banmask> Blocks messages from matching users (requires the muteban
304 module). Users with +v or above are not affected.
305 p:<banmask> Blocks part messages from matching users (requires
306 the nopartmsg module).
307 A:<banmask> Blocks invites by matching users even when +A is set
308 (requires the allowinvite module).
309 B:<banmask> Blocks all capital or nearly all capital messages from
310 matching users (requires the blockcaps module).
311 C:<banmask> Blocks CTCPs from matching users (requires the noctcp
313 N:<banmask> Blocks nick changes from matching users (requires
315 Q:<banmask> Blocks kicks by matching users (requires the nokicks
317 S:<banmask> Strips formatting codes from messages from matching
318 users (requires the stripcolor module).
319 T:<banmask> Blocks notices from matching users (requires the
322 A ban given to an Acting extban may either be a nick!user@host mask
323 (unless stated otherwise), matched against users as for a normal ban,
324 or a Matching extban.
326 There is an additional special type of extended ban, a redirect ban:
328 Redirect n!u@h#channel will redirect the banned user to #channel
329 when they try to join (requires the banredirect module).">