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
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
81 d Deaf mode. User will not receive any messages or notices
82 from channels they are in (requires deaf module).
83 g In combination with /ACCEPT, provides for server side
84 ignore (requires callerid module).
85 h Marks as 'available for help' in WHOIS (IRCop only,
86 requires 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 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 services account module).
97 w Receives wallops messages.
98 x Gives a cloaked hostname (requires cloaking module).
99 B Marks as a bot (requires botmode module).
100 G Censors messages sent to the user based on filters
101 configured for the network (requires censor module).
102 H Hides an oper's oper status from WHOIS (requires
104 I Hides a user's entire channel list in WHOIS from
105 non-IRCops (requires 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 services account module).
110 S Strips mIRC color/bold/underline codes out of private
111 messages to the user (requires stripcolor module).
112 W Receives notification when a user uses WHOIS on them
113 (IRCop only, requires 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
121 customprefix module).
122 o <nickname> Gives op status to <nickname>.
123 a <nickname> Gives protected status to <nickname>, preventing
124 them from them from being kicked (+q only,
125 requires customprefix module).
126 q <nickname> Gives owner status to <nickname>, preventing them
127 from being kicked (Services or only, requires
128 customprefix module).
130 b <hostmask> Bans <hostmask> from the channel.
131 e <hostmask> Excepts <hostmask> from bans (requires
132 banexception module).
133 I <hostmask> Excepts <hostmask> from +i, allowing matching
134 users to join while the channel is invite-only
135 (requires inviteexception module).
137 c Blocks messages containing mIRC color codes
138 (requires 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 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 messageflood module).
145 i Makes the channel invite-only.
146 Users can only join if an operator
147 uses /INVITE to invite them.
148 j <joins>:<sec> Limits joins to the specified rate (requires
150 k <key> Set the channel key (password) to <key>.
151 l <limit> Set the maximum allowed users to <limit>.
152 m Enable moderation. Only users with +v, +h, or +o
154 n Blocks users who are not members of the channel
156 p Make channel private, hiding it in users' whoises
157 and replacing it with * in /LIST.
158 r Marks the channel as registered with Services
159 (requires services account module).
160 s Make channel secret, hiding it in users' whoises
162 t Prevents users without +h or +o from changing the
164 u Makes the channel an auditorium; normal users only
165 see themselves or themselves and the operators,
166 while operators see all the users (requires
168 w <flag>:<banmask> Adds basic channel access controls of <flag> to
169 <banmask>, via the +w listmode.
170 For example, +w o:R:Brain will op anyone identified
171 to the account 'Brain' on join.
172 (requires autoop module)
173 z Blocks non-SSL clients from joining the channel.
175 A Allows anyone to invite users to the channel
176 (normally only chanops can invite, requires
178 B Blocks messages with too many capital letters,
179 as determined by the network configuration
180 (requires blockcaps module).
181 C Blocks any CTCPs to the channel (requires noctcp
183 D Delays join messages from users until they
184 message the channel (requires delayjoin module).
185 E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similar messages.
186 Kicks as default, blocks with ~ and bans with *
187 The last two parameters are optional.
188 F <changes>:<sec> Blocks nick changes when they equal or exceed the
189 specified rate (requires nickflood module).
190 G Censors messages to the channel based on the
191 network configuration (requires censor module).
192 H <num>:<duration> Displays the last <num> lines of chat to joining
193 users. <duration> is the maximum time to keep
194 lines in the history buffer (requires chanhistory
196 J <seconds> Prevents rejoin after kick for the specified
197 number of seconds. This prevents auto-rejoin
198 (requires kicknorejoin module).
199 K Blocks /KNOCK on the channel.
200 L <channel> If the channel reaches its limit set by +l,
201 redirect users to <channel> (requires redirect
203 M Blocks unregistered users from speaking (requires
204 services account module).
205 N Prevents users on the channel from changing nick
206 (requires nonicks module).
207 O Channel is IRCops only (can only be set by IRCops,
208 requires operchans module).
209 P Makes the channel permanent; Bans, invites, the
210 topic, modes, and such will not be lost when it
211 empties (can only be set by IRCops, requires
212 permchannels module).
213 Q Only ulined servers and their users can kick
214 (requires nokicks module)
215 R Blocks unregistered users from joining (requires
216 services account module).
217 S Strips mIRC color codes from messages to the
218 channel (requires stripcolor module).
219 T Blocks /NOTICEs to the channel from users who are
220 not at least halfop (requires nonotice module).
222 g <mask> Blocks messages matching the given glob mask
223 (requires chanfilter module).
224 X <mode> Makes channel operators immune to the specified
225 restrictive mode (requires 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 general (and sometimes random) debug
241 f Allows receipt of flooding notices.
242 g Allows receipt of globops (requires globops module).
243 j Allows receipt of channel creation notices (requires
245 J Allows receipt of remote channel creation notices (requires
247 k Allows receipt of local kill messages.
248 K Allows receipt of remote kill messages.
249 l Allows receipt of local linking related
251 L Allows receipt of remote linking related
253 n See local nickname changes (requires seenicks module).
254 N See remote nickname changes (requires seenicks modules).
255 o Allows receipt of oper-up, oper-down, and oper-failure
257 O Allows receipt of remote oper-up, oper-down, and oper-failure
259 q Allows receipt of local quit messages.
260 Q Allows receipt of remote quit messages.
261 t Allows receipt of attempts to use /STATS (local and remote).
262 v Allows receipt of oper-override notices (requires override module).
263 x Allows receipt of local Xline notices (g/Z/q/k/e/R/shuns).
264 X Allows receipt of remote Xline notices (g/Z/q/k/e/R/shuns).">
266 <helpop key="extbans" value="Extended Bans
269 Extbans are split into two types; matching extbans, which match on
270 users in additional ways, and acting extbans, which restrict users
271 in different ways to a standard ban.
273 To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
274 instead of a normal nick!user@host mask, to ban or exempt matching
275 users. Ban exceptions on acting extbans exempt that user from matching
276 an extban of that type, and from any channel mode corresponding to the
277 restriction. Matching extbans may also be used for invite exceptions by
282 j:<channel> Matches anyone in the given channel. Does not support
283 wildcards (requires channelban module).
284 r:<realname> Matches users with a matching realname (requires gecosban
286 s:<server> Matches users on a matching server (requires serverban
288 z:<certfp> Matches users having the given SSL certificate
289 fingerprint (requires sslmodes module).
290 O:<opertype> Matches IRCops of a matching type, mostly useful as an
291 an invite exception (requires operchans module).
292 R:<account> Matches users logged into a matching account (requires
293 services account module).
297 c:<banmask> Blocks any messages that contain color codes from
298 matching users (requires blockcolor module).
299 m:<banmask> Blocks messages from matching users (requires muteban
300 module). Users with +v or above are not affected.
301 p:<banmask> Blocks part messages from matching users (requires
303 A:<banmask> Blocks invites by matching users even when +A is set
304 (requires allowinvite module).
305 B:<banmask> Blocks all capital or nearly all capital messages from
306 matching users (requires blockcaps module).
307 C:<banmask> Blocks CTCPs from matching users (requires noctcp
309 N:<banmask> Blocks nick changes from matching users (requires
311 Q:<banmask> Blocks kicks by matching users (requires nokicks
313 S:<banmask> Strips color/bold/underline from messages from matching
314 users (requires stripcolor module).
315 T:<banmask> Blocks notices from matching users (requires nonotice
317 U:<banmask> Blocks unregistered users matching the given banmask.
318 (requires services account).
320 A ban given to an Acting extban may either be a nick!user@host mask
321 (unless stated otherwise), matched against users as for a normal ban,
322 or a Matching extban.
324 There is an additional special type of extended ban, a redirect ban:
326 Redirect n!u@h#channel will redirect the banned user to #channel
327 when they try to join (requires banredirect module).">