5 <helpop key="start" value="InspIRCd help system
7 This system provides help for commands and modes.
8 Specify your question or a command name as the
9 parameter for this command. If you are an oper
10 you must prefix your query with a ? symbol.
12 /HELPOP COMMANDS - To see a list of user commands
13 /HELPOP COPER - To see a list of oper commands
14 /HELPOP UMODES - To see a list of user modes
15 /HELPOP CHMODES - To see a list of channel modes">
17 <helpop key="nohelp" value="There is no help for the topic
18 you searched for. Please try again.">
24 <helpop key="commands" value="User Commands
26 USER NICK QUIT VERSION PING
27 PONG ADMIN PRIVMSG INFO TIME
28 WHOIS NOTICE JOIN NAMES PART
29 KICK MODE TOPIC WHO MOTD
30 RULES OPER LIST LUSERS STATS
31 USERHOST AWAY ISON SUMMON USERS
32 INVITE PASS WHOWAS LINKS MAP
33 COMMANDS MODULES KNOCK SILENCE DEVOICE
34 REMOVE UNINVITE VHOST WATCH USERIP">
36 <helpop key="watch" value="/WATCH [C|S|+/-[NICK]]
37 Adds or deletes a user from the watch list. C clears the list
38 and S queries the status.">
40 <helpop key="vhost" value="/VHOST [username] [password]
41 Authenticate for a vhost.">
43 <helpop key="kick" value="/REMOVE [channel] [nick] {[reason]}
44 Removes a user from a channel you specify. You must be
45 At least a channel halfoperator to remove a user.
46 A removed user will part with a message stating they
47 were removed from the channel and by whom.">
49 <helpop key="devoice" value="/DEVOICE [channel]
50 Devoices yourself from the specified channel.">
52 <helpop key="silence" value="/SILENCE +/-[nick]
53 A serverside /ignore of the given nick. It does not follow
54 the users nick so if they change their nick you will receive
55 their messages. /SILENCE without a parameter will list the nicks
56 that you have silenced.">
58 <helpop key="knock" value="/KNOCK [channel]
59 Sends a notice to a channel indicating you wish to join.">
61 <helpop key="user" value="/USER [ident] [local host] [remote host] :[GECOS]
62 This command is used by your client to register your irc session.
63 You should not use it during an established connection.">
65 <helpop key="nick" value="/NICK [new nick]
66 Change your nickname to [new nick].">
68 <helpop key="quit" value="/QUIT [reason]
69 Quit from IRC and end your current session.">
71 <helpop key="version" value="/VERSION
72 Returns the server's version number.">
74 <helpop key="ping" value="/PING [server]
75 Ping a server. Target server will answer with a PONG.">
77 <helpop key="pong" value="/PONG [server]
78 Your client should send this to answer server PINGs. You
79 should not issue this command manually.">
81 <helpop key="admin" value="/ADMIN [server]
82 Fetches the administrative information on the given server.">
84 <helpop key="privmsg" value="/MSG [target] [text]
85 Sends a message to a user or channel specified in [target].">
87 <helpop key="notice" value="/NOTICE [target] [text]
88 Sends a notice to a user or channel specified in [target].">
90 <helpop key="join" value="/JOIN [channel]{,[channel]} [key]{,[key]}
91 Joins one or more channels you provide the names for.">
93 <helpop key="names" value="/NAMES [channel]{,[channel]}
94 Return a list of users on the channels you provide.">
96 <helpop key="part" value="/PART [channel]{,[channel] [reason]}
97 Leaves one or more channels you specify.">
99 <helpop key="kick" value="/KICK [channel] [nick] {[reason]}
100 Kicks a user from a channel you specify. You must be
101 At least a channel halfoperator to kick a user.">
103 <helpop key="mode" value="/MODE [target] [+|-][modes]{[+|-][modes]} {mode parameters}
104 Sets the mode for a channel or a nickname specified in [target]
105 A user may only set modes upon themselves, and may not set the
106 +o usermode, and a user may only change channel modes of
107 channels where they are at least a halfoperator.">
109 <helpop key="topic" value="/TOPIC [channel] {topic}
110 Sets or retrieves the channel topic. If a channel topic is
111 given in the command and the channel is either not +t, or
112 You are at least a halfoperator, the channel topic will be
113 changed to the new one you provide.">
115 <helpop key="who" value="/WHO [channel|nick|servermask|o 0]
116 Looks up the information of users matching the range you
117 provide. You may only /WHO nicknames in channels or on servers
118 where you share a common channel with them.
119 The syntax '/WHO o 0' shows a list of online IRC operators.">
121 <helpop key="motd" value="/MOTD [server]
122 Show the message of the day for [server]. Messages of the
123 day contain important server rules and notice and should be
124 read before using a server in any way!">
126 <helpop key="rules" value="/RULES
127 Show the rules file for the local server. This is similar in
128 effect to /MOTD except that rules are optional. All users are
129 sent the MOTD when they connect without having to request it.">
131 <helpop key="oper" value="/OPER [login] [password]
132 Attempts to authenticate a user as an IRC operator.
133 Please be aware that both successful and unsuccessful oper attempts
134 Are logged, and sent to online IRC operators.">
136 <helpop key="list" value="/LIST [pattern]
137 Creates a list of all existing channels matching the glob pattern
138 [pattern], e.g. *chat* or bot*.">
140 <helpop key="lusers" value="/LUSERS
141 Shows a count of local and remote users, servers and channels.">
143 <helpop key="userhost" value="/USERHOST [nickname]
144 Returns the hostname and nickname of a user, and some other
145 miscellaneous information.">
147 <helpop key="userip" value="/USERIP [nickname]
148 Returns the ip and nickname of a user.">
150 <helpop key="away" value="/AWAY {message}
151 If a message is given, marks you as being away, otherwise
152 removes your away status and previous message.">
154 <helpop key="ison" value="/ISON [nick] {[nick]...}
155 Returns a subset of the nicks you give, showing only those
156 that are currently online.">
158 <helpop key="summon" value="/SUMMON [user]
159 Summons a user from the shell where the ircd is running onto irc
160 This command is deprecated in the current protocol.">
162 <helpop key="users" value="/USERS
163 Shows users logged into the shell where the ircd is running.
164 This command is deprecated in the current protocol.">
166 <helpop key="invite" value="/INVITE [nick] [channel]
167 Invites a user to a channel. If the channel is NOT +i, any
168 user, channel op or not, may invite any other user to the
169 channel, so long as they are a member of that channel.
170 Otherwise, if +i is set only channel halfoperators
171 and above may invite users into the channel.">
173 <helpop key="pass" value="/PASS [password]
174 This command is used by your irc client when setting up
175 your irc session, and should not be issued by a fully
178 <helpop key="whowas" value="/WHOWAS [nick]
179 Returns a list of times the user was last seen on irc
180 along with the time they were last seen and their server.">
182 <helpop key="links" value="/LINKS
183 Shows all servers linked to this one. Note that in this
184 server implementation all links will be flattened as
185 a tree based layout is not in use.">
187 <helpop key="map" value="/MAP
188 Shows a graphical representation of all users and servers
189 on the network. The tree diagram is inaccurate in this
190 implementation as a tree based network is not in place.">
192 #####################
194 #####################
196 <helpop key="coper" value="Oper Commands
198 DIE RESTART KILL REHASH TRACE
199 CONNECT SQUIT MODULES MKPASSWD SHUN
200 KLINE QLINE GLINE ELINE ZLINE
201 SAJOIN SAPART SAMODE SAQUIT SANICK
202 SETIDLE SETHOST SETNAME SETIDENT SWHOIS
203 OPERMOTD CHGHOST CHGNAME CHGIDENT CBAN
204 NICKLOCK NICKUNLOCK LOADMODULE UNLOADMODULE GLOBOPS
205 SPYLIST SPYNAMES GLOADMODULE GUNLOADMODULE MKSHA256
206 PARKSTATS FREEZE UNFREEZE OPERPERMS RCONNECT">
208 <helpop key="rconnect" value="/RCONNECT [source mask] [target mask]
209 All servers matching [source mask] will try to connect to
210 the first server in the config file matching [target mask].">
212 <helpop key="operperms" value="/OPERPERMS [nick]
213 List all commands an oper has access to use.">
215 <helpop key="freeze" value="/FREEZE [nick]
216 Prevents the user from sending commands until they reconnect.
217 User is also notified they have been frozen.">
219 <helpop key="unfreeze" value="/UNFREEZE [nick]
220 Unfreezes a user frozen by the /FREEZE command.">
222 <helpop key="parkstats" value="/PARKSTATS
223 Displays the park module's statistics">
225 <helpop key="spylist" value="/SPYLIST
226 Operates the same as /LIST but includes +s and +p channels.">
228 <helpop key="spynames" value="/SPYNAMES [channel]
229 Operates the same as /name but works on +s and +p channels.">
231 <helpop key="globops" value="/GLOBOPS [message]
232 Sends a message to all +g users.">
234 <helpop key="cban " value="/CBAN [channel] {[duration] :[reason]}
235 Sets or removes a channel ban. You must specify at least
236 3 parameters to add a ban, and one parameter to remove a ban.
237 The duration may be specified in seconds, or in the following format
238 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
239 5 minutes and 6 seconds. All fields in this format are optional.">
241 <helpop key="sajoin" value="/SAJOIN [nick] [channel]
242 Forces the user to join the channel.">
244 <helpop key="sapart" value="/SAPART [nick] [channel]
245 Forces the user to part the channel.">
247 <helpop key="samode" value="/SAMODE [#chan/nick] +/-[modes] {[parameters for modes]}
248 Gives the channel or nick the modes specified.">
250 <helpop key="sanick" value="/SANICK [nick] [new nick]
251 Changes the users nick to the new nick.">
253 <helpop key="saquit" value="/SAQUIT [nick] [reason]
254 Forces user to quit with the specified reason.">
256 <helpop key="setidle" value="/SETIDLE [idle time]
257 Sets your idle time (in seconds).">
259 <helpop key="sethost" value="/SETHOST [host]
260 Sets your host to the specified host.">
262 <helpop key="setident" value="/SETIDENT [ident]
263 Sets your ident to the specified ident.">
265 <helpop key="setname" value="/SETNAME [name]
266 Sets your name to the specified name.">
268 <helpop key="swhois" line="/SWHOIS [nick] [swhois]
269 Sets the users swhois field to the given swhois.">
271 <helpop key="mkpasswd" value="/MKPASSWD [plaintext]
272 Encodes the plaintext to an MD5 hash and displays the result.">
274 <helpop key="mksha256" value="/MKSHA256 [plaintext]
275 Encodes the plaintext to an SHA-256 hash and displays the result.">
277 <helpop key="opermotd" value="/OPERMOTD
278 Re-displays the Oper MOTD.">
280 <helpop key="nicklock" value="/NICKLOCK [nick] [new nick]
281 Changes user's nick to the new nick, and forces
282 it to remain as such for the remainder of the session.">
284 <helpop key="nickunlock" value="/NICKUNLOCK [nick]
285 Allows the user to change nicks.">
287 <helpop key="chghost" value="/CHGHOST [nickname] [new hostname]
288 Changes the hostname of the user to the new hostname.">
290 <helpop key="chgname" value="/CHGNAME [nickname] [new name]
291 Changes the name of the user to the new name.">
293 <helpop key="chgident" value="/CHGIDENT [nickname] [new ident]
294 Changes the ident of the user to the new ident.">
296 <helpop key="shun" value="/SHUN [user@host] {[duration] :[reason]}
297 Sets or removes a shun (serverside ignore) on a host and ident mask.
298 You must specify at least 3 parameters to add a shun, and one
299 parameter to remove a shun (just the user@host section).
300 The duration may be specified in seconds, or in the following format
301 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
302 5 minutes and 6 seconds. All fields in this format are optional.">
304 <helpop key="die" value="/DIE [password]
305 If the correct password is provided, and you are an operator,
306 This command will shut down the local server.">
308 <helpop key="restart" value="/RESTART [password]
309 If the correct password is provided, and you are an operator,
310 This command will restart the local server.">
312 <helpop key="commands" value="/COMMANDS
313 Shows all currently available commands.">
315 <helpop key="kill" value="/KILL [user] [reason]
316 This command will disconnect a user from IRC with the given reason.">
318 <helpop key="rehash" value="/REHASH
319 This command will cause the server configuration file to be
320 re-read and values re-initialized.">
322 <helpop key="trace" value="/TRACE [nick|user@host|servermask]
323 This command will provide a list of all users and servers which
324 must be passed through or over to reach a given object (server or user).">
326 <helpop key="connect" value="/CONNECT [servermask]
327 Create a mesh connection to the given servermask. You must have
328 configured the server for linking in your configuration file,
329 and provided a password.">
331 <helpop key="squit" value="/SQUIT
332 Disconnects the local server from the mesh network, causing every
333 other server in the network to drop it.">
335 <helpop key="modules" value="/MODULES
336 Lists currently loaded modules, their memory offsets and version
337 numbers and flags. If you are not an operator, you will see reduced
340 <helpop key="loadmodule" value="/LOADMODULE [filename.so]
341 Loads a module into the IRCd.">
343 <helpop key="unloadmodule" value="/UNLOADMODULE [filename.so]
344 Unloads a module from the IRCd. The module cannot have the static
345 flag set (see the output of /MODULES).">
347 <helpop key="gloadmodule" value="/GLOADMODULE [filename.so]
348 Globally loads a module into the network.">
350 <helpop key="gunloadmodule" value="/GUNLOADMODULE [filename.so]
351 Globally unloads a module from the network. The module cannot
352 have the static flag set (see the output of /MODULES).">
354 <helpop key="kline" value="/KLINE [user@host] {[duration] :[reason]}
355 Sets or removes a k-line (host based ban) on a host and ident mask.
356 You must specify at least 3 parameters to add a ban, and one
357 parameter to remove a ban (just the user@host section).
358 The duration may be specified in seconds, or in the following format
359 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
360 5 minutes and 6 seconds. All fields in this format are optional.">
362 <helpop key="zline" value="/ZLINE [ipmask] {[duration] :[reason]}
363 Sets or removes a z-line (ip based ban) on an ip range mask.
364 You must specify at least 3 parameters to add a ban, and one
365 parameter to remove a ban (just the user@host section).
366 The duration may be specified in seconds, or in the following format
367 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
368 5 minutes and 6 seconds. All fields in this format are optional.">
370 <helpop key="qline" value="/QLINE [nickmask] {[duration] :[reason]}
371 Sets or removes a q-line (nick based ban) on a nick mask.
372 You must specify at least 3 parameters to add a ban, and one
373 parameter to remove a ban (just the user@host section).
374 The duration may be specified in seconds, or in the following format
375 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
376 5 minutes and 6 seconds. All fields in this format are optional.">
378 <helpop key="gline" value="/GLINE [user@host] {[duration] :[reason]}
379 Sets or removes a g-line (global host based ban) on host mask.
380 You must specify at least 3 parameters to add a ban, and one
381 parameter to remove a ban (just the user@host section).
382 The duration may be specified in seconds, or in the following format
383 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
384 5 minutes and 6 seconds. All fields in this format are optional.">
386 <helpop key="eline" value="/ELINE [user@host] {[duration] :[reason]}
387 Sets or removes a e-line (local ban exception) on host mask.
388 You must specify at least 3 parameters to add an exception, and one
389 parameter to remove an exception (just the user@host section).
390 The duration may be specified in seconds, or in the following format
391 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
392 5 minutes and 6 seconds. All fields in this format are optional.">
394 ######################
395 # User/Channel Modes #
396 ######################
398 <helpop key="umodes" value="User Modes
401 i Is invisible to /WHO
402 w Can receive wallops messages
403 s Can receive server notices
404 n [mask] Can receive server notices specified by [mask]
405 x Cloaked hostname (requires cloaking module)
406 g Can receive globops (requires globops module)
407 h Will receive helpops notification (requires helpop module)
408 r Nickname is registered
409 R Only registered users can PRIVMSG this nickname
411 G Messages are censored to user
412 W Can see when a user uses WHOIS on them
413 S mIRC colour codes are stripped to the user
414 D User can not receive PRIVMSGs">
416 <helpop key="chmodes" value="Channel Modes
418 v [nickname] Gives voice to [nickname] (can talk on +m channel)
419 h [nickname] Gives halfops to [nickname]
420 o [nickname] Gives ops to [nickname]
421 b [hostmask] Bans [hostmask] on the channel
422 a [nickname] Give protected status to [nickname] (+q only)
423 q [nickname] Give founder status to [nickname] (ulines only)
424 i Make the channel invite only, must /INVITE users
425 k [key] Set the channel key (password) to [key]
426 l [limit] Set the maximum possible users to [limit]
427 m Enable moderation. Only +vo(h) can speak
428 n Only users who are members of the channel may message it
429 p Make channel private (hide from /LIST)
430 s Make channel secret (can't be used at the same time as +p)
431 O Channel is IRCops only (can only be set by IRCops)
432 t Only halfops and above can change the topic
433 Q Only U-Lined servers/nicks can kick
434 T Only halfops/ops can send NOTICEs to the channel
435 C No CTCPs allowed to the channel
436 c mIRC colour codes blocked on the channel
437 S mIRC colour codes are stripped from the channel
438 e [hostmask] Ban exception on [hostmask]
439 K No /KNOCK allowed to channel
440 L [channel] If the channel is full, redirect users to [channel]
441 N No nick changes while on the channel
442 G Censors channel based on network censor config
443 g [word] All messages containing the word are blocked
444 I [hostmask] Invite exception allows user to join a channel with +i
445 j [joins]:[sec] Prevents join flooding
446 J [seconds] Prevents auto-rejoin on kick
447 f [*][lines]:[sec] Kick on text flood. With * user is banned
449 r Channel is registered
450 R Only registered users can join
451 M Non-registered users can't chat
453 x Join exception mask. Avoids +ibkO
455 NOTE: A large number of these modes are dependent upon server-side modules
456 being loaded by a server/network administrator. The actual modes available
457 on your network may be very different to this list. Please consult your
458 help channel if you have any questions.">
460 ######################
462 ######################
464 <helpop key="stats" value="/STATS [symbol]
465 Shows various server statistics. Depending on configuration this
466 command may be reserved for oper-only use.
470 m Show command statistics, number of times commands have been used
471 z Show memory usage statistics
472 o Show a list of all valid oper usernames and hostmasks
473 l Show all inbound and outbound server and client connections
475 k Show k-lines (local bans)
476 g Show g-lines (global bans)
477 q Show q-lines (nick mask bans)
478 Z Show z-lines (ip mask bans)
479 Y Show connection classes
481 U Show u-lined servers
482 P Show online opers and their idle times
483 I Show connect class permissions
484 e Show e-lines (local ban exemptions)
488 Note that all /STATS use is broadcast to online IRC operators.">