5 <alias text="HELP" replace="HELPOP $2-">
7 <helpop key="start" value="InspIRCd Help System
9 This system provides help for commands and modes.
10 Specify your question or a command name as the
11 parameter for this command.
13 /HELPOP CUSER - To see a list of user commands
14 /HELPOP COPER - To see a list of oper commands
15 /HELPOP UMODES - To see a list of user modes
16 /HELPOP CHMODES - To see a list of channel modes
17 /HELPOP SNOMASKS - To see a list of oper snotice masks
18 /HELPOP EXTBANS - To see a list of extended bans">
20 <helpop key="nohelp" value="There is no help for the topic
21 you searched for. Please try again.">
27 <helpop key="cuser" value="User Commands
30 PRIVMSG NOTICE NICK JOIN PART
31 CYCLE KNOCK MODE DEVOICE TOPIC
32 KICK FPART REMOVE TBAN INVITE
33 UNINVITE AWAY DCCALLOW SILENCE ACCEPT
34 MKPASSWD VHOST TITLE SETNAME
36 WHOIS WHOWAS ISON USERHOST WATCH
38 ADMIN MAP LINKS LUSERS TIME
39 STATS VERSION INFO MODULES COMMANDS
42 USER PASS PING PONG QUIT
46 <helpop key="sslinfo" value="/SSLINFO <nick>
48 Displays information on the SSL connection and certificate of the
51 <helpop key="uninvite" value="/UNINVITE <nick> <channel>
53 Uninvite a user from a channel, same syntax as INVITE.">
55 <helpop key="tban" value="/TBAN <channel> <duration> <banmask>
57 Sets a timed ban. The duration of the ban can be specified in the
58 following format: 1w2d3h4m6s which indicates a ban of one week, two
59 days, three hours, four minutes and six seconds. Alternatively the
60 ban may just be specified as a number of seconds. All timed bans
61 appear in the banlist as normal bans and may be safely removed
62 before their time is up.">
64 <helpop key="dccallow" value="/DCCALLOW - List allowed nicks
65 /DCCALLOW LIST - This also lists allowed nicks
66 /DCCALLOW +<nick> [<duration>] - Add a nick
67 /DCCALLOW -<nick> - Remove a nick
68 /DCCALLOW HELP - Display help
70 Duration is optional, and may be specified in seconds or in the
73 <helpop key="accept" value="/ACCEPT * - List accepted nicks
74 /ACCEPT +<nick> - Add a nick
75 /ACCEPT -<nick> - Remove a nick
76 This command accepts multiple nicks like so:
77 /ACCEPT +<nick1>,+<nick2>,-<nick3>
79 Manages your accept list. This list is used to determine who can
80 private message you when you have usermode +g set.">
82 <helpop key="cycle" value="/CYCLE <channel> :[<reason>]
84 Cycles a channel (leaving and rejoining), overrides restrictions that
85 would stop a new user joining, such as user limits and channel keys.">
87 <helpop key="title" value="/TITLE <name> <password>
89 Authenticate for a WHOIS title line and optionally a vhost using the
90 specified username and password.">
92 <helpop key="watch" value="/WATCH - List watched nicks that are online
93 /WATCH L - List watched nicks, online and offline
94 /WATCH C - Clear all watched nicks
95 /WATCH S - Show statistics
96 /WATCH +<nick> - Add a nick
97 /WATCH -<nick> - Remove a nick
98 This command accepts multiple nicks like so:
99 /WATCH +<nick1> +<nick2> -<nick3>">
101 <helpop key="vhost" value="/VHOST <username> <password>
103 Authenticate for a vhost using the specified username and password.">
105 <helpop key="remove" value="/REMOVE <channel> <nick> [<reason>]
107 Removes a user from a channel you specify. You must be at least a
108 channel halfoperator to remove a user. A removed user will part with
109 a message stating they were removed from the channel and by whom.">
111 <helpop key="rmode" value="/RMODE [channel] [modeletter] {[pattern]}
113 Removes listmodes from a channel.
114 E.g. /RMODE #Chan b m:* will remove all mute extbans.">
116 <helpop key="fpart" value="/FPART <channel> <nick> [<reason>]
118 This behaves identically to /REMOVE. /REMOVE is a builtin mIRC command
119 which caused trouble for some users.">
121 <helpop key="devoice" value="/DEVOICE <channel>
123 Devoices yourself on the specified channel.">
125 <helpop key="silence" value="/SILENCE - Shows a list of silenced masks
126 /SILENCE +<mask> [<flags>] - Add a mask
127 /SILENCE -<mask> - Remove a mask
129 A serverside ignore of the given n!u@h mask. The letter(s) at the end
130 specify what is to be ignored from this hostmask.
135 p Block private messages
136 c Block channel messages
138 n Block private notices
139 t Block channel notices
140 a Block all of the above
143 Multiple letters may be specified. For an exception, you must pair x
144 with what you want excepted. For example, if you wanted to except
145 everything from people with a host matching *.foo.net, you would do
146 /SILENCE +*!*@*.foo.net xa
148 /SILENCE without a parameter will list the masks that you have silenced.">
150 <helpop key="knock" value="/KNOCK <channel>
152 Sends a notice to a channel indicating you wish to join.">
154 <helpop key="user" value="/USER <ident> <local host> <remote host> :<GECOS>
156 This command is used by your client to register your
157 IRC session, providing your ident and GECOS to the
160 You should not use it during an established connection.">
162 <helpop key="nick" value="/NICK <new nick>
164 Change your nickname to <new nick>.">
166 <helpop key="quit" value="/QUIT [<reason>]
168 Quit from IRC and end your current session.">
170 <helpop key="version" value="/VERSION
172 Returns the server's version information.">
174 <helpop key="ping" value="/PING <server>
176 Ping a server. The server will answer with a PONG.">
178 <helpop key="pong" value="/PONG <server>
180 Your client should send this to answer server PINGs. You
181 should not issue this command manually.">
183 <helpop key="admin" value="/ADMIN [<server>]
185 Shows the administrative information for the given server.">
187 <helpop key="privmsg" value="/PRIVMSG <target> <text>
189 Sends a message to a user or channel specified in <target>.">
191 <helpop key="notice" value="/NOTICE <target> <text>
193 Sends a notice to a user or channel specified in <target>.">
195 <helpop key="join" value="/JOIN <channel>[,<channel>] [<key>][,<key>]
197 Joins one or more channels you provide the names for.">
199 <helpop key="names" value="/NAMES <channel>[,<channel>]
201 Return a list of users on the channels you provide.">
203 <helpop key="part" value="/PART <channel>[,<channel>] [<reason>]
205 Leaves one or more channels you specify.">
207 <helpop key="kick" value="/KICK <channel> <nick>[,<nick>] [<reason>]
209 Kicks a user from a channel you specify. You must be
210 at least a channel halfoperator to kick a user.">
212 <helpop key="mode" value="/MODE <target> (+|-)<modes> [<mode parameters>] - Change modes of <target>.
214 /MODE <target> - Show modes of <target>.
216 /MODE <channel> <list mode char> - List bans, exceptions, etc. set on <channel>.
218 Sets the mode for a channel or a nickname specified in <target>.
219 A user may only set modes upon themselves, and may not set the
220 +o usermode, and a user may only change channel modes of
221 channels where they are at least a halfoperator.
223 For a list of all user and channel modes, enter /HELPOP UMODES or
226 <helpop key="topic" value="/TOPIC <channel> [<topic>]
228 Sets or retrieves the channel topic. If a channel topic is
229 given in the command and either the channel is not +t, or
230 you are at least a halfoperator, the channel topic will be
231 changed to the new one you provide.">
233 <helpop key="who" value="/WHO <search pattern> [ohurmaiMplf]
235 Looks up the information of users matching the range you provide.
236 You may only /WHO nicknames in channels or on servers where you
237 share a common channel with them, or ones which are not +i (unless
238 you are an IRC operator). The search-pattern may be a special
239 sequence of characters determined by the flags given below, or
240 it may be one of a nickname, a channel, a hostmask, an ip address
241 mask or a server mask.
246 The following flags after the mask have the following effects:
248 o Show online IRC operators matching the mask
250 a Show all users who have an away message matching the given mask
251 i Show all users who have an ident (username) matching the given mask
252 p Show all users who are connected on the given port number (IRC
254 r Show all users whose realnames match the mask. When this
255 flag is set it overrides the meaning of the search-pattern,
256 which must contain a glob pattern intended to match GECOS
258 m Search for all users with a given set of user modes. When
259 this flag is set it overrides the meaning of the
260 search-pattern, which must contain the mode sequence to
261 search for, for example to find all users with +i and
262 without +s, issue the command WHO +i-s m (IRC operators only)
263 t Show users connected within this number of seconds
264 M Show all users who have metadata attached to them with
265 the given key name (IRC operators only)
267 f Show only remote (far) users
268 l Show only local users
270 h Show real hostnames rather than masked hostnames (IRC
272 u Unlimit the results past the maximum /who results value
275 You may combine multiple flags in one WHO command except where stated in the table above.">
277 <helpop key="motd" value="/MOTD [<server>]
279 Show the message of the day for <server>. Messages of the day often
280 contain important server rules and notices and should be read prior
283 <helpop key="oper" value="/OPER <login> <password>
285 Attempts to authenticate a user as an IRC operator.
287 Both successful and unsuccessful oper attempts are
288 logged, and sent to online IRC operators.">
290 <helpop key="list" value="/LIST [<pattern>]
292 Creates a list of all existing channels matching the glob pattern
293 <pattern>, e.g. *chat* or bot*.">
295 <helpop key="lusers" value="/LUSERS
297 Shows a count of local and remote users, servers and channels.">
299 <helpop key="userhost" value="/USERHOST <nick> [<nick>]
301 Returns the hostname and nickname of a user, and some other
302 miscellaneous information.">
304 <helpop key="away" value="/AWAY [<message>]
306 If a message is given, marks you as being away, otherwise
307 removes your away status and previous message.">
309 <helpop key="ison" value="/ISON <nick> [<nick> ...]
311 Returns a subset of the nicks you give, showing only those
312 that are currently online.">
314 <helpop key="invite" value="/INVITE <nick> <channel> [<time>]
316 Invites a user to a channel. If the channel is NOT +A, only
317 channel halfoperators or above can invite people. If +A is set,
318 anyone can invite people to the channel, as long as the person
319 doing the invite is a member of the channel they wish to invite
322 Invited users may override bans, +k, and similar in addition to
323 +i, depending on configuration.
325 If a time is provided, the invite expires after that time and the user
326 can no longer use it to enter the channel.">
328 <helpop key="pass" value="/PASS <password>
330 This command is used by your client when setting up
331 your IRC session to submit a server password to the
334 You should not use it during an established connection.">
336 <helpop key="whowas" value="/WHOWAS <nick>
338 Returns a list of times the user was seen recently on IRC along with
339 the time they were last seen and their server.">
341 <helpop key="links" value="/LINKS
343 Shows all servers linked to this one.">
345 <helpop key="map" value="/MAP
347 Shows a graphical representation of all users and servers on the
348 network, and the links between them, as a tree from the perspective
351 <helpop key="whois" value="/WHOIS <nick> [<server>]
353 Returns the WHOIS information of a user, their channels, hostname,
354 etc. If a second nickname or server is provided, then a whois is
355 performed from the server where the user is actually located rather
356 than locally, showing idle and signon times.">
358 <helpop key="time" value="/TIME [<server>]
360 Returns the local time of the server, or remote time of another
363 <helpop key="info" value="/INFO [<server>]
365 Returns information on the developers and supporters who made this
366 IRC server possible.">
368 <helpop key="setname" value="/SETNAME <name>
370 Sets your name to the specified name.">
373 #####################
375 #####################
377 <helpop key="coper" value="Oper Commands
380 OPERMOTD CHECK CLONES USERIP TLINE
381 ALLTIME WALLOPS GLOBOPS
383 SETHOST SETIDENT CHGHOST CHGIDENT CHGNAME
386 SANICK NICKLOCK NICKUNLOCK
388 SAJOIN SAPART SAMODE SATOPIC SAKICK
390 KILL SAQUIT GLINE ZLINE QLINE
391 KLINE RLINE ELINE CBAN SHUN
392 FILTER OJOIN CLEARCHAN
394 CONNECT SQUIT RCONNECT RSQUIT
397 CLEARCACHE LOADMODULE UNLOADMODULE
398 RELOADMODULE GLOADMODULE GUNLOADMODULE
399 GRELOADMODULE CLOSE JUMPSERVER
400 LOCKSERV UNLOCKSERV">
402 <helpop key="userip" value="/USERIP <nick> [<nick>]
404 Returns the ip and nickname of the given users.">
406 <helpop key="tline" value="/TLINE <host/IP mask>
408 This command returns the number of local and global clients matched,
409 and the percentage of clients matched, plus how they were matched
410 (by IP address or by hostname).">
412 <helpop key="lockserv" value="/LOCKSERV
414 Locks out all new connections notifying connecting users that the
415 service is temporarily closed and to try again later.">
417 <helpop key="unlockserv" value="/UNLOCKSERV
419 Opens the server up again for new connections.">
421 <helpop key="jumpserver" value="/JUMPSERVER [<newserver> <newport> <(+|-)[flags]> :[<reason>]]
423 Sets or cancels jumpserver mode. If no parameters are given,
424 jumpserver mode is cancelled, if it is currently set. If parameters
425 are given, a server address must be given for <newserver> and a
426 server port must be given for <newport>. Zero or more status flags
427 should be given for 'flags', from the list below (if you do not
428 wish to specify any flags just place a '+' in this field):
430 1. +a: Redirect all users immediately (except for opers) and cause
431 them to quit with the given reason
433 2. +n: Redirect any new users who connect and cause them to quit
436 You may use + and - to set or unset these flags in the command, the
437 default flags are -a+n, which will just redirect new users. The
438 reason parameter is optional, and if not provided defaults to
439 'Please use this server/port instead' (the default given in various
442 <helpop key="filter" value="/FILTER <filter-definition> [<action> <flags> [<gline-duration>] :<reason>]
444 This command will add a filter when more than one parameter is given,
445 for messages of the types specified by the flags, with the given
446 filter definition, action, gline duration (when the action is 'gline')
449 The filter will take effect when a message of any type specified by
450 the flags and matching the definition is sent to the server, and
451 perform the specified action.
457 Block Blocks message and informs +s IRCops of the blocked message
458 and all relevant info
459 Silent Blocks message, but does not notify IRCops
461 Gline Glines the user for the specified duration
466 p Block private and channel messages
467 n Block private and channel notices
468 P Block part messages
469 q Block quit messages
470 o Don't match against opers
471 c Strip all color codes from the message before matching
472 * Represents all of the above flags
473 - Does nothing, a non-op for when you do not want to specify any
476 The reason for the filter will be used as the reason for the action,
477 unless the action is 'none', and is sent to the user when their text is
478 blocked by 'block' and 'silent' actions.
480 A gline duration may be specified in seconds, or in the format
481 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5
482 minutes and 6 seconds. All fields in this format are optional.
484 When only one parameter is provided (the filter pattern) the provided
485 filter will be removed. Note that if you remove a
486 configuration-defined filter, it will reappear at next rehash unless
487 it is also removed from the config file.">
489 <helpop key="ojoin" value="/OJOIN <channel>
491 Force joins you to the specified channel, and gives you +Y and any other
492 configuration-defined modes on it, preventing you from being kicked.
493 Depending on configuration, may announce that you have joined the
494 channel on official network business.">
496 <helpop key="clones" value="/CLONES <limit>
498 Retrieves a list of users with more clones than the specified
501 <helpop key="check" value="/CHECK <nick|ip|hostmask|channel> [<server>]
503 Allows opers to look up advanced information on channels, hostmasks
504 or IP addresses, in a similar way to WHO but in more detail, displaying
505 most information the IRCD has stored on the target, including all
508 With the second parameter given, runs the command remotely on the
511 <helpop key="alltime" value="/ALLTIME
513 Shows the time on all servers on the network.">
515 <helpop key="rconnect" value="/RCONNECT <source mask> <target mask>
517 The server matching <source mask> will try to connect to the first
518 server in the config file matching <target mask>.">
520 <helpop key="rsquit" value="/RSQUIT <target mask> [<reason>]
522 Causes a remote server matching <target mask> to be disconnected from
525 <helpop key="globops" value="/GLOBOPS <message>
527 Sends a message to all users with the +g snomask.">
529 <helpop key="cban" value="/CBAN <channel> [<duration> :[<reason>]]
531 Sets or removes a channel ban. You must specify all three parameters
532 to add a ban, and one parameter to remove a ban (just the channel).
534 The duration may be specified in seconds, or in the format
535 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
536 5 minutes and 6 seconds. All fields in this format are optional.">
538 <helpop key="sajoin" value="/SAJOIN [<nick>] <channel>[,<channel>]
540 Forces the user to join the channel(s).
541 If no nick is given, it joins the oper doing the /SAJOIN.">
543 <helpop key="sapart" value="/SAPART <nick> <channel>[,<channel>]
545 Forces the user to part the channel(s).">
547 <helpop key="samode" value="/SAMODE <target> (+|-)<modes> [<parameters for modes>]
549 Applies the given mode change to the channel or nick specified.">
551 <helpop key="sanick" value="/SANICK <nick> <new nick>
553 Changes the user's nick to the new nick.">
555 <helpop key="sakick" value="/SAKICK <channel> <nick> <reason>
557 Kicks the given user from the specified channel.">
559 <helpop key="satopic" value="/SATOPIC <channel> <new topic>
561 Applies the given topic to the specified channel.">
563 <helpop key="saquit" value="/SAQUIT <nick> <reason>
565 Forces user to quit with the specified reason.">
567 <helpop key="setidle" value="/SETIDLE <idle time>
569 Sets your idle time (in seconds) to the specified value.">
571 <helpop key="sethost" value="/SETHOST <host>
573 Sets your host to the specified host.">
575 <helpop key="setident" value="/SETIDENT <ident>
577 Sets your ident to the specified ident.">
579 <helpop key="swhois" line="/SWHOIS <nick> <swhois>
581 Sets the user's swhois field to the given swhois.">
583 <helpop key="mkpasswd" value="/MKPASSWD <hashtype> <plaintext>
585 Encodes the plaintext to a hash of the given type and displays
588 <helpop key="opermotd" value="/OPERMOTD
590 Displays the Oper MOTD.">
592 <helpop key="nicklock" value="/NICKLOCK <nick> <new nick>
594 Changes the user's nick to the new nick, and forces
595 it to remain as such for the remainder of the session.">
597 <helpop key="nickunlock" value="/NICKUNLOCK <nick>
599 Allows a previously locked user to change nicks again.">
601 <helpop key="chghost" value="/CHGHOST <nickname> <new hostname>
603 Changes the hostname of the user to the new hostname.">
605 <helpop key="chgname" value="/CHGNAME <nickname> <new name>
607 Changes the name of the user to the new name.">
609 <helpop key="chgident" value="/CHGIDENT <nickname> <new ident>
611 Changes the ident of the user to the new ident.">
613 <helpop key="shun" value="/SHUN <nick!user@host> [[<duration>] :<reason>]
615 Sets or removes a shun (server side ignore) on a host and ident mask.
616 You must specify all three parameters to add a shun, and one parameter
617 to remove a shun (just the nick!user@host section).
619 The duration may be specified in seconds, or in the format
620 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
621 5 minutes and 6 seconds. All fields in this format are optional.">
623 <helpop key="die" value="/DIE <password>
625 This command shuts down the local server. A single parameter is
626 required, which must match the password in the configuration for the
627 command to function.">
629 <helpop key="restart" value="/RESTART <password>
631 This command restarts the local server. A single parameter is
632 required, which must match the password in the configuration for the
633 command to function.">
635 <helpop key="commands" value="/COMMANDS
637 Shows all currently available commands.">
639 <helpop key="kill" value="/KILL <user> <reason>
641 This command will disconnect a user from IRC with the given reason.">
643 <helpop key="rehash" value="/REHASH <mask>
645 This command will cause the server configuration file to be reread and
646 values reinitialized for all servers matching the server mask, or the
647 local server if one is not specified.">
649 <helpop key="connect" value="/CONNECT <servermask>
651 Add a connection to the server matching the given server mask. You must
652 have configured the server for linking in your configuration file
653 before trying to link them.">
655 <helpop key="squit" value="/SQUIT <servermask>
657 Disconnects the server matching the given server mask from this server.">
659 <helpop key="modules" value="/MODULES
661 Lists currently loaded modules, their memory offsets, version numbers,
662 and flags. If you are not an operator, you will see reduced detail.">
664 <helpop key="loadmodule" value="/LOADMODULE <filename.so>
666 Loads the specified module into the local server.">
668 <helpop key="unloadmodule" value="/UNLOADMODULE <filename.so>
670 Unloads a module from the local server. The module cannot have the
671 static flag set (see the output of /MODULES).">
673 <helpop key="reloadmodule" value="/RELOADMODULE <filename.so>
675 Unloads and reloads a module on the local server. This module cannot
676 have the static flag set (see the output of /MODULES).">
678 <helpop key="gloadmodule" value="/GLOADMODULE <filename.so>
680 Loads the specified module on all linked servers.">
682 <helpop key="gunloadmodule" value="/GUNLOADMODULE <filename.so>
684 Unloads a module from all linked servers. The module cannot have the
685 static flag set (see the output of /MODULES).">
687 <helpop key="greloadmodule" value="/GRELOADMODULE <filename.so>
689 Unloads and reloads a module on all linked servers. This module cannot
690 have the static flag set (see the output of /MODULES).">
692 <helpop key="kline" value="/KLINE <user@host> [<duration> :<reason>]
694 Sets or removes a k-line (local host based ban) on a host and ident mask.
695 You must specify all three parameters to add a ban, and one parameter
696 to remove a ban (just the user@host section).
698 The duration may be specified in seconds, or in the format
699 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
700 5 minutes and 6 seconds. All fields in this format are optional.">
702 <helpop key="zline" value="/ZLINE <ipmask> [<duration> :<reason>]
704 Sets or removes a z-line (ip based ban) on an ip range mask.
705 You must specify all three parameters to add a ban, and one parameter
706 to remove a ban (just the ipmask).
708 The duration may be specified in seconds, or in the format
709 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
710 5 minutes and 6 seconds. All fields in this format are optional.">
712 <helpop key="qline" value="/QLINE <nickmask> [<duration> :<reason>]
714 Sets or removes a q-line (nick based ban) on a nick mask.
715 You must specify all three parameters to add a ban, and one parameter
716 to remove a ban (just the nickmask).
718 The duration may be specified in seconds, or in the format
719 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
720 5 minutes and 6 seconds. All fields in this format are optional.">
722 <helpop key="gline" value="/GLINE <user@host> [<duration> :<reason>]
724 Sets or removes a g-line (host based ban) on host mask.
725 You must specify all three parameters to add a ban, and one
726 parameter to remove a ban (just the user@host section).
728 The duration may be specified in seconds, or in the format
729 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
730 5 minutes and 6 seconds. All fields in this format are optional.">
732 <helpop key="eline" value="/ELINE <user@host> [<duration> :<reason>]
734 Sets or removes a e-line (local ban exception) on host mask.
735 You must specify at least 3 parameters to add an exception, and one
736 parameter to remove an exception (just the user@host section).
738 The duration may be specified in seconds, or in the format
739 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
740 5 minutes and 6 seconds. All fields in this format are optional.
742 This command has a few important limitations. Bans on *@<ip> can only
743 be negated by an eline on *@<ip>, bans on *@<host> can be negated by
744 elines on *@<ip>, or *@<host>, and bans on <ident>@* or <ident>@<host>
745 can be negated by any eline that matches.">
747 <helpop key="wallops" value="/WALLOPS <message>
749 Sends a message to all +w users.">
751 <helpop key="rline" value="/RLINE <regex> [<duration> :<reason>]
753 Sets or removes an r-line (regex line) on a n!u@h\\sgecos mask. You
754 must specify all three parameters to add an rline, and one parameter
755 to remove an rline (just the regex).
757 The duration may be specified in seconds, or in the format
758 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
759 5 minutes and 6 seconds. All fields in this format are optional.">
761 <helpop key="clearcache" value="/CLEARCACHE {servername}
763 This command clears the DNS cache of the specified server. If no
764 server is specified, the local server's DNS cache will be cleared.">
766 <helpop key="close" value="/CLOSE
768 Closes all unregistered connections to the local server.">
770 <helpop key="clearchan" value="/CLEARCHAN <channel> [<KILL|KICK|G|Z>] [<reason>]
772 Quits or kicks all non-opers from a channel, optionally G/Z-Lines them.
773 Useful for quickly nuking bot channels.
775 The default method, KILL, simply disconnects the victims from the server,
776 while methods G and Z also add G/Z-Lines for all the targets.
778 When used, the victims won't see each other getting kicked or quitting.">
780 ######################
781 # User/Channel Modes #
782 ######################
784 <helpop key="umodes" value="User Modes
787 c Blocks private messages and notices from users who do
788 not share a common channel with you (requires
790 d Deaf mode. User will not receive any messages or notices
791 from channels they are in (requires deaf module).
792 g In combination with /ACCEPT, provides for server side
793 ignore (requires callerid module).
794 h Marks as 'available for help' in WHOIS (IRCop only,
795 requires helpop module).
796 i Makes invisible to /WHO if the user using /WHO is not in
798 k Prevents the user from being kicked from channels, or
799 having op modes removed from them (services only,
800 requires servprotect module).
801 o Marks as a IRC operator.
802 s <mask> Receives server notices specified by <mask>
804 r Marks as a having a registered nickname
805 (requires services account module).
806 w Receives wallops messages.
807 x Gives a cloaked hostname (requires cloaking module).
808 B Marks as a bot (requires botmode module).
809 G Censors messages sent to the user based on filters
810 configured for the network (requires censor module).
811 H Hides an oper's oper status from WHOIS (requires
813 I Hides a user's entire channel list in WHOIS from
814 non-IRCops (requires hidechans module).
815 R Blocks private messages from unregistered users
816 (requires services account module).
817 S Strips mIRC color/bold/underline codes out of private
818 messages to the user (requires stripcolor module).
819 W Receives notification when a user uses WHOIS on them
820 (IRCop only, requires showwhois module).">
822 <helpop key="chmodes" value="Channel Modes
825 v <nickname> Gives voice to <nickname>, allowing them to speak
826 while the channel is +m.
827 h <nickname> Gives halfop status to <nickname> (requires
828 customprefix module).
829 o <nickname> Gives op status to <nickname>.
830 a <nickname> Gives protected status to <nickname>, preventing
831 them from them from being kicked (+q only,
832 requires customprefix module).
833 q <nickname> Gives owner status to <nickname>, preventing them
834 from being kicked (Services or only, requires
835 customprefix module).
837 b <hostmask> Bans <hostmask> from the channel.
838 e <hostmask> Excepts <hostmask> from bans (requires
839 banexception module).
840 I <hostmask> Excepts <hostmask> from +i, allowing matching
841 users to join while the channel is invite-only
842 (requires inviteexception module).
844 c Blocks messages containing mIRC color codes
845 (requires blockcolor module).
846 d <time> Blocks messages to a channel from new users
847 until they have been in the channel for <time>
848 seconds (requires delaymsg module).
849 f [*]<lines>:<sec> Kicks on text flood equal to or above the
850 specified rate. With *, the user is banned
851 (requires messageflood module).
852 i Makes the channel invite-only.
853 Users can only join if an operator
854 uses /INVITE to invite them.
855 j <joins>:<sec> Limits joins to the specified rate (requires
857 k <key> Set the channel key (password) to <key>.
858 l <limit> Set the maximum allowed users to <limit>.
859 m Enable moderation. Only users with +v, +h, or +o
861 n Blocks users who are not members of the channel
863 p Make channel private, hiding it in users' whoises
864 and replacing it with * in /LIST.
865 r Marks the channel as registered with Services
866 (requires services account module).
867 s Make channel secret, hiding it in users' whoises
869 t Prevents users without +h or +o from changing the
871 u Makes the channel an auditorium; normal users only
872 see themselves or themselves and the operators,
873 while operators see all the users (requires
875 w <flag>:<banmask> Adds basic channel access controls of <flag> to
876 <banmask>, via the +w listmode.
877 For example, +w o:R:Brain will op anyone identified
878 to the account 'Brain' on join.
879 (requires autoop module)
880 z Blocks non-SSL clients from joining the channel.
882 A Allows anyone to invite users to the channel
883 (normally only chanops can invite, requires
885 B Blocks messages with too many capital letters,
886 as determined by the network configuration
887 (requires blockcaps module).
888 C Blocks any CTCPs to the channel (requires noctcp
890 D Delays join messages from users until they
891 message the channel (requires delayjoin module).
892 E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similiar messages.
893 Kicks as default, blocks with ~ and bans with *
894 The last two parameters are optional.
895 F <changes>:<sec> Blocks nick changes when they equal or exceed the
896 specified rate (requires nickflood module).
897 G Censors messages to the channel based on the
898 network configuration (requires censor module).
899 J <seconds> Prevents rejoin after kick for the specified
900 number of seconds. This prevents auto-rejoin
901 (requires kicknorejoin module).
902 K Blocks /KNOCK on the channel.
903 L <channel> If the channel reaches its limit set by +l,
904 redirect users to <channel> (requires redirect
906 M Blocks unregistered users from speaking (requires
907 services account module).
908 N Prevents users on the channel from chainging nick
909 (requires nonicks module).
910 O Channel is IRCops only (can only be set by IRCops,
911 requires operchans module).
912 P Makes the channel permanent; Bans, invites, the
913 topic, modes, and such will not be lost when it
914 empties (can only be set by IRCops, requires
915 permchannels module).
916 Q Only ulined servers and their users can kick
917 (requires nokicks module)
918 R Blocks unregistered users from joining (requires
919 services account module).
920 S Strips mIRC color codes from messages to the
921 channel (requires stripcolor module).
922 T Blocks /NOTICEs to the channel from users who are
923 not at least halfop (requires nonotice module).
925 g <mask> Blocks messages matching the given glob mask
926 (requires chanfilter module).
927 X <mode> Makes channel operators immune to the specified
928 restrictive mode (requires exemptchanops module).
931 NOTE: A large number of these modes are dependent upon server-side modules
932 being loaded by a server/network administrator. The actual modes available
933 on your network may be very different to this list. Please consult your
934 help channel if you have any questions.">
936 ######################
938 ######################
940 <helpop key="stats" value="/STATS <symbol>
942 Shows various server statistics. Depending on configuration, some
943 symbols may be only available to opers.
947 e Show E-lines (local ban exemptions)
948 g Show G-lines (host bans)
949 k Show K-lines (local host bans)
950 q Show Q-lines (nick mask bans)
951 R Show R-lines (regular expression bans)
952 Z Show Z-lines (IP mask bans)
959 d Show configured DNSBLs and related statistics
960 m Show command statistics, number of times commands have been used
961 o Show a list of all valid oper usernames and hostmasks
962 p Show open client ports, and the port type (ssl, plaintext, etc)
964 z Show memory usage statistics
965 i Show connect class permissions
966 l Show all client connections with information (sendq, commands, bytes, time connected)
967 L Show all client connections with information and IP address
968 P Show online opers and their idle times
969 T Show bandwidth/socket statistics
970 U Show U-lined servers
971 Y Show connection classes
972 O Show opertypes and the allowed user and channel modes it can set
973 E Show socket engine events
974 S Show currently held registered nicknames
975 G Show how many local users are connected from each country according to GeoIP
977 Note that all /STATS use is broadcast to online IRC operators.">
979 ######################
981 ######################
983 <helpop key="snomasks" value="Server Notice Masks
985 a Allows receipt of local announcement messages.
986 A Allows receipt of remote announcement messages.
987 c Allows receipt of local connect messages.
988 C Allows receipt of remote connect messages.
989 d Allows receipt of general (and sometimes random) debug
991 f Allows receipt of flooding notices.
992 g Allows receipt of globops (requires globops module).
993 j Allows receipt of channel creation notices (requires
995 J Allows receipt of remote channel creation notices (requires
997 k Allows receipt of local kill messages.
998 K Allows receipt of remote kill messages.
999 l Allows receipt of local linking related
1001 L Allows receipt of remote linking related
1003 n See local nickname changes (requires seenicks module).
1004 N See remote nickname changes (requires seenicks modules).
1005 o Allows receipt of oper-up, oper-down, and oper-failure
1007 O Allows receipt of remote oper-up, oper-down, and oper-failure
1009 q Allows receipt of local quit messages.
1010 Q Allows receipt of remote quit messages.
1011 t Allows receipt of attempts to use /STATS (local and remote).
1012 v Allows receipt of oper-override notices (requires override module).
1013 x Allows receipt of local Xline notices (g/Z/q/k/e/R/shuns).
1014 X Allows receipt of remote Xline notices (g/Z/q/k/e/R/shuns).">
1016 ######################
1018 ######################
1020 <helpop key="extbans" value="Extended Bans
1023 Extbans are split into two types; matching extbans, which match on
1024 users in additional ways, and acting extbans, which restrict users
1025 in different ways to a standard ban.
1027 To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
1028 instead of a normal nick!user@host mask, to ban or exempt matching
1029 users. Ban exceptions on acting extbans exempt that user from matching
1030 an extban of that type, and from any channel mode corresponding to the
1031 restriction. Matching extbans may also be used for invite exceptions by
1032 setting +I <extban>.
1036 j:<channel> Matches anyone in the given channel. Does not support
1037 wildcards (requires channelban module).
1038 r:<realname> Matches users with a matching realname (requires gecosban
1040 s:<server> Matches users on a matching server (requires serverban
1042 z:<certfp> Matches users with a matching SSL certificate fingerprint
1043 (requires sslmodes module)
1044 O:<opertype> Matches IRCops of a matching type, mostly useful as an
1045 an invite exception (requires operchans module).
1046 R:<account> Matches users logged into a matching account (requires
1047 services account module).
1051 c:<banmask> Blocks any messages that contain color codes from
1052 matching users (requires blockcolor module).
1053 m:<banmask> Blocks messages from matching users (requires muteban
1054 module). Users with +v or above are not affected.
1055 p:<banmask> Blocks part messages from matching users (requires
1057 A:<banmask> Blocks invites by matching users even when +A is set
1058 (requires allowinvite module).
1059 B:<banmask> Blocks all capital or nearly all capital messages from
1060 matching users (requires blockcaps module).
1061 C:<banmask> Blocks CTCPs from matching users (requires noctcp
1063 M:<account> Blocks messages from users logged into a matching
1064 account (requires services account module).
1065 N:<banmask> Blocks nick changes from matching users (requires
1067 Q:<banmask> Blocks kicks by matching users (requires nokicks
1069 S:<banmask> Strips color/bold/underline from messages from matching
1070 users (requires stripcolor module).
1071 T:<banmask> Blocks notices from matching users (requires nonotice
1073 U:<banmask> Blocks unregistered users matching the given banmask.
1074 (requires services account).
1076 A ban given to an Acting extban may either be a nick!user@host mask
1077 (unless stated otherwise, for example M: taking an account name),
1078 matched against users as for a normal ban, or a Matching extban.
1080 There is an additional special type of extended ban, a redirect ban:
1082 Redirect n!u@h#channel will redirect the banned user to #channel
1083 when they try to join (requires banredirect module).">