5 <helpop_start line1=" InspIRCd help system"
6 line2=" --------------------"
8 line4="This system provides help for commands and modes."
9 line5="Specify your question or a command name as the"
10 line6="parameter for this command. If you are an oper"
11 line7="you must prefix your query with a ? symbol."
13 line9="/HELPOP COMMANDS - To see a list of user commands"
14 line10="/HELPOP COPER - To see a list of oper commands"
15 line11="/HELPOP UMODES - To see a list of user modes"
16 line12="/HELPOP CHMODES - To see a list of channel modes">
18 <helpop_nohelp line1="There is no help for the topic"
19 line2="You searched for. Please try again.">
21 <helpop_nohelpo line1="There is no help for the topic"
22 line2="You searched for. Please try again."
24 line4="Your Query has been forwarded to the IRCops">
30 <helpop_commands line1="User Commands"
32 line3="USER NICK QUIT VERSION PING"
33 line4="PONG ADMIN PRIVMSG INFO TIME"
34 line5="WHOIS NOTICE JOIN NAMES PART"
35 line6="KICK MODE TOPIC WHO MOTD"
36 line7="RULES OPER LIST LUSERS STATS"
37 line8="USERHOST AWAY ISON SUMMON USERS"
38 line9="INVITE PASS WHOWAS LINKS MAP"
39 line10="COMMANDS MODULES KNOCK SILENCE DEVOICE"
40 line11="REMOVE PARK UNPARK UNINVITE VHOST"
41 line12="WATCH USERIP">
43 <helpop_watch line1="/WATCH [C|S|+/-[NICK]]"
44 line2="Adds or deletes a user from the watch list. C clears the list"
45 line3="and S queries the status.">
47 <helpop_vhost line1="/VHOST [username] [password]"
48 line2="Authenticate for a vhost.">
50 <helpop_park line1="/PARK"
51 line2="Parks the nickname which issues the command. The session's"
52 line3="connection is closed, but the session remains as a ghost, to"
53 line4="be reclaimed later. When the user quits, they will be given a"
54 line5="key which is random.">
56 <helpop_unpark line1="/UNPARK [nickname] [key]"
57 line2="Unparks the nickname specified. The nickname must already"
58 line3="be previously parked, and the key must match the one for"
59 line4="this nickname.">
61 <helpop_kick line1="/REMOVE [channel] [nick] {[reason]}"
62 line2="Removes a user from a channel you specify. You must be"
63 line3="At least a channel halfoperator to remove a user."
64 line4="A removed user will part with a message stating they"
65 line5="were removed from the channel and by whom.">
67 <helpop_devoice line1="/DEVOICE [channel]"
68 line2="Devoices yourself from the specified channel.">
70 <helpop_silence line1="/SILENCE +/-[nick]"
71 line2="A serverside /ignore of the given nick. It does not follow"
72 line3="the users nick so if they change their nick you will recieve"
73 line4="their messages. /SILENCE without a parameter will list the nicks"
74 line5="that you have silenced.">
76 <helpop_knock line1="/KNOCK [channel]"
77 line2="Sends a notice to a channel indicating you wish to join.">
79 <helpop_user line1="/USER [ident] [local host] [remote host] :[GECOS]"
80 line2="This command is used by your client to register your irc session."
81 line3="You should not use it during an established connection.">
83 <helpop_nick line1="/NICK [new nick]"
84 line2="Change your nickname to [new nick].">
86 <helpop_quit line1="/QUIT [reason]"
87 line2="Quit from IRC and end your current session.">
89 <helpop_version line1="/VERSION"
90 line2="Returns the server's version number.">
92 <helpop_ping line1="/PING [server]"
93 line2="Ping a server. Target server will answer with a PONG.">
95 <helpop_pong line2="/PONG [server]"
96 line2="Your client should send this to answer server PINGs. You"
97 line3="should not issue this command manually.">
99 <helpop_admin line1="/ADMIN [server]"
100 line2="Fetches the administrative information on the given server.">
102 <helpop_privmsg line1="/MSG [target] [text]"
103 line2="Sends a message to a user or channel specified in [target].">
105 <helpop_notice line1="/NOTICE [target] [text]"
106 line2="Sends a notice to a user or channel specified in [target].">
108 <helpop_join line1="/JOIN [channel]{,[channel]} [key]{,[key]}"
109 line2="Joins one or more channels you provide the names for.">
111 <helpop_names line1="/NAMES [channel]{,[channel]}"
112 line2="Return a list of users on the channels you provide.">
114 <helpop_part line1="/PART [channel]{,[channel] [reason]}"
115 line2="Leaves one or more channels you specify.">
117 <helpop_kick line1="/KICK [channel] [nick] {[reason]}"
118 line2="Kicks a user from a channel you specify. You must be"
119 line3="At least a channel halfoperator to kick a user.">
121 <helpop_mode line1="/MODE [target] [+|-][modes]{[+|-][modes]} {mode parameters}"
122 line2="Sets the mode for a channel or a nickname specified in [target]"
123 line3="A user may only set modes upon themselves, and may not set the"
124 line4="+o usermode, and a user may only change channel modes of"
125 line5="channels where they are at least a halfoperator.">
127 <helpop_topic line1="/TOPIC [channel] {topic}"
128 line2="Sets or retrieves the channel topic. If a channel topic is"
129 line3="given in teh command and the channel is either not +t, or"
130 line4="You are at least a halfoperator, the channel topic will be"
131 line5="changed to the new one you provide.">
133 <helpop_who line1="/WHO [channel|nick|servermask|o 0]"
134 line2="Looks up the information of users matching the range you"
135 line3="provide. You may only /WHO nicknames in channels or on servers"
136 line4="where you share a common channel with them."
137 line5="The syntax '/WHO o 0' shows a list of online IRC operators.">
139 <helpop_motd line1="/MOTD [server]"
140 line2="Show the message of the day for [server]. Messages of the"
141 line3="day contain important server rules and notice and should be"
142 line4="read before using a server in any way!">
144 <helpop_rules line1="/RULES"
145 line2="Show the rules file for the local server. This is similar in"
146 line3="effect to /MOTD except that rules are optional. All users are"
147 line4="sent the MOTD when they connect without having to request it.">
149 <helpop_oper line1="/OPER [login] [password]"
150 line2="Attempts to authenticate a user as an IRC operator."
151 line3="Please be aware that both successful and unsucessful oper attempts"
152 line4="Are logged, and sent to online IRC operators.">
154 <helpop_list line1="/LIST [pattern]"
155 line2="Creates a list of all existing channels matching the glob pattern"
156 line3="[pattern], e.g. *chat* or bot*.">
158 <helpop_lusers line1="/LUSERS"
159 line2="Shows a count of local and remote users, servers and channels.">
161 <helpop_userhost line1="/USERHOST [nickname]"
162 line2="Returns the hostname and nickname of a user, and some other"
163 line3="miscellanious information.">
165 <helpop_userip line1="/USERIP [nickname]"
166 line2="Returns the ip and nickname of a user.">
168 <helpop_away line1="/AWAY {message}"
169 line2="If a message is given, marks you as being away, otherwise"
170 line3="removes your away status and previous message.">
172 <helpop_ison line1="/ISON [nick] {[nick]...}"
173 line2="Returns a subset of the nicks you give, showing only those"
174 line3="that are currently online.">
176 <helpop_summon line1="/SUMMON [user]"
177 line2="Summons a user from the shell where the ircd is running onto irc"
178 line3="This command is deprecated in the current protocol.">
180 <helpop_users line1="/USERS"
181 line2="Shows users logged into the shell where the ircd is running."
182 line3="This command is deprecated in the current protocol.">
184 <helpop_invite line1="/INVITE [nick] [channel]"
185 line2="Invites a user to a channel. If the channel is NOT +i, any"
186 line3="user, channel op or not, may invite any other user to the"
187 line4="channel, so long as they are a member of that channel."
188 line5="Otherwise, if +i is set only channel halfoperators"
189 line6="and above may invite users into the channel.">
191 <helpop_pass line1="/PASS [password]"
192 line2="This command is used by your irc client when setting up"
193 line3="your irc session, and should not be issued by a fully"
194 line4="connected client.">
196 <helpop_whowas line1="/WHOWAS [nick]"
197 line2="Returns a list of times the user was last seen on irc"
198 line3="along with the time they were last seen and their server.">
200 <helpop_links line1="/LINKS"
201 line2="Shows all servers linked to this one. Note that in this"
202 line3="server implementation all links will be flattened as"
203 line4="a tree based layout is not in use.">
205 <helpop_map line1="/MAP"
206 line2="Shows a graphical representation of all users and servers"
207 line3="on the network. The tree diagram is inaccurate in this"
208 line4="implementation as a tree based network is not in place.">
210 #####################
212 #####################
214 <helpop_coper line1="Oper Commands"
215 line2="-------------"
216 line3="DIE RESTART KILL REHASH TRACE"
217 line4="CONNECT SQUIT MODULES MKPASSWD SHUN"
218 line5="KLINE QLINE GLINE ELINE ZLINE"
219 line6="SAJOIN SAPART SAMODE SAQUIT SANICK"
220 line7="SETIDLE SETHOST SETNAME SETIDENT SWHOIS"
221 line8="OPERMOTD CHGHOST CHGNAME CHGIDENT CBAN"
222 line9="NICKLOCK NICKUNLOCK LOADMODULE UNLOADMODULE GLOBOPS"
223 line10="SPYLIST SPYNAMES GLOADMODULE GUNLOADMODULE MKSHA256"
224 line11="PARKSTATS FREEZE UNFREEZE OPERPERMS RCONNECT">
226 <helpop_rconnect line1="/RCONNECT [source mask] [target mask]"
227 line2="All servers matching [source mask] will try to connect to"
228 line3="the first server in the config file matching [target mask].">
230 <helpop_operperms line1="/OPERPERMS [nick]"
231 line2="List all commands an oper has access to use.">
233 <helpop_freeze line1="/FREEZE [nick]"
234 line2="Prevents the user from sending commands until they reconnect."
235 line3="User is also notified they have been frozen.">
237 <helpop_unfreeze line1="/UNFREEZE [nick]"
238 line2="Unfreezes a user frozen by the /FREEZE command.">
240 <helpop_parkstats line1="/PARKSTATS"
241 line2="Displays the park module's statistics">
243 <helpop_spylist line1="/SPYLIST"
244 line2="Operates the same as /LIST but includes +s and +p channels.">
246 <helpop_spynames line1="/SPYNAMES [channel]"
247 line2="Operates the same as /name but works on +s and +p channels.">
249 <helpop_globops line1="/GLOBOPS [message]"
250 line2="Sends a message to all +g users.">
252 <helpop_cban line1="/CBAN [channel] {[duration] :[reason]}"
253 line2="Sets or removes a channel ban. You must specify at least"
254 line3="3 parameters to add a ban, and one parameter to remove a ban."
255 line4="The duration may be specified in seconds, or in the following format"
256 line5="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
257 line6="5 minutes and 6 seconds. All fields in this format are optional.">
259 <helpop_sajoin line1="/SAJOIN [nick] [channel]"
260 line2="Forces the user to join the channel.">
262 <helpop_sapart line1="/SAPART [nick] [channel]"
263 line2="Forces the user to part the channel.">
265 <helpop_samode line1="/SAMODE [#chan/nick] +/-[modes] {[parameters for modes]}"
266 line2="Gives the channel or nick the modes specified.">
268 <helpop_sanick line1="/SANICK [nick] [new nick]"
269 line2="Changes the users nick to the new nick.">
271 <helpop_saquit line1="/SAQUIT [nick] [reason]"
272 line2="Forces user to quit with the specified reason.">
274 <helpop_setidle line1="/SETIDLE [idle time]"
275 line2="Sets your idle time (in seconds).">
277 <helpop_sethost line1="/SETHOST [host]"
278 line2="Sets your host to the specified host.">
280 <helpop_setident line1="/SETIDENT [ident]"
281 line2="Sets your ident to the specified ident.">
283 <helpop_setname line1="/SETNAME [name]"
284 line2="Sets your name to the specified name.">
286 <helpop_swhois line="/SWHOIS [nick] [swhois]"
287 line2="Sets the users swhois field to the given swhois.">
289 <helpop_mkpasswd line1="/MKPASSWD [plaintext]"
290 line2="Encodes the plaintext to an MD5 hash and displays the result.">
292 <helpop_mksha256 line1="/MKSHA256 [plaintext]"
293 line2="Encodes the plaintext to an SHA-256 hash and displays the result.">
295 <helpop_opermotd line1="/OPERMOTD"
296 line2="Re-displays the Oper MOTD.">
298 <helpop_nicklock line1="/NICKLOCK [nick] [new nick]"
299 line2="Changes user's nick to the new nick, and forces"
300 line3="it to remain as such for the remainder of the session.">
302 <helpop_nickunlock line1="/NICKUNLOCK [nick]"
303 line2="Allows the user to change nicks.">
305 <helpop_chghost line1="/CHGHOST [nickname] [new hostname]"
306 line2="Changes the hostname of the user to the new hostname>.">
308 <helpop_chgname line1="/CHGNAME [nickname] [new name]"
309 line2="Changes the name of the user to the new name>.">
311 <helpop_chgident line1="/CHGIDENT [nickname] [new ident]"
312 line2="Changes the ident of the user to the new ident.">
314 <helpop_shun line1="/SHUN [user@host] {[duration] :[reason]}"
315 line2="Sets or removes a shun (serverside ignore) on a host and ident mask."
316 line3="You must specify at least 3 parameters to add a shun, and one"
317 line4="parameter to remove a shun (just the user@host section)."
318 line5="The duration may be specified in seconds, or in the following format"
319 line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
320 line7="5 minutes and 6 seconds. All fields in this format are optional.">
322 <helpop_die line1="/DIE [password]"
323 line2="If the correct password is provided, and you are an operator,"
324 line3="This command will shut down the local server.">
326 <helpop_restart line1="/RESTART [password]"
327 line2="If the correct password is provided, and you are an operator,"
328 line3="This command will restart the local server.">
330 <helpop_commands line1="/COMMANDS"
331 line2="Shows all currently available commands.">
333 <helpop_kill line1="/KILL [user] [reason]"
334 line2="This command will disconnect a user from IRC with the given reason.">
336 <helpop_rehash line1="/REHASH"
337 line2="This command will cause the server configuration file to be"
338 line3="re-read and values re-initialised.">
340 <helpop_trace line1="/TRACE [nick|user@host|servermask]"
341 line2="This command will provide a list of all users and servers which"
342 line3="must be passed through or over to reach a given object (server or user).">
344 <helpop_connect line1="/CONNECT [servermask]"
345 line2="Create a mesh connection to the given servermask. You must have"
346 line3="configured the server for linking in your configuration file,"
347 line4="and provided a password.">
349 <helpop_squit line1="/SQUIT"
350 line2="Disconnects the local server from the mesh network, causing every"
351 line3="other server in the mesh to drop it.">
353 <helpop_modules line1="/MODULES"
354 line2="Lists currently loaded modules, their memory offsets and version"
355 line3="numbers and flags. If you are not an operator, you will see reduced"
358 <helpop_loadmodule line1="/LOADMODULE [filename.so]"
359 line2="Loads a module into the IRCd.">
361 <helpop_unloadmodule line1="/UNLOADMODULE [filename.so]"
362 line3="Unloads a module from the IRCd. The module cannot have the static"
363 line4="flag set (see the output of /MODULES).">
365 <helpop_gloadmodule line1="/GLOADMODULE [filename.so]"
366 line2="Globally loads a module into the network.">
368 <helpop_gunloadmodule line1="/GUNLOADMODULE [filename.so]"
369 line3="Globally unloads a module from the network. The module cannot "
370 line4="have the static flag set (see the output of /MODULES).">
372 <helpop_kline line1="/KLINE [user@host] {[duration] :[reason]}"
373 line2="Sets or removes a k-line (host based ban) on a host and ident mask."
374 line3="You must specify at least 3 parameters to add a ban, and one"
375 line4="parameter to remove a ban (just the user@host section)."
376 line5="The duration may be specified in seconds, or in the following format"
377 line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
378 line7="5 minutes and 6 seconds. All fields in this format are optional.">
380 <helpop_zline line1="/ZLINE [ipmask] {[duration] :[reason]}"
381 line2="Sets or removes a z-line (ip based ban) on an ip range mask."
382 line3="You must specify at least 3 parameters to add a ban, and one"
383 line4="parameter to remove a ban (just the user@host section)."
384 line5="The duration may be specified in seconds, or in the following format"
385 line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
386 line7="5 minutes and 6 seconds. All fields in this format are optional.">
388 <helpop_qline line1="/QLINE [nickmask] {[duration] :[reason]}"
389 line2="Sets or removes a q-line (nick based ban) on a nick mask."
390 line3="You must specify at least 3 parameters to add a ban, and one"
391 line4="parameter to remove a ban (just the user@host section)."
392 line5="The duration may be specified in seconds, or in the following format"
393 line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
394 line7="5 minutes and 6 seconds. All fields in this format are optional.">
396 <helpop_gline line1="/GLINE [user@host] {[duration] :[reason]}"
397 line2="Sets or removes a g-line (global host based ban) on host mask."
398 line3="You must specify at least 3 parameters to add a ban, and one"
399 line4="parameter to remove a ban (just the user@host section)."
400 line5="The duration may be specified in seconds, or in the following format"
401 line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
402 line7="5 minutes and 6 seconds. All fields in this format are optional.">
404 <helpop_eline line1="/ELINE [user@host] {[duration] :[reason]}"
405 line2="Sets or removes a e-line (local ban exception) on host mask."
406 line3="You must specify at least 3 parameters to add an exception, and one"
407 line4="parameter to remove an exception (just the user@host section)."
408 line5="The duration may be specified in seconds, or in the following format"
409 line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
410 line7="5 minutes and 6 seconds. All fields in this format are optional.">
412 ######################
413 # User/Channel Modes #
414 ######################
416 <helpop_umodes line1="User Modes"
418 line3="o Is an IRC operator"
419 line4="i Is invisible to /WHO"
420 line5="w Can receive wallops messages"
421 line6="s Can receive server notices"
422 line7="n [mask] Can recieve server notices specified by [mask]"
423 line8="x Cloaked hostname (requires cloaking module)"
424 line9="g Can receive globops (requires globops module)"
425 line10="h Will receive helpops notification (requires helpop module)"
426 line11="r Nickname is registered"
427 line12="R Only registered users can PRIVMSG this nickname"
429 line14="G Messages are censored to user"
430 line15="W Can see when a user uses WHOIS on them"
431 line16="S mIRC colour codes are stripped to the user"
432 line17="D User can not recieve PRIVMSGs">
434 <helpop_chmodes line1="Channel Modes"
435 line2="-------------"
436 line3="v [nickname] Gives voice to [nickname] (can talk on +m channel)"
437 line4="h [nickname] Gives halfops to [nickname]"
438 line5="o [nickname] Gives ops to [nickname]"
439 line6="b [hostmask] Bans [hostmask] on the channel"
440 line7="a [nickname] Give protected status to [nickname] (+q only)"
441 line8="q [nickname] Give founder status to [nickname] (ulines only)"
442 line9="i Make the channel invite only, must /INVITE users"
443 line10="k [key] Set the channel key (password) to [key]"
444 line11="l [limit] Set the maximum possible users to [limit]"
445 line12="m Enable moderation. Only +vo(h) can speak"
446 line13="n Only users who are members of the channel may message it"
447 line14="p Make channel private (hide from /LIST)"
448 line15="s Make channel secret (can't be used at the same time as +p)"
449 line16="O Channel is IRCops only (can only be set by IRCops)"
450 line17="t Only halfops and above can change the topic"
451 line18="Q Only U-Lined servers/nicks can kick"
452 line19="T Only halfops/ops can send NOTICEs to the channel"
453 line20="C No CTCPs allowed to the channel"
454 line21="c mIRC colour codes blocked on the channel"
455 line22="S mIRC colour codes are stripped from the channel"
456 line23="e [hostmask] Ban exception on [hostmask]"
457 line24="K No /KNOCK allowed to channel"
458 line25="L [channel] If the channel is full, redirect users to [channel]"
459 line26="N No nickchanges while on the channel"
460 line27="G Censors channel based on network censor config"
461 line28="g [word] All messages containing the word are blocked"
462 line29="I [hostmask] Invite exception allows user to join a channel with +i"
463 line30="j [joins]:[sec] Prevents join flooding"
464 line31="J [seconds] Prevents auto-rejoin on kick"
465 line32="f [*][lines]:[sec] Kick on text flood. With * user is banned"
466 line33="V No invites allowed"
467 line34="r Channel is registered"
468 line35="R Only registered users can join"
469 line36="M Non-registered users can't chat"
470 line37="z SSL clients only"
471 line38="x Join exception mask. Avoids +ibkO"
472 line39="-------------"
473 line40="NOTE: A large number of these modes are dependent upon server-side modules"
474 line41="being loaded by a server/network administrator. The actual modes available"
475 line42="on your network may be very different to this list. Please consult your"
476 line43="help channel if you have any questions.">
478 ######################
480 ######################
482 <helpop_stats line1="/STATS [symbol]"
483 line2="Shows various server statistics. Depending on configuration this"
484 line3="command may be reserved for oper-only use."
486 line5="Valid symbols are:"
488 line7="m Show command statistics, number of times commands have been used"
489 line8="z Show memory usage statistics"
490 line9="o Show a list of all valid oper usernames and hostmasks"
491 line10="l Show all inbound and outbound server and client connections"
492 line11="u Show server uptime"
493 line12="k Show k-lines (local bans)"
494 line13="g Show g-lines (global bans)"
495 line14="q Show q-lines (nick mask bans)"
496 line15="Z Show z-lines (ip mask bans)"
497 line16="Y Show connection classes"
498 line17="C Show link blocks"
499 line18="U Show u-lined servers"
500 line19="P Show online opers and their idle times"
501 line20="I Show connect class permissions"
502 line21="e Show e-lines (local ban exemptions)"
503 line22="C Show channel bans"
504 line22="s Show shuns"
506 line23="Note that all /STATS use is broadcast to online IRC operators.">