5 <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 <nohelp line1="There is no help for the topic"
19 line2="You searched for. Please try again.">
21 <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 <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 <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 <vhost line1="/VHOST [username] [password]"
48 line2="Authenticate for a vhost.">
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 <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.">
63 <kick line1="/REMOVE [channel] [nick] {[reason]}"
64 line2="Removes a user from a channel you specify. You must be"
65 line3="At least a channel halfoperator to remove a user."
66 line4="A removed user will part with a message stating they"
67 line5="were removed from the channel and by whom.">
69 <devoice line1="/DEVOICE [channel]"
70 line2="Devoices yourself from the specified channel.">
72 <silence line1="/SILENCE +/-[nick]"
73 line2="A serverside /ignore of the given nick. It does not follow"
74 line3="the users nick so if they change their nick you will recieve"
75 line4="their messages. /SILENCE without a parameter will list the nicks"
76 line5="that you have silenced.">
78 <knock line1="/KNOCK [channel]"
79 line2="Sends a notice to a channel indicating you wish to join.">
81 <user line1="/USER [ident] [local host] [remote host] :[GECOS]"
82 line2="This command is used by your client to register your irc session."
83 line3="You should not use it during an established connection.">
85 <nick line1="/NICK [new nick]"
86 line2="Change your nickname to [new nick].">
88 <quit line1="/QUIT [reason]"
89 line2="Quit from IRC and end your current session.">
91 <version line1="/VERSION"
92 line2="Returns the server's version number.">
94 <ping line1="/PING [server]"
95 line2="Ping a server. Target server will answer with a PONG.">
97 <pong line2="/PONG [server]"
98 line2="Your client should send this to answer server PINGs. You"
99 line3="should not issue this command manually.">
101 <admin line1="/ADMIN [server]"
102 line2="Fetches the administrative information on the given server.">
104 <privmsg line1="/MSG [target] [text]"
105 line2="Sends a message to a user or channel specified in [target].">
107 <notice line1="/NOTICE [target] [text]"
108 line2="Sends a notice to a user or channel specified in [target].">
110 <join line1="/JOIN [channel]{,[channel]} [key]{,[key]}"
111 line2="Joins one or more channels you provide the names for.">
113 <names line1="/NAMES [channel]{,[channel]}"
114 line2="Return a list of users on the channels you provide.">
116 <part line1="/PART [channel]{,[channel] [reason]}"
117 line2="Leaves one or more channels you specify.">
119 <kick line1="/KICK [channel] [nick] {[reason]}"
120 line2="Kicks a user from a channel you specify. You must be"
121 line3="At least a channel halfoperator to kick a user.">
123 <mode line1="/MODE [target] [+|-][modes]{[+|-][modes]} {mode parameters}"
124 line2="Sets the mode for a channel or a nickname specified in [target]"
125 line3="A user may only set modes upon themselves, and may not set the"
126 line4="+o usermode, and a user may only change channel modes of"
127 line5="channels where they are at least a halfoperator.">
129 <topic line1="/TOPIC [channel] {topic}"
130 line2="Sets or retrieves the channel topic. If a channel topic is"
131 line3="given in teh command and the channel is either not +t, or"
132 line4="You are at least a halfoperator, the channel topic will be"
133 line5="changed to the new one you provide.">
135 <who line1="/WHO [channel|nick|servermask|o 0]"
136 line2="Looks up the information of users matching the range you"
137 line3="provide. You may only /WHO nicknames in channels or on servers"
138 line4="where you share a common channel with them."
139 line5="The syntax '/WHO o 0' shows a list of online IRC operators.">
141 <motd line1="/MOTD [server]"
142 line2="Show the message of the day for [server]. Messages of the"
143 line3="day contain important server rules and notice and should be"
144 line4="read before using a server in any way!">
146 <rules line1="/RULES"
147 line2="Show the rules file for the local server. This is similar in"
148 line3="effect to /MOTD except that rules are optional. All users are"
149 line4="sent the MOTD when they connect without having to request it.">
151 <oper line1="/OPER [login] [password]"
152 line2="Attempts to authenticate a user as an IRC operator."
153 line3="Please be aware that both successful and unsucessful oper attempts"
154 line4="Are logged, and sent to online IRC operators.">
156 <list line1="/LIST [pattern]"
157 line2="Creates a list of all existing channels matching the glob pattern"
158 line3="[pattern], e.g. *chat* or bot*.">
160 <lusers line1="/LUSERS"
161 line2="Shows a count of local and remote users, servers and channels.">
163 <userhost line1="/USERHOST [nickname]"
164 line2="Returns the hostname and nickname of a user, and some other"
165 line3="miscellanious information.">
167 <userip line1="/USERIP [nickname]"
168 line2="Returns the ip and nickname of a user."
170 <away line1="/AWAY {message}"
171 line2="If a message is given, marks you as being away, otherwise"
172 line3="removes your away status and previous message.">
174 <ison line1="/ISON [nick] {[nick]...}"
175 line2="Returns a subset of the nicks you give, showing only those"
176 line3="that are currently online.">
178 <summon line1="/SUMMON [user]"
179 line2="Summons a user from the shell where the ircd is running onto irc"
180 line3="This command is deprecated in the current protocol.">
182 <users line1="/USERS"
183 line2="Shows users logged into the shell where the ircd is running."
184 line3="This command is deprecated in the current protocol.">
186 <invite line1="/INVITE [nick] [channel]"
187 line2="Invites a user to a channel. If the channel is NOT +i, any"
188 line3="user, channel op or not, may invite any other user to the"
189 line4="channel, so long as they are a member of that channel."
190 line5="Otherwise, if +i is set only channel halfoperators"
191 line6="and above may invite users into the channel.">
193 <pass line1="/PASS [password]"
194 line2="This command is used by your irc client when setting up"
195 line3="your irc session, and should not be issued by a fully"
196 line4="connected client.">
198 <whowas line1="/WHOWAS [nick]"
199 line2="Returns a list of times the user was last seen on irc"
200 line3="along with the time they were last seen and their server.">
202 <links line1="/LINKS"
203 line2="Shows all servers linked to this one. Note that in this"
204 line3="server implementation all links will be flattened as"
205 line4="a tree based layout is not in use.">
208 line2="Shows a graphical representation of all users and servers"
209 line3="on the network. The tree diagram is inaccurate in this"
210 line4="implementation as a tree based network is not in place.">
212 #####################
214 #####################
216 <coper line1="Oper Commands"
217 line2="-------------"
218 line3="DIE RESTART KILL REHASH TRACE"
219 line4="CONNECT SQUIT MODULES MKPASSWD SHUN"
220 line5="KLINE QLINE GLINE ELINE ZLINE"
221 line6="SAJOIN SAPART SAMODE SAQUIT SANICK"
222 line7="SETIDLE SETHOST SETNAME SETIDENT SWHOIS"
223 line8="OPERMOTD CHGHOST CHGNAME CHGIDENT CBAN"
224 line9="NICKLOCK NICKUNLOCK LOADMODULE UNLOADMODULE GLOBOPS"
225 line10="SPYLIST SPYNAMES GLOADMODULE GUNLOADMODULE MKSHA256"
226 line11="PARKSTATS FREEZE UNFREEZE OPERPERMS RCONNECT">
228 <rconnect line1="/RCONNECT [source mask] [target mask]"
229 line2="All servers matching [source mask] will try to connect to"
230 line3="the first server in the config file matching [target mask].">
232 <operperms line1="/OPERPERMS [nick]"
233 line2="List all commands an oper has access to use.">
235 <freeze line1="/FREEZE [nick]"
236 line2="Prevents the user from sending commands until they reconnect."
237 line3="User is also notified they have been frozen.">
239 <unfreeze line1="/UNFREEZE [nick]"
240 line2="Unfreezes a user frozen by the /FREEZE command.">
242 <parkstats line1="/PARKSTATS"
243 line2="Displays the park module's statistics">
245 <spylist line1="/SPYLIST"
246 line2="Operates the same as /LIST but includes +s and +p channels.">
248 <spynames line1="/SPYNAMES [channel]"
249 line2="Operates the same as /name but works on +s and +p channels.">
251 <globops line1="/GLOBOPS [message]"
252 line2="Sends a message to all +g users.">
254 <cban line1="/CBAN [channel] {[duration] :[reason]}"
255 line2="Sets or removes a channel ban. You must specify at least"
256 line3="3 parameters to add a ban, and one parameter to remove a ban."
257 line4="The duration may be specified in seconds, or in the following format"
258 line5="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
259 line6="5 minutes and 6 seconds. All fields in this format are optional.">
261 <sajoin line1="/SAJOIN [nick] [channel]"
262 line2="Forces the user to join the channel.">
264 <sapart line1="/SAPART [nick] [channel]"
265 line2="Forces the user to part the channel.">
267 <samode line1="/SAMODE [#chan/nick] +/-[modes] {[parameters for modes]}"
268 line2="Gives the channel or nick the modes specified.">
270 <sanick line1="/SANICK [nick] [new nick]"
271 line2="Changes the users nick to the new nick.">
273 <saquit line1="/SAQUIT [nick] [reason]"
274 line2="Forces user to quit with the specified reason.">
276 <setidle line1="/SETIDLE [idle time]"
277 line2="Sets your idle time (in seconds).">
279 <sethost line1="/SETHOST [host]"
280 line2="Sets your host to the specified host.">
282 <setident line1="/SETIDENT [ident]"
283 line2="Sets your ident to the specified ident.">
285 <setname line1="/SETNAME [name]"
286 line2="Sets your name to the specified name.">
288 <swhois line="/SWHOIS [nick] [swhois]"
289 line2="Sets the users swhois field to the given swhois.">
291 <mkpasswd line1="/MKPASSWD [plaintext]"
292 line2="Encodes the plaintext to an MD5 hash and displays the result.">
294 <mksha256 line1="/MKSHA256 [plaintext]"
295 line2="Encodes the plaintext to an SHA-256 hash and displays the result.">
297 <opermotd line1="/OPERMOTD"
298 line2="Re-displays the Oper MOTD.">
300 <nicklock line1="/NICKLOCK [nick] [new nick]"
301 line2="Changes user's nick to the new nick, and forces
302 line3="it to remain as such for the remainder of the session.">
304 <nickunlock line1=/NICKUNLOCK [nick]"
305 line2="Allows the user to change nicks.">
307 <chghost line1=/CHGHOST [nickname] [new hostname]"
308 line2="Changes the hostname of the user to the new hostname>.">
310 <chgname line1=/CHGNAME [nickname] [new name]"
311 line2="Changes the name of the user to the new name>.">
313 <chgident line1=/CHGIDENT [nickname] [new ident]"
314 line2="Changes the ident of the user to the new ident.">
316 <shun line1="/SHUN [user@host] {[duration] :[reason]}"
317 line2="Sets or removes a shun (serverside ignore) on a host and ident mask."
318 line3="You must specify at least 3 parameters to add a shun, and one"
319 line4="parameter to remove a shun (just the user@host section)."
320 line5="The duration may be specified in seconds, or in the following format"
321 line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
322 line7="5 minutes and 6 seconds. All fields in this format are optional.">
324 <die line1="/DIE [password]"
325 line2="If the correct password is provided, and you are an operator,"
326 line3="This command will shut down the local server.">
328 <restart line1="/RESTART [password]"
329 line2="If the correct password is provided, and you are an operator,"
330 line3="This command will restart the local server.">
332 <commands line1="/COMMANDS"
333 line2="Shows all currently available commands.">
335 <kill line1="/KILL [user] [reason]"
336 line2="This command will disconnect a user from IRC with the given reason.">
338 <rehash line1="/REHASH"
339 line2="This command will cause the server configuration file to be"
340 line3="re-read and values re-initialised.">
342 <trace line1="/TRACE [nick|user@host|servermask]"
343 line2="This command will provide a list of all users and servers which"
344 line3="must be passed through or over to reach a given object (server or user).">
346 <connect line1="/CONNECT [servermask]"
347 line2="Create a mesh connection to the given servermask. You must have"
348 line3="configured the server for linking in your configuration file,"
349 line4="and provided a password.">
351 <squit line1="/SQUIT"
352 line2="Disconnects the local server from the mesh network, causing every"
353 line3="other server in the mesh to drop it.">
355 <modules line1="/MODULES"
356 line2="Lists currently loaded modules, their memory offsets and version"
357 line3="numbers and flags. If you are not an operator, you will see reduced"
360 <loadmodule line1="/LOADMODULE [filename.so]"
361 line2="Loads a module into the IRCd.">
363 <unloadmodule line1="/UNLOADMODULE [filename.so]"
364 line3="Unloads a module from the IRCd. The module cannot have the static"
365 line4="flag set (see the output of /MODULES).">
367 <gloadmodule line1="/GLOADMODULE [filename.so]"
368 line2="Globally loads a module into the network.">
370 <gunloadmodule line1="/GUNLOADMODULE [filename.so]"
371 line3="Globally unloads a module from the network. The module cannot "
372 line4="have the static flag set (see the output of /MODULES).">
374 <kline line1="/KLINE [user@host] {[duration] :[reason]}"
375 line2="Sets or removes a k-line (host based ban) on a host and ident mask."
376 line3="You must specify at least 3 parameters to add a ban, and one"
377 line4="parameter to remove a ban (just the user@host section)."
378 line5="The duration may be specified in seconds, or in the following format"
379 line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
380 line7="5 minutes and 6 seconds. All fields in this format are optional.">
382 <zline line1="/ZLINE [ipmask] {[duration] :[reason]}"
383 line2="Sets or removes a z-line (ip based ban) on an ip range mask."
384 line3="You must specify at least 3 parameters to add a ban, and one"
385 line4="parameter to remove a ban (just the user@host section)."
386 line5="The duration may be specified in seconds, or in the following format"
387 line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
388 line7="5 minutes and 6 seconds. All fields in this format are optional.">
390 <qline line1="/QLINE [nickmask] {[duration] :[reason]}"
391 line2="Sets or removes a q-line (nick based ban) on a nick mask."
392 line3="You must specify at least 3 parameters to add a ban, and one"
393 line4="parameter to remove a ban (just the user@host section)."
394 line5="The duration may be specified in seconds, or in the following format"
395 line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
396 line7="5 minutes and 6 seconds. All fields in this format are optional.">
398 <gline line1="/GLINE [user@host] {[duration] :[reason]}"
399 line2="Sets or removes a g-line (global host based ban) on host mask."
400 line3="You must specify at least 3 parameters to add a ban, and one"
401 line4="parameter to remove a ban (just the user@host section)."
402 line5="The duration may be specified in seconds, or in the following format"
403 line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
404 line7="5 minutes and 6 seconds. All fields in this format are optional.">
406 <eline line1="/ELINE [user@host] {[duration] :[reason]}"
407 line2="Sets or removes a e-line (local ban exception) on host mask."
408 line3="You must specify at least 3 parameters to add an exception, and one"
409 line4="parameter to remove an exception (just the user@host section)."
410 line5="The duration may be specified in seconds, or in the following format"
411 line6="1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,"
412 line7="5 minutes and 6 seconds. All fields in this format are optional.">
414 ######################
415 # User/Channel Modes #
416 ######################
418 <umodes line1="User Modes"
420 line3="o Is an IRC operator"
421 line4="i Is invisible to /WHO"
422 line5="w Can receive wallops messages"
423 line6="s Can receive server notices"
424 line7="x Cloaked hostname (requires cloaking module)"
425 line8="g Can receive globops (requires globops module)"
426 line9="h Will receive helpops notification (requires helpop module)"
427 line10="r Nickname is registered"
428 line11="R Only registered users can PRIVMSG this nickname"
430 line13="G Messages are censored to user"
431 line14="W Can see when a user uses WHOIS on them"
432 line15="S mIRC colour codes are stripped to the user"
433 line16="D User can not recieve PRIVMSGs">
435 <chmodes line1="Channel Modes"
436 line2="-------------"
437 line3="v [nickname] Gives voice to [nickname] (can talk on +m channel)"
438 line4="h [nickname] Gives halfops to [nickname]"
439 line5="o [nickname] Gives ops to [nickname]"
440 line6="b [hostmask] Bans [hostmask] on the channel"
441 line7="a [nickname] Give protected status to [nickname] (+q only)"
442 line8="q [nickname] Give founder status to [nickname] (ulines only)"
443 line9="i Make the channel invite only, must /INVITE users"
444 line10="k [key] Set the channel key (password) to [key]"
445 line11="l [limit] Set the maximum possible users to [limit]"
446 line12="m Enable moderation. Only +vo(h) can speak"
447 line13="n Only users who are members of the channel may message it"
448 line14="p Make channel private (hide from /LIST)"
449 line15="s Make channel secret (can't be used at the same time as +p)"
450 line16="O Channel is IRCops only (can only be set by IRCops)"
451 line17="t Only halfops and above can change the topic"
452 line18="Q Only U-Lined servers/nicks can kick"
453 line19="T Only halfops/ops can send NOTICEs to the channel"
454 line20="C No CTCPs allowed to the channel"
455 line21="c mIRC colour codes blocked on the channel"
456 line22="S mIRC colour codes are stripped from the channel"
457 line23="e [hostmask] Ban exception on [hostmask]"
458 line24="K No /KNOCK allowed to channel"
459 line25="L [channel] If the channel is full, redirect users to [channel]"
460 line26="N No nickchanges while on the channel"
461 line27="G Censors channel based on network censor config"
462 line28="g [word] All messages containing the word are blocked"
463 line29="I [hostmask] Invite exception allows user to join a channel with +i"
464 line30="j [joins]:[sec] Prevents join flooding"
465 line31="J [seconds] Prevents auto-rejoin on kick"
466 line32="f [*][lines]:[sec] Kick on text flood. With * user is banned"
467 line33="V No invites allowed"
468 line34="r Channel is registered"
469 line35="R Only registered users can join"
470 line36="M Non-registered users can't chat"
471 line37="z SSL clients only"
472 line38="x Join exception mask. Avoids +ibkO
473 line39="-------------"
474 line40="NOTE: A large number of these modes are dependent upon server-side modules"
475 line41="being loaded by a server/network administrator. The actual modes available"
476 line42="on your network may be very different to this list. Please consult your"
477 line43="help channel if you have any questions.">
479 ######################
481 ######################
483 <stats line1="/STATS [symbol]"
484 line2="Shows various server statistics. Depending on configuration this"
485 line3="command may be reserved for oper-only use."
487 line5="Valid symbols are:"
489 line7="m Show command statistics, number of times commands have been used"
490 line8="z Show memory usage statistics"
491 line9="o Show a list of all valid oper usernames and hostmasks"
492 line10="l Show all inbound and outbound server and client connections"
493 line11="u Show server uptime"
494 line12="k Show k-lines (local bans)"
495 line13="g Show g-lines (global bans)"
496 line14="q Show q-lines (nick mask bans)"
497 line15="Z Show z-lines (ip mask bans)"
498 line16="Y Show connection classes"
499 line17="C Show link blocks"
500 line18="U Show u-lined servers"
501 line19="P Show online opers and their idle times"
502 line20="I Show connect class permissions"
503 line21="e Show e-lines (local ban exemptions)"
504 line22="C Show channel bans"
505 line22="s Show shuns"
507 line23="Note that all /STATS use is broadcast to online IRC operators.">