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 INVITE PASS
32 WHOWAS LINKS MAP COMMANDS MODULES
33 KNOCK SILENCE DEVOICE REMOVE UNINVITE
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 [+/-]<hostmask> [p|c|i|n|t|a|x]
53 p Block private messages
54 c Block channel messages
56 n Block private notices
57 t Block channel notices
58 a Block all of the above
60 A serverside /ignore of the given hostmask.
61 /SILENCE without a parameter will list the hostmasks that you have silenced.">
63 <helpop key="knock" value="/KNOCK [channel]
64 Sends a notice to a channel indicating you wish to join.">
66 <helpop key="user" value="/USER [ident] [local host] [remote host] :[GECOS]
67 This command is used by your client to register your irc session.
68 You should not use it during an established connection.">
70 <helpop key="nick" value="/NICK [new nick]
71 Change your nickname to [new nick].">
73 <helpop key="quit" value="/QUIT [reason]
74 Quit from IRC and end your current session.">
76 <helpop key="version" value="/VERSION
77 Returns the server's version number.">
79 <helpop key="ping" value="/PING [server]
80 Ping a server. Target server will answer with a PONG.">
82 <helpop key="pong" value="/PONG [server]
83 Your client should send this to answer server PINGs. You
84 should not issue this command manually.">
86 <helpop key="admin" value="/ADMIN [server]
87 Fetches the administrative information on the given server.">
89 <helpop key="privmsg" value="/MSG [target] [text]
90 Sends a message to a user or channel specified in [target].">
92 <helpop key="notice" value="/NOTICE [target] [text]
93 Sends a notice to a user or channel specified in [target].">
95 <helpop key="join" value="/JOIN [channel]{,[channel]} [key]{,[key]}
96 Joins one or more channels you provide the names for.">
98 <helpop key="names" value="/NAMES [channel]{,[channel]}
99 Return a list of users on the channels you provide.">
101 <helpop key="part" value="/PART [channel]{,[channel] [reason]}
102 Leaves one or more channels you specify.">
104 <helpop key="kick" value="/KICK [channel] [nick] {[reason]}
105 Kicks a user from a channel you specify. You must be
106 At least a channel halfoperator to kick a user.">
108 <helpop key="mode" value="/MODE [target] [+|-][modes]{[+|-][modes]} {mode parameters}
109 Sets the mode for a channel or a nickname specified in [target]
110 A user may only set modes upon themselves, and may not set the
111 +o usermode, and a user may only change channel modes of
112 channels where they are at least a halfoperator.">
114 <helpop key="topic" value="/TOPIC [channel] {topic}
115 Sets or retrieves the channel topic. If a channel topic is
116 given in the command and the channel is either not +t, or
117 You are at least a halfoperator, the channel topic will be
118 changed to the new one you provide.">
120 <helpop key="who" value="/WHO [ [search-pattern] [ohurmaiMplf] ]
121 Looks up the information of users matching the range you provide.
122 You may only /WHO nicknames in channels or on servers where you
123 share a common channel with them, or ones which are not +i (unless
124 you are an IRC operator). The search-pattern may be a special
125 sequence of characters determined by the flags given below, or
126 it may be one of a nickname, a channel, a hostmask, an ip address
127 mask or a server mask.
131 The following flags after the mask have the following affects:
133 o Show online IRC operators matching the mask
134 u Unlimit the results past the maximum /who results value
136 r Show all users whose realnames match the mask. When this
137 flag is set it overrides the meaning of the search-pattern,
138 which must contain a glob pattern intended to match GECOS
140 h Show real hostnames rather than masked hostnames (IRC
142 m Search for all users with a given set of user modes. When
143 this flag is set it overrides the meaning of the
144 search-pattern, which must contain the mode sequence to
145 search for, for example to find all users with +i and
146 without +s, issue the command WHO +i-s m.
147 a Show all users who have an away message matching the given mask
148 p Show all users who are connected on the given port number
149 i Show all users who have an ident (username) matching the given mask
150 M Show all users who have metadata attached to them with
152 l Show only local users
153 f Show only remote (far) users
155 You may combine multiple flags in one WHO command except where stated in the table above.">
157 <helpop key="motd" value="/MOTD [server]
158 Show the message of the day for [server]. Messages of the
159 day contain important server rules and notice and should be
160 read before using a server in any way!">
162 <helpop key="rules" value="/RULES
163 Show the rules file for the local server. This is similar in
164 effect to /MOTD except that rules are optional. All users are
165 sent the MOTD when they connect without having to request it.">
167 <helpop key="oper" value="/OPER [login] [password]
168 Attempts to authenticate a user as an IRC operator.
169 Please be aware that both successful and unsuccessful oper attempts
170 Are logged, and sent to online IRC operators.">
172 <helpop key="list" value="/LIST [pattern]
173 Creates a list of all existing channels matching the glob pattern
174 [pattern], e.g. *chat* or bot*.">
176 <helpop key="lusers" value="/LUSERS
177 Shows a count of local and remote users, servers and channels.">
179 <helpop key="userhost" value="/USERHOST [nickname]
180 Returns the hostname and nickname of a user, and some other
181 miscellaneous information.">
183 <helpop key="userip" value="/USERIP [nickname]
184 Returns the ip and nickname of a user.">
186 <helpop key="away" value="/AWAY {message}
187 If a message is given, marks you as being away, otherwise
188 removes your away status and previous message.">
190 <helpop key="ison" value="/ISON [nick] {[nick]...}
191 Returns a subset of the nicks you give, showing only those
192 that are currently online.">
194 <helpop key="invite" value="/INVITE [nick] [channel]
195 Invites a user to a channel. If the channel is NOT +i, any
196 user, channel op or not, may invite any other user to the
197 channel, so long as they are a member of that channel.
198 Otherwise, if +i is set only channel halfoperators
199 and above may invite users into the channel.">
201 <helpop key="pass" value="/PASS [password]
202 This command is used by your irc client when setting up
203 your irc session, and should not be issued by a fully
206 <helpop key="whowas" value="/WHOWAS [nick]
207 Returns a list of times the user was last seen on irc
208 along with the time they were last seen and their server.">
210 <helpop key="links" value="/LINKS
211 Shows all servers linked to this one. Note that in this
212 server implementation all links will be flattened as
213 a tree based layout is not in use.">
215 <helpop key="map" value="/MAP
216 Shows a graphical representation of all users and servers
217 on the network. The tree diagram is inaccurate in this
218 implementation as a tree based network is not in place.">
220 #####################
222 #####################
224 <helpop key="coper" value="Oper Commands
226 DIE RESTART KILL REHASH TRACE
227 CONNECT SQUIT MODULES MKPASSWD SHUN
228 KLINE QLINE GLINE ELINE ZLINE
229 SAJOIN SAPART SAMODE SAQUIT SANICK
230 SETIDLE SETHOST SETNAME SETIDENT SWHOIS
231 OPERMOTD CHGHOST CHGNAME CHGIDENT CBAN
232 NICKLOCK NICKUNLOCK LOADMODULE UNLOADMODULE GLOBOPS
233 SPYLIST SPYNAMES GLOADMODULE GUNLOADMODULE MKSHA256
234 FREEZE UNFREEZE OPERPERMS RCONNECT">
236 <helpop key="rconnect" value="/RCONNECT [source mask] [target mask]
237 All servers matching [source mask] will try to connect to
238 the first server in the config file matching [target mask].">
240 <helpop key="operperms" value="/OPERPERMS [nick]
241 List all commands an oper has access to use.">
243 <helpop key="freeze" value="/FREEZE [nick]
244 Prevents the user from sending commands until they reconnect.
245 User is also notified they have been frozen.">
247 <helpop key="unfreeze" value="/UNFREEZE [nick]
248 Unfreezes a user frozen by the /FREEZE command.">
250 <helpop key="spylist" value="/SPYLIST
251 Operates the same as /LIST but includes +s and +p channels.">
253 <helpop key="spynames" value="/SPYNAMES [channel]
254 Operates the same as /name but works on +s and +p channels.">
256 <helpop key="globops" value="/GLOBOPS [message]
257 Sends a message to all +g users.">
259 <helpop key="cban " value="/CBAN [channel] {[duration] :[reason]}
260 Sets or removes a channel ban. You must specify at least
261 3 parameters to add a ban, and one parameter to remove a ban.
262 The duration may be specified in seconds, or in the following format
263 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
264 5 minutes and 6 seconds. All fields in this format are optional.">
266 <helpop key="sajoin" value="/SAJOIN [nick] [channel]
267 Forces the user to join the channel.">
269 <helpop key="sapart" value="/SAPART [nick] [channel]
270 Forces the user to part the channel.">
272 <helpop key="samode" value="/SAMODE [#chan] +/-[modes] {[parameters for modes]}
273 Gives the channel or nick the modes specified.">
275 <helpop key="sanick" value="/SANICK [nick] [new nick]
276 Changes the users nick to the new nick.">
278 <helpop key="saquit" value="/SAQUIT [nick] [reason]
279 Forces user to quit with the specified reason.">
281 <helpop key="setidle" value="/SETIDLE [idle time]
282 Sets your idle time (in seconds).">
284 <helpop key="sethost" value="/SETHOST [host]
285 Sets your host to the specified host.">
287 <helpop key="setident" value="/SETIDENT [ident]
288 Sets your ident to the specified ident.">
290 <helpop key="setname" value="/SETNAME [name]
291 Sets your name to the specified name.">
293 <helpop key="swhois" line="/SWHOIS [nick] [swhois]
294 Sets the users swhois field to the given swhois.">
296 <helpop key="mkpasswd" value="/MKPASSWD [hashtype] [plaintext]
297 Encodes the plaintext to an MD5 hash and displays the result.">
299 <helpop key="opermotd" value="/OPERMOTD
300 Re-displays the Oper MOTD.">
302 <helpop key="nicklock" value="/NICKLOCK [nick] [new nick]
303 Changes user's nick to the new nick, and forces
304 it to remain as such for the remainder of the session.">
306 <helpop key="nickunlock" value="/NICKUNLOCK [nick]
307 Allows the user to change nicks.">
309 <helpop key="chghost" value="/CHGHOST [nickname] [new hostname]
310 Changes the hostname of the user to the new hostname.">
312 <helpop key="chgname" value="/CHGNAME [nickname] [new name]
313 Changes the name of the user to the new name.">
315 <helpop key="chgident" value="/CHGIDENT [nickname] [new ident]
316 Changes the ident of the user to the new ident.">
318 <helpop key="shun" value="/SHUN [user@host] {[duration] :[reason]}
319 Sets or removes a shun (serverside ignore) on a host and ident mask.
320 You must specify at least 3 parameters to add a shun, and one
321 parameter to remove a shun (just the user@host section).
322 The duration may be specified in seconds, or in the following format
323 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
324 5 minutes and 6 seconds. All fields in this format are optional.">
326 <helpop key="die" value="/DIE [password]
327 If the correct password is provided, and you are an operator,
328 This command will shut down the local server.">
330 <helpop key="restart" value="/RESTART [password]
331 If the correct password is provided, and you are an operator,
332 This command will restart the local server.">
334 <helpop key="commands" value="/COMMANDS
335 Shows all currently available commands.">
337 <helpop key="kill" value="/KILL [user] [reason]
338 This command will disconnect a user from IRC with the given reason.">
340 <helpop key="rehash" value="/REHASH
341 This command will cause the server configuration file to be
342 re-read and values re-initialized.">
344 <helpop key="trace" value="/TRACE [nick|user@host|servermask]
345 This command will provide a list of all users and servers which
346 must be passed through or over to reach a given object (server or user).">
348 <helpop key="connect" value="/CONNECT [servermask]
349 Create a mesh connection to the given servermask. You must have
350 configured the server for linking in your configuration file,
351 and provided a password.">
353 <helpop key="squit" value="/SQUIT
354 Disconnects the local server from the mesh network, causing every
355 other server in the network to drop it.">
357 <helpop key="modules" value="/MODULES
358 Lists currently loaded modules, their memory offsets and version
359 numbers and flags. If you are not an operator, you will see reduced
362 <helpop key="loadmodule" value="/LOADMODULE [filename.so]
363 Loads a module into the IRCd.">
365 <helpop key="unloadmodule" value="/UNLOADMODULE [filename.so]
366 Unloads a module from the IRCd. The module cannot have the static
367 flag set (see the output of /MODULES).">
369 <helpop key="gloadmodule" value="/GLOADMODULE [filename.so]
370 Globally loads a module into the network.">
372 <helpop key="gunloadmodule" value="/GUNLOADMODULE [filename.so]
373 Globally unloads a module from the network. The module cannot
374 have the static flag set (see the output of /MODULES).">
376 <helpop key="kline" value="/KLINE [user@host] {[duration] :[reason]}
377 Sets or removes a k-line (host based ban) on a host and ident mask.
378 You must specify at least 3 parameters to add a ban, and one
379 parameter to remove a ban (just the user@host section).
380 The duration may be specified in seconds, or in the following format
381 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
382 5 minutes and 6 seconds. All fields in this format are optional.">
384 <helpop key="zline" value="/ZLINE [ipmask] {[duration] :[reason]}
385 Sets or removes a z-line (ip based ban) on an ip range mask.
386 You must specify at least 3 parameters to add a ban, and one
387 parameter to remove a ban (just the user@host section).
388 The duration may be specified in seconds, or in the following format
389 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
390 5 minutes and 6 seconds. All fields in this format are optional.">
392 <helpop key="qline" value="/QLINE [nickmask] {[duration] :[reason]}
393 Sets or removes a q-line (nick based ban) on a nick mask.
394 You must specify at least 3 parameters to add a ban, and one
395 parameter to remove a ban (just the user@host section).
396 The duration may be specified in seconds, or in the following format
397 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
398 5 minutes and 6 seconds. All fields in this format are optional.">
400 <helpop key="gline" value="/GLINE [user@host] {[duration] :[reason]}
401 Sets or removes a g-line (global host based ban) on host mask.
402 You must specify at least 3 parameters to add a ban, and one
403 parameter to remove a ban (just the user@host section).
404 The duration may be specified in seconds, or in the following format
405 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
406 5 minutes and 6 seconds. All fields in this format are optional.">
408 <helpop key="eline" value="/ELINE [user@host] {[duration] :[reason]}
409 Sets or removes a e-line (local ban exception) on host mask.
410 You must specify at least 3 parameters to add an exception, and one
411 parameter to remove an exception (just the user@host section).
412 The duration may be specified in seconds, or in the following format
413 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
414 5 minutes and 6 seconds. All fields in this format are optional.">
416 ######################
417 # User/Channel Modes #
418 ######################
420 <helpop key="umodes" value="User Modes
423 i Is invisible to /WHO
424 w Can receive wallops messages
425 s Can receive server notices
426 n [mask] Can receive server notices specified by [mask]
427 x Cloaked hostname (requires cloaking module)
428 g Can receive globops (requires globops module)
429 h Will receive helpops notification (requires helpop module)
430 r Nickname is registered
431 R Only registered users can PRIVMSG this nickname
433 G Messages are censored to user
434 W Can see when a user uses WHOIS on them
435 S mIRC colour codes are stripped to the user
436 D User can not receive PRIVMSGs">
438 <helpop key="chmodes" value="Channel Modes
440 v [nickname] Gives voice to [nickname] (can talk on +m channel)
441 h [nickname] Gives halfops to [nickname]
442 o [nickname] Gives ops to [nickname]
443 b [hostmask] Bans [hostmask] on the channel
444 a [nickname] Give protected status to [nickname] (+q only)
445 q [nickname] Give founder status to [nickname] (ulines only)
446 i Make the channel invite only, must /INVITE users
447 k [key] Set the channel key (password) to [key]
448 l [limit] Set the maximum possible users to [limit]
449 m Enable moderation. Only +vo(h) can speak
450 n Only users who are members of the channel may message it
451 p Make channel private (hide from /LIST)
452 s Make channel secret (can't be used at the same time as +p)
453 O Channel is IRCops only (can only be set by IRCops)
454 t Only halfops and above can change the topic
455 Q Only U-Lined servers/nicks can kick
456 T Only halfops/ops can send NOTICEs to the channel
457 C No CTCPs allowed to the channel
458 c mIRC colour codes blocked on the channel
459 S mIRC colour codes are stripped from the channel
460 e [hostmask] Ban exception on [hostmask]
461 K No /KNOCK allowed to channel
462 L [channel] If the channel is full, redirect users to [channel]
463 N No nick changes while on the channel
464 G Censors channel based on network censor config
465 g [word] All messages containing the word are blocked
466 I [hostmask] Invite exception allows user to join a channel with +i
467 j [joins]:[sec] Prevents join flooding
468 J [seconds] Prevents auto-rejoin on kick
469 f [*][lines]:[sec] Kick on text flood. With * user is banned
471 r Channel is registered
472 R Only registered users can join
473 M Non-registered users can't chat
475 x Join exception mask. Avoids +ibkO
477 NOTE: A large number of these modes are dependent upon server-side modules
478 being loaded by a server/network administrator. The actual modes available
479 on your network may be very different to this list. Please consult your
480 help channel if you have any questions.">
482 ######################
484 ######################
486 <helpop key="stats" value="/STATS [symbol]
487 Shows various server statistics. Depending on configuration this
488 command may be reserved for oper-only use.
492 m Show command statistics, number of times commands have been used
493 z Show memory usage statistics
494 o Show a list of all valid oper usernames and hostmasks
495 l Show all inbound and outbound server and client connections
497 k Show k-lines (local bans)
498 g Show g-lines (global bans)
499 q Show q-lines (nick mask bans)
500 Z Show z-lines (ip mask bans)
501 Y Show connection classes
503 U Show u-lined servers
504 P Show online opers and their idle times
505 I Show connect class permissions
506 e Show e-lines (local ban exemptions)
510 Note that all /STATS use is broadcast to online IRC operators.">