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.
11 /HELPOP CUSER - To see a list of user commands
12 /HELPOP COPER - To see a list of oper commands
13 /HELPOP UMODES - To see a list of user modes
14 /HELPOP CHMODES - To see a list of channel modes">
16 <helpop key="nohelp" value="There is no help for the topic
17 you searched for. Please try again.">
23 <helpop key="cuser" value="User Commands
25 USER NICK QUIT VERSION PING
26 PONG ADMIN PRIVMSG INFO TIME
27 WHOIS NOTICE JOIN NAMES PART
28 KICK MODE TOPIC WHO MOTD
29 RULES OPER LIST LUSERS STATS
30 USERHOST AWAY ISON SUMMON USERS
31 INVITE PASS WHOWAS LINKS MAP
32 COMMANDS MODULES KNOCK SILENCE DEVOICE
33 REMOVE UNINVITE VHOST WATCH TBAN
34 TITLE CYCLE DCCALLOW FPART FINGERPRINT
37 <helpop key="sslinfo" value="/SSLINFO [nick]
38 Shows the SSL key fingerprint for the user if they have an SSL
41 <helpop key="fingerprint" value="/FINGERPRINT [nick]
42 Shows the SSL fingerprint of a user.">
44 <helpop key="uninvite" value="/UNINVITE [nick] [channel]
45 Uninvite a user from a channel, same syntax as INVITE.">
47 <helpop key="tban" value="/TBAN [channel] [duration] [banmask]
48 Sets a timed ban. The duration of the ban can be specified in the
49 following format: 1w2d3h4m6s which indicates a ban of one week, two
50 days, three hours, four minutes and six seconds. Alternatively the
51 ban may just be specified as a number of seconds. All timed bans
52 appear in the banlist as normal bans and may be safely removed
53 before their time is up.">
55 <helpop key="dccallow" value="/DCCALLOW [+|-] [nick] [duration]
56 Add a nickname to or delete a nickname from your DCCALLOW list.">
58 <helpop key="cycle" value="/CYCLE [channel]
59 Cycles a channel (Leaving and Rejoining), overrides restrictions that
60 would stop a new user joining, such as User Limits and Channel Keys.">
62 <helpop key="title" value="/TITLE [name] [password]
63 Adds a WHOIS title line and optionally sets a VHOST depending
64 on username and password.">
66 <helpop key="watch" value="/WATCH [C|S|+/-[NICK]]
67 Adds or deletes a user from the watch list. C clears the list
68 and S queries the status.">
70 <helpop key="vhost" value="/VHOST [username] [password]
71 Authenticate for a vhost.">
73 <helpop key="remove" value="/REMOVE [channel] [nick] {[reason]}
74 Removes a user from a channel you specify. You must be at least a
75 channel halfoperator to remove a user. A removed user will part with
76 a message stating they were removed from the channel and by whom.">
78 <helpop key="fpart" value="/FPART [nick] [channel] {[reason]}
79 This behaves identically to /REMOVE, the only difference is that that
80 [channel] and [nick] parameters are switched around to match /KICK's
81 syntax. Also, /REMOVE is a builtin mIRC command which caused trouble
82 for some users. This feature was added in the 1.1 branch.">
84 <helpop key="devoice" value="/DEVOICE [channel]
85 Devoices yourself from the specified channel.">
87 <helpop key="silence" value="/SILENCE [+/-][hostmask] [p|c|i|n|t|a|x]
88 p Block private messages
89 c Block channel messages
91 n Block private notices
92 t Block channel notices
93 a Block all of the above
95 A serverside /ignore of the given hostmask.
96 /SILENCE without a parameter will list the hostmasks that you have silenced.">
98 <helpop key="knock" value="/KNOCK [channel]
99 Sends a notice to a channel indicating you wish to join.">
101 <helpop key="user" value="/USER [ident] [local host] [remote host] :[GECOS]
102 This command is used by your client to register your irc session.
103 You should not use it during an established connection.">
105 <helpop key="nick" value="/NICK [new nick]
106 Change your nickname to [new nick].">
108 <helpop key="quit" value="/QUIT {[reason]}
109 Quit from IRC and end your current session.">
111 <helpop key="version" value="/VERSION
112 Returns the server's version number.">
114 <helpop key="ping" value="/PING [server]
115 Ping a server. Target server will answer with a PONG.">
117 <helpop key="pong" value="/PONG [server]
118 Your client should send this to answer server PINGs. You
119 should not issue this command manually.">
121 <helpop key="admin" value="/ADMIN [server]
122 Fetches the administrative information on the given server.">
124 <helpop key="privmsg" value="/MSG [target] [text]
125 Sends a message to a user or channel specified in [target].">
127 <helpop key="notice" value="/NOTICE [target] [text]
128 Sends a notice to a user or channel specified in [target].">
130 <helpop key="join" value="/JOIN [channel]{,[channel]} [key]{,[key]}
131 Joins one or more channels you provide the names for.">
133 <helpop key="names" value="/NAMES [channel]{,[channel]}
134 Return a list of users on the channels you provide.">
136 <helpop key="part" value="/PART [channel]{,[channel] [reason]}
137 Leaves one or more channels you specify.">
139 <helpop key="kick" value="/KICK [channel] [nick] {[reason]}
140 Kicks a user from a channel you specify. You must be
141 At least a channel halfoperator to kick a user.">
143 <helpop key="mode" value="/MODE [target] [+|-][modes]{[+|-][modes]} {mode parameters}
144 Sets the mode for a channel or a nickname specified in [target]
145 A user may only set modes upon themselves, and may not set the
146 +o usermode, and a user may only change channel modes of
147 channels where they are at least a halfoperator.">
149 <helpop key="topic" value="/TOPIC [channel] {topic}
150 Sets or retrieves the channel topic. If a channel topic is
151 given in the command and the channel is either not +t, or
152 You are at least a halfoperator, the channel topic will be
153 changed to the new one you provide.">
155 <helpop key="who" value="/WHO [ [search-pattern] [ohurmaiMplf] ]
156 Looks up the information of users matching the range you provide.
157 You may only /WHO nicknames in channels or on servers where you
158 share a common channel with them, or ones which are not +i (unless
159 you are an IRC operator). The search-pattern may be a special
160 sequence of characters determined by the flags given below, or
161 it may be one of a nickname, a channel, a hostmask, an ip address
162 mask or a server mask.
166 The following flags after the mask have the following affects:
168 o Show online IRC operators matching the mask
169 u Unlimit the results past the maximum /who results value
171 r Show all users whose realnames match the mask. When this
172 flag is set it overrides the meaning of the search-pattern,
173 which must contain a glob pattern intended to match GECOS
175 h Show real hostnames rather than masked hostnames (IRC
177 m Search for all users with a given set of user modes. When
178 this flag is set it overrides the meaning of the
179 search-pattern, which must contain the mode sequence to
180 search for, for example to find all users with +i and
181 without +s, issue the command WHO +i-s m.
182 a Show all users who have an away message matching the given mask
183 p Show all users who are connected on the given port number
184 i Show all users who have an ident (username) matching the given mask
185 M Show all users who have metadata attached to them with
187 l Show only local users
188 f Show only remote (far) users
189 t Show users connected within this time limit
191 You may combine multiple flags in one WHO command except where stated in the table above.">
193 <helpop key="motd" value="/MOTD [server]
194 Show the message of the day for [server]. Messages of the
195 day contain important server rules and notice and should be
196 read before using a server in any way!">
198 <helpop key="rules" value="/RULES
199 Show the rules file for the local server. This is similar in
200 effect to /MOTD except that rules are optional. All users are
201 sent the MOTD when they connect without having to request it.">
203 <helpop key="oper" value="/OPER [login] [password]
204 Attempts to authenticate a user as an IRC operator.
205 Please be aware that both successful and unsuccessful oper attempts
206 are logged, and sent to online IRC operators.">
208 <helpop key="list" value="/LIST [pattern]
209 Creates a list of all existing channels matching the glob pattern
210 [pattern], e.g. *chat* or bot*.">
212 <helpop key="lusers" value="/LUSERS
213 Shows a count of local and remote users, servers and channels.">
215 <helpop key="userhost" value="/USERHOST [nickname]
216 Returns the hostname and nickname of a user, and some other
217 miscellaneous information.">
219 <helpop key="away" value="/AWAY {message}
220 If a message is given, marks you as being away, otherwise
221 removes your away status and previous message.">
223 <helpop key="ison" value="/ISON [nick] {[nick]...}
224 Returns a subset of the nicks you give, showing only those
225 that are currently online.">
227 <helpop key="summon" value="/SUMMON [user]
228 Summons a user from the shell where the ircd is running onto irc
229 This command is deprecated in the current protocol.">
231 <helpop key="users" value="/USERS
232 Shows users logged into the shell where the ircd is running.
233 This command is deprecated in the current protocol.">
235 <helpop key="invite" value="/INVITE [nick] [channel]
236 Invites a user to a channel. If the channel is NOT +i, any
237 user, channel op or not, may invite any other user to the
238 channel, so long as they are a member of that channel.
239 Otherwise, if +i is set only channel halfoperators
240 and above may invite users into the channel.">
242 <helpop key="pass" value="/PASS [password]
243 This command is used by your irc client when setting up
244 your irc session, and should not be issued by a fully
247 <helpop key="whowas" value="/WHOWAS [nick]
248 Returns a list of times the user was last seen on irc
249 along with the time they were last seen and their server.">
251 <helpop key="links" value="/LINKS
252 Shows all servers linked to this one. Note that in this
253 server implementation all links will be flattened as
254 a tree based layout is not in use.">
256 <helpop key="map" value="/MAP
257 Shows a graphical representation of all users and servers
258 on the network. The tree diagram is inaccurate in this
259 implementation as a tree based network is not in place.">
261 #####################
263 #####################
265 <helpop key="coper" value="Oper Commands
267 DIE RESTART KILL REHASH TRACE
268 CONNECT SQUIT MODULES MKPASSWD SHUN
269 KLINE QLINE GLINE ELINE ZLINE
270 SAJOIN SAPART SAMODE SAQUIT SANICK
271 SETIDLE SETHOST SETNAME SETIDENT SWHOIS
272 OPERMOTD CHGHOST CHGNAME CHGIDENT CBAN
273 NICKLOCK NICKUNLOCK LOADMODULE UNLOADMODULE RELOADMODULE
274 SPYLIST SPYNAMES GLOADMODULE GUNLOADMODULE GRELOADMODULE
275 FREEZE UNFREEZE OPERPERMS RCONNECT RSQUIT
276 CHECK CLONES FILTER GLOBOPS USERIP
277 JUMPSERVER LOCKSERV UNLOCKSERV ALLTIME TAXONOMY
280 <helpop key="userip" value="/USERIP [nickname]
281 Returns the ip and nickname of a user.">
283 <helpop key="tline" value="/TLINE [host or ip mask]
284 This command returns the number of local and global clients matched,
285 and the percentage of clients matched, plus how they were matched
286 (by IP address or by hostname).">
288 <helpop key="taxonomy" value="/TAXONOMY [nick]
289 Lists all metadata attached to the user.">
291 <helpop key="lockserv" value="/LOCKSERV
292 Locks out all new connections notifying connecting users that the
293 service is temporarily closed and to try again later.">
295 <helpop key="unlockserv" value="/UNLOCKSERV
296 Opens the server up again for new connections.">
298 <helpop key="jumpserver" value="/JUMPSERVER {[newserver] [newport] [+/-flags] {:[reason]}}
299 Sets or cancels jumpserver mode. If no parameters are given,
300 jumpserver mode is cancelled, if it is currently set. If parameters
301 are given, a server address must be given for [newserver] and a
302 server port must be given for [newport]. Zero or more status flags
303 should be given for 'flags', from the list below (if you do not
304 wish to specify any flags just place a '+' in this field):
305 1. +a: Redirect all users immediately (except for opers) and cause
306 them to quit with the given reason
307 2. +n: Redirect any new users who connect and cause them to quit
309 You may use + and - to set or unset these flags in the command, the
310 default flags are -a+n, which will just redirect new users. The
311 reason parameter is optional, and if not provided defaults to
312 'Please use this server/port instead' (the default given in various
315 <helpop key="filter" value="/FILTER [filter-definition] {[action] [flags] {[gline-duration]} :[reason]}
316 This command will add a filter when more than one parameter is
317 given, using the specified filter definition, action, gline
318 duration (when the type is 'gline') and reason. When only one
319 parameter is provided (the filter pattern) the provided filter will
320 be removed. Note that if you remove a configuration-defined filter,
321 it will re-appear at next rehash unless it is also removed from the
324 <helpop key="clones" value="/CLONES [limit]
325 Retrieves a list of users with more clones than the specified
328 <helpop key="check" value="/CHECK [nick|ip|hostmask|channel]
329 Allows opers to look up advanced information on channels, hostmasks
330 or IP addresses, in a similar way to WHO but in more detail.">
332 <helpop key="alltime" value="/ALLTIME
333 Shows the time (with any delta, if applied) on all servers on
336 <helpop key="rconnect" value="/RCONNECT [source mask] [target mask]
337 All servers matching [source mask] will try to connect to
338 the first server in the config file matching [target mask].">
340 <helpop key="rsquit" value="/RSQUIT {[source mask]} [target mask]
341 Causes the remote server [target mask] to be disconnected from
342 the network, by [source mask] if specified.">
344 <helpop key="operperms" value="/OPERPERMS [nick]
345 List all commands an oper has access to use.">
347 <helpop key="freeze" value="/FREEZE [nick]
348 Prevents the user from sending commands until they reconnect.
349 User is also notified they have been frozen.">
351 <helpop key="unfreeze" value="/UNFREEZE [nick]
352 Unfreezes a user frozen by the /FREEZE command.">
354 <helpop key="globops" value="/GLOBOPS [message]
355 Sends a message to all users with the +g snomask.">
357 <helpop key="cban" value="/CBAN [channel] {[duration] :[reason]}
358 Sets or removes a channel ban. You must specify at least
359 3 parameters to add a ban, and one parameter to remove a ban.
360 The duration may be specified in seconds, or in the following format
361 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
362 5 minutes and 6 seconds. All fields in this format are optional.">
364 <helpop key="sajoin" value="/SAJOIN [nick] [channel]
365 Forces the user to join the channel.">
367 <helpop key="sapart" value="/SAPART [nick] [channel]
368 Forces the user to part the channel.">
370 <helpop key="samode" value="/SAMODE [#chan] +/-[modes] {[parameters for modes]}
371 Gives the channel or nick the modes specified.">
373 <helpop key="sanick" value="/SANICK [nick] [new nick]
374 Changes the users nick to the new nick.">
376 <helpop key="saquit" value="/SAQUIT [nick] [reason]
377 Forces user to quit with the specified reason.">
379 <helpop key="setidle" value="/SETIDLE [idle time]
380 Sets your idle time (in seconds).">
382 <helpop key="sethost" value="/SETHOST [host]
383 Sets your host to the specified host.">
385 <helpop key="setident" value="/SETIDENT [ident]
386 Sets your ident to the specified ident.">
388 <helpop key="setname" value="/SETNAME [name]
389 Sets your name to the specified name.">
391 <helpop key="swhois" line="/SWHOIS [nick] [swhois]
392 Sets the users swhois field to the given swhois.">
394 <helpop key="mkpasswd" value="/MKPASSWD [hashtype] [plaintext]
395 Encodes the plaintext to a hash of the given type and displays
398 <helpop key="opermotd" value="/OPERMOTD
399 Re-displays the Oper MOTD.">
401 <helpop key="nicklock" value="/NICKLOCK [nick] [new nick]
402 Changes user's nick to the new nick, and forces
403 it to remain as such for the remainder of the session.">
405 <helpop key="nickunlock" value="/NICKUNLOCK [nick]
406 Allows the user to change nicks.">
408 <helpop key="chghost" value="/CHGHOST [nickname] [new hostname]
409 Changes the hostname of the user to the new hostname.">
411 <helpop key="chgname" value="/CHGNAME [nickname] [new name]
412 Changes the name of the user to the new name.">
414 <helpop key="chgident" value="/CHGIDENT [nickname] [new ident]
415 Changes the ident of the user to the new ident.">
417 <helpop key="shun" value="/SHUN [user@host] {[duration] :[reason]}
418 Sets or removes a shun (serverside ignore) on a host and ident mask.
419 You must specify at least 3 parameters to add a shun, and one
420 parameter to remove a shun (just the user@host section).
421 The duration may be specified in seconds, or in the following format
422 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
423 5 minutes and 6 seconds. All fields in this format are optional.">
425 <helpop key="die" value="/DIE [password]
426 If the correct password is provided, and you are an operator,
427 This command will shut down the local server.">
429 <helpop key="restart" value="/RESTART [password]
430 If the correct password is provided, and you are an operator,
431 This command will restart the local server.">
433 <helpop key="commands" value="/COMMANDS
434 Shows all currently available commands.">
436 <helpop key="kill" value="/KILL [user] [reason]
437 This command will disconnect a user from IRC with the given reason.">
439 <helpop key="rehash" value="/REHASH
440 This command will cause the server configuration file to be
441 re-read and values re-initialized.">
443 <helpop key="trace" value="/TRACE [nick|user@host|servermask]
444 This command will provide a list of all users and servers which
445 must be passed through or over to reach a given object (server or user).">
447 <helpop key="connect" value="/CONNECT [servermask]
448 Create a mesh connection to the given servermask. You must have
449 configured the server for linking in your configuration file,
450 and provided a password.">
452 <helpop key="squit" value="/SQUIT [servermask]
453 Disconnects the local server from the mesh network, causing every
454 other server in the network to drop it.">
456 <helpop key="modules" value="/MODULES
457 Lists currently loaded modules, their memory offsets and version
458 numbers and flags. If you are not an operator, you will see reduced
461 <helpop key="loadmodule" value="/LOADMODULE [filename.so]
462 Loads a module into the IRCd.">
464 <helpop key="unloadmodule" value="/UNLOADMODULE [filename.so]
465 Unloads a module from the IRCd. The module cannot have the static
466 flag set (see the output of /MODULES).">
468 <helpop key="reloadmodule" value="/RELOADMODULE [filename.so]
469 Unloads and reloads a module in the IRCd. This module cannot have
470 the static flag set (see the output of /MODULES).">
472 <helpop key="gloadmodule" value="/GLOADMODULE [filename.so]
473 Globally loads a module into the network.">
475 <helpop key="gunloadmodule" value="/GUNLOADMODULE [filename.so]
476 Globally unloads a module from the network. The module cannot
477 have the static flag set (see the output of /MODULES).">
479 <helpop key="greloadmodule" value="/GRELOADMODULE [filename.so]
480 Globally unloads and reloads a module in the network. This module
481 cannot have the static flag set (see the output of /MODULES).">
483 <helpop key="kline" value="/KLINE [user@host] {[duration] :[reason]}
484 Sets or removes a k-line (local host based ban) on a host and ident mask.
485 You must specify at least 3 parameters to add a ban, and one
486 parameter to remove a ban (just the user@host section).
487 The duration may be specified in seconds, or in the following format
488 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
489 5 minutes and 6 seconds. All fields in this format are optional.">
491 <helpop key="zline" value="/ZLINE [ipmask] {[duration] :[reason]}
492 Sets or removes a z-line (ip based ban) on an ip range mask.
493 You must specify at least 3 parameters to add a ban, and one
494 parameter to remove a ban (just the user@host section).
495 The duration may be specified in seconds, or in the following format
496 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
497 5 minutes and 6 seconds. All fields in this format are optional.">
499 <helpop key="qline" value="/QLINE [nickmask] {[duration] :[reason]}
500 Sets or removes a q-line (nick based ban) on a nick mask.
501 You must specify at least 3 parameters to add a ban, and one
502 parameter to remove a ban (just the user@host section).
503 The duration may be specified in seconds, or in the following format
504 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
505 5 minutes and 6 seconds. All fields in this format are optional.">
507 <helpop key="gline" value="/GLINE [user@host] {[duration] :[reason]}
508 Sets or removes a g-line (host based ban) on host mask.
509 You must specify at least 3 parameters to add a ban, and one
510 parameter to remove a ban (just the user@host section).
511 The duration may be specified in seconds, or in the following format
512 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
513 5 minutes and 6 seconds. All fields in this format are optional.">
515 <helpop key="eline" value="/ELINE [user@host] {[duration] :[reason]}
516 Sets or removes a e-line (local ban exception) on host mask.
517 You must specify at least 3 parameters to add an exception, and one
518 parameter to remove an exception (just the user@host section).
519 The duration may be specified in seconds, or in the following format
520 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
521 5 minutes and 6 seconds. All fields in this format are optional.">
523 ######################
524 # User/Channel Modes #
525 ######################
527 <helpop key="umodes" value="User Modes
530 i Is invisible to /WHO
531 w Can receive wallops messages
532 s [mask] Can receive server notices specified by [mask]
533 x Cloaked hostname (requires cloaking module)
534 h Will receive helpops notification (requires helpop module)
535 r Nickname is registered
536 d Hides all non-private messages and notices
538 G Messages are censored to user
539 W Can see when a user uses WHOIS on them
540 S mIRC colour codes are stripped to the user
541 D User can not receive PRIVMSGs
542 H Hides an oper's WHOIS line
543 I Hides a user's channel list from non-opers
544 Q Hides an oper completely
545 R Only registered users can message you">
547 <helpop key="chmodes" value="Channel Modes
549 v [nickname] Gives voice to [nickname] (can talk on +m channel)
550 h [nickname] Gives halfops to [nickname]
551 o [nickname] Gives ops to [nickname]
552 b [hostmask] Bans [hostmask] on the channel
553 a [nickname] Give protected status to [nickname] (+q only)
554 q [nickname] Give founder status to [nickname] (ulines only)
555 i Make the channel invite only, must /INVITE users
556 k [key] Set the channel key (password) to [key]
557 l [limit] Set the maximum possible users to [limit]
558 m Enable moderation. Only +vo(h) can speak
559 n Only users who are members of the channel may message it
560 p Make channel private (hide from /LIST)
561 s Make channel secret (can't be used at the same time as +p)
562 O Channel is IRCops only (can only be set by IRCops)
563 t Only halfops and above can change the topic
564 Q Only U-Lined servers/nicks can kick
565 T Only halfops/ops can send NOTICEs to the channel
566 C No CTCPs allowed to the channel
567 c mIRC colour codes blocked on the channel
568 S mIRC colour codes are stripped from the channel
569 e [hostmask] Ban exception on [hostmask]
570 K No /KNOCK allowed to channel
571 L [channel] If the channel is full, redirect users to [channel]
572 N No nick changes while on the channel
573 G Censors channel based on network censor config
574 g [word] All messages containing the word are blocked
575 I [hostmask] Invite exception allows user to join a channel with +i
576 j [joins]:[sec] Prevents join flooding
577 J [seconds] Prevents auto-rejoin on kick
578 f [*][lines]:[sec] Kick on text flood. With * user is banned
580 r Channel is registered
581 R Only registered users can join
582 M Non-registered users can't chat
584 x Join exception mask. Avoids +ibkO
586 NOTE: A large number of these modes are dependent upon server-side modules
587 being loaded by a server/network administrator. The actual modes available
588 on your network may be very different to this list. Please consult your
589 help channel if you have any questions.">
591 ######################
593 ######################
595 <helpop key="stats" value="/STATS [symbol]
596 Shows various server statistics. Depending on configuration this
597 command may be reserved for oper-only use.
601 m Show command statistics, number of times commands have been used
602 z Show memory usage statistics
603 o Show a list of all valid oper usernames and hostmasks
604 l Show all inbound and outbound server and client connections
606 k Show k-lines (local host bans)
607 g Show g-lines (host bans)
608 q Show q-lines (nick mask bans)
609 Z Show z-lines (ip mask bans)
610 Y Show connection classes
612 U Show u-lined servers
613 P Show online opers and their idle times
614 I Show connect class permissions
615 e Show e-lines (local ban exemptions)
618 L Show all client connections with information and IP address
619 T Show bandwidth/socket statistics
620 p Show open client ports, and the port type (ssl, plaintext, etc) plus number of users on each port
622 Note that all /STATS use is broadcast to online IRC operators.">