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 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 MODENOTICE
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 CLOSE 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 /ACCEPT, 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> (requires
118 customprefix module).
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 customprefix module).
123 q <nickname> Gives owner status to <nickname>, preventing them
124 from being kicked (Services or only, requires
125 customprefix module).
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 d <time> Blocks messages to a channel from new users
137 until they have been in the channel for <time>
138 seconds (requires delaymsg 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 i Makes the channel invite-only.
143 Users can only join if an operator
144 uses /INVITE to invite them.
145 j <joins>:<sec> Limits joins to the specified rate (requires
147 k <key> Set the channel key (password) to <key>.
148 l <limit> Set the maximum allowed users to <limit>.
149 m Enable moderation. Only users with +v, +h, or +o
151 n Blocks users who are not members of the channel
153 p Make channel private, hiding it in users' whoises
154 and replacing it with * in /LIST.
155 r Marks the channel as registered with Services
156 (requires services account module).
157 s Make channel secret, hiding it in users' whoises
159 t Prevents users without +h or +o from changing the
161 u Makes the channel an auditorium; normal users only
162 see themselves or themselves and the operators,
163 while operators see all the users (requires
165 w <flag>:<banmask> Adds basic channel access controls of <flag> to
166 <banmask>, via the +w listmode.
167 For example, +w o:R:Brain will op anyone identified
168 to the account 'Brain' on join.
169 (requires autoop module)
170 z Blocks non-SSL clients from joining the channel.
172 A Allows anyone to invite users to the channel
173 (normally only chanops can invite, requires
175 B Blocks messages with too many capital letters,
176 as determined by the network configuration
177 (requires blockcaps module).
178 C Blocks any CTCPs to the channel (requires noctcp
180 D Delays join messages from users until they
181 message the channel (requires delayjoin module).
182 E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similar messages.
183 Kicks as default, blocks with ~ and bans with *
184 The last two parameters are optional.
185 F <changes>:<sec> Blocks nick changes when they equal or exceed the
186 specified rate (requires nickflood module).
187 G Censors messages to the channel based on the
188 network configuration (requires censor module).
189 H <num>:<duration> Displays the last <num> lines of chat to joining
190 users. <duration> is the maximum time to keep
191 lines in the history buffer (requires chanhistory
193 J <seconds> Prevents rejoin after kick for the specified
194 number of seconds. This prevents auto-rejoin
195 (requires kicknorejoin module).
196 K Blocks /KNOCK on the channel.
197 L <channel> If the channel reaches its limit set by +l,
198 redirect users to <channel> (requires redirect
200 M Blocks unregistered users from speaking (requires
201 services account module).
202 N Prevents users on the channel from changing nick
203 (requires nonicks module).
204 O Channel is IRCops only (can only be set by IRCops,
205 requires operchans module).
206 P Makes the channel permanent; Bans, invites, the
207 topic, modes, and such will not be lost when it
208 empties (can only be set by IRCops, requires
209 permchannels module).
210 Q Only ulined servers and their users can kick
211 (requires nokicks module)
212 R Blocks unregistered users from joining (requires
213 services account module).
214 S Strips mIRC color codes from messages to the
215 channel (requires stripcolor module).
216 T Blocks /NOTICEs to the channel from users who are
217 not at least halfop (requires nonotice module).
219 g <mask> Blocks messages matching the given glob mask
220 (requires chanfilter module).
221 X <mode> Makes channel operators immune to the specified
222 restrictive mode (requires 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
238 f Allows receipt of flooding notices.
239 g Allows receipt of globops (requires globops module).
240 j Allows receipt of channel creation notices (requires
242 J Allows receipt of remote channel creation notices (requires
244 k Allows receipt of local kill messages.
245 K Allows receipt of remote kill messages.
246 l Allows receipt of local linking related
248 L Allows receipt of remote linking related
250 n See local nickname changes (requires seenicks module).
251 N See remote nickname changes (requires seenicks modules).
252 o Allows receipt of oper-up, oper-down, and oper-failure
254 O Allows receipt of remote oper-up, oper-down, and oper-failure
256 q Allows receipt of local quit messages.
257 Q Allows receipt of remote quit messages.
258 t Allows receipt of attempts to use /STATS (local and remote).
259 v Allows receipt of oper-override notices (requires 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 j:<channel> Matches anyone in the given channel. Does not support
280 wildcards (requires channelban module).
281 r:<realname> Matches users with a matching realname (requires gecosban
283 s:<server> Matches users on a matching server (requires serverban
285 z:<certfp> Matches users having the given SSL certificate
286 fingerprint (requires sslmodes module).
287 O:<opertype> Matches IRCops of a matching type, mostly useful as an
288 an invite exception (requires operchans module).
289 R:<account> Matches users logged into a matching account (requires
290 services account module).
294 c:<banmask> Blocks any messages that contain color codes from
295 matching users (requires blockcolor module).
296 m:<banmask> Blocks messages from matching users (requires muteban
297 module). Users with +v or above are not affected.
298 p:<banmask> Blocks part messages from matching users (requires
300 A:<banmask> Blocks invites by matching users even when +A is set
301 (requires allowinvite module).
302 B:<banmask> Blocks all capital or nearly all capital messages from
303 matching users (requires blockcaps module).
304 C:<banmask> Blocks CTCPs from matching users (requires noctcp
306 N:<banmask> Blocks nick changes from matching users (requires
308 Q:<banmask> Blocks kicks by matching users (requires nokicks
310 S:<banmask> Strips color/bold/underline from messages from matching
311 users (requires stripcolor module).
312 T:<banmask> Blocks notices from matching users (requires nonotice
314 U:<banmask> Blocks unregistered users matching the given banmask.
315 (requires services account).
317 A ban given to an Acting extban may either be a nick!user@host mask
318 (unless stated otherwise), matched against users as for a normal ban,
319 or a Matching extban.
321 There is an additional special type of extended ban, a redirect ban:
323 Redirect n!u@h#channel will redirect the banned user to #channel
324 when they try to join (requires banredirect module).">