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 OPER 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">
44 <helpop key="sslinfo" value="/SSLINFO <nick>
46 Displays information on the SSL connection and certificate of the
49 <helpop key="uninvite" value="/UNINVITE <nick> <channel>
51 Uninvite a user from a channel, same syntax as INVITE.">
53 <helpop key="tban" value="/TBAN <channel> <duration> <banmask>
55 Sets a timed ban. The duration of the ban can be specified in the
56 following format: 1w2d3h4m6s which indicates a ban of one week, two
57 days, three hours, four minutes and six seconds. Alternatively the
58 ban may just be specified as a number of seconds. All timed bans
59 appear in the banlist as normal bans and may be safely removed
60 before their time is up.">
62 <helpop key="dccallow" value="/DCCALLOW - List allowed nicks
63 /DCCALLOW LIST - This also lists allowed nicks
64 /DCCALLOW +<nick> [<duration>] - Add a nick
65 /DCCALLOW -<nick> - Remove a nick
66 /DCCALLOW HELP - Display help
68 Duration is optional, and may be specified in seconds or in the
71 <helpop key="accept" value="/ACCEPT * - List accepted nicks
72 /ACCEPT +<nick> - Add a nick
73 /ACCEPT -<nick> - Remove a nick
74 This command accepts multiple nicks like so:
75 /ACCEPT +<nick1>,+<nick2>,-<nick3>
77 Manages your accept list. This list is used to determine who can
78 private message you when you have usermode +g set.">
80 <helpop key="cycle" value="/CYCLE <channel> :[<reason>]
82 Cycles a channel (leaving and rejoining), overrides restrictions that
83 would stop a new user joining, such as user limits and channel keys.">
85 <helpop key="title" value="/TITLE <name> <password>
87 Authenticate for a WHOIS title line and optionally a vhost using the
88 specified username and password.">
90 <helpop key="watch" value="/WATCH - List watched nicks that are online
91 /WATCH L - List watched nicks, online and offline
92 /WATCH C - Clear all watched nicks
93 /WATCH S - Show statistics
94 /WATCH +<nick> - Add a nick
95 /WATCH -<nick> - Remove a nick
96 This command accepts multiple nicks like so:
97 /WATCH +<nick1> +<nick2> -<nick3>">
99 <helpop key="vhost" value="/VHOST <username> <password>
101 Authenticate for a vhost using the specified username and password.">
103 <helpop key="remove" value="/REMOVE <channel> <nick> [<reason>]
105 Removes a user from a channel you specify. You must be at least a
106 channel halfoperator to remove a user. A removed user will part with
107 a message stating they were removed from the channel and by whom.">
109 <helpop key="rmode" value="/RMODE [channel] [modeletter] {[pattern]}
111 Removes listmodes from a channel.
112 E.g. /RMODE #Chan b m:* will remove all mute extbans.">
114 <helpop key="fpart" value="/FPART <channel> <nick> [<reason>]
116 This behaves identically to /REMOVE. /REMOVE is a built-in mIRC command
117 which caused trouble for some users.">
119 <helpop key="silence" value="/SILENCE - Shows a list of silenced masks
120 /SILENCE +<mask> [<flags>] - Add a mask
121 /SILENCE -<mask> - Remove a mask
123 A serverside ignore of the given n!u@h mask. The letter(s) at the end
124 specify what is to be ignored from this hostmask.
129 p Block private messages
130 c Block channel messages
132 n Block private notices
133 t Block channel notices
134 a Block all of the above
137 Multiple letters may be specified. For an exception, you must pair x
138 with what you want excepted. For example, if you wanted to except
139 everything from people with a host matching *.foo.net, you would do
140 /SILENCE +*!*@*.foo.net xa
142 /SILENCE without a parameter will list the masks that you have silenced.">
144 <helpop key="knock" value="/KNOCK <channel>
146 Sends a notice to a channel indicating you wish to join.">
148 <helpop key="user" value="/USER <ident> <local host> <remote host> :<GECOS>
150 This command is used by your client to register your
151 IRC session, providing your ident and GECOS to the
154 You should not use it during an established connection.">
156 <helpop key="nick" value="/NICK <new nick>
158 Change your nickname to <new nick>.">
160 <helpop key="quit" value="/QUIT [<reason>]
162 Quit from IRC and end your current session.">
164 <helpop key="version" value="/VERSION
166 Returns the server's version information.">
168 <helpop key="ping" value="/PING <server>
170 Ping a server. The server will answer with a PONG.">
172 <helpop key="pong" value="/PONG <server>
174 Your client should send this to answer server PINGs. You
175 should not issue this command manually.">
177 <helpop key="admin" value="/ADMIN [<server>]
179 Shows the administrative information for the given server.">
181 <helpop key="privmsg" value="/PRIVMSG <target> <text>
183 Sends a message to a user or channel specified in <target>.">
185 <helpop key="notice" value="/NOTICE <target> <text>
187 Sends a notice to a user or channel specified in <target>.">
189 <helpop key="join" value="/JOIN <channel>[,<channel>] [<key>][,<key>]
191 Joins one or more channels you provide the names for.">
193 <helpop key="names" value="/NAMES <channel>[,<channel>]
195 Return a list of users on the channels you provide.">
197 <helpop key="part" value="/PART <channel>[,<channel>] [<reason>]
199 Leaves one or more channels you specify.">
201 <helpop key="kick" value="/KICK <channel> <nick>[,<nick>] [<reason>]
203 Kicks a user from a channel you specify. You must be
204 at least a channel halfoperator to kick a user.">
206 <helpop key="mode" value="/MODE <target> (+|-)<modes> [<mode parameters>] - Change modes of <target>.
208 /MODE <target> - Show modes of <target>.
210 /MODE <channel> <list mode char> - List bans, exceptions, etc. set on <channel>.
212 Sets the mode for a channel or a nickname specified in <target>.
213 A user may only set modes upon themselves, and may not set the
214 +o usermode, and a user may only change channel modes of
215 channels where they are at least a halfoperator.
217 For a list of all user and channel modes, enter /HELPOP UMODES or
220 <helpop key="topic" value="/TOPIC <channel> [<topic>]
222 Sets or retrieves the channel topic. If a channel topic is
223 given in the command and either the channel is not +t, or
224 you are at least a halfoperator, the channel topic will be
225 changed to the new one you provide.">
227 <helpop key="who" value="/WHO <search pattern> [ohurmaiMplf]
229 Looks up the information of users matching the range you provide.
230 You may only /WHO nicknames in channels or on servers where you
231 share a common channel with them, or ones which are not +i (unless
232 you are an IRC operator). The search-pattern may be a special
233 sequence of characters determined by the flags given below, or
234 it may be one of a nickname, a channel, a hostmask, an ip address
235 mask or a server mask.
240 The following flags after the mask have the following effects:
242 o Show online IRC operators matching the mask
244 a Show all users who have an away message matching the given mask
245 i Show all users who have an ident (username) matching the given mask
246 p Show all users who are connected on the given port number (IRC
248 r Show all users whose realnames match the mask. When this
249 flag is set it overrides the meaning of the search-pattern,
250 which must contain a glob pattern intended to match GECOS
252 m Search for all users with a given set of user modes. When
253 this flag is set it overrides the meaning of the
254 search-pattern, which must contain the mode sequence to
255 search for, for example to find all users with +i and
256 without +s, issue the command WHO +i-s m (IRC operators only)
257 t Show users connected within this number of seconds
258 M Show all users who have metadata attached to them with
259 the given key name (IRC operators only)
261 f Show only remote (far) users
262 l Show only local users
264 h Show real hostnames rather than masked hostnames (IRC
266 u Unlimit the results past the maximum /who results value
269 You may combine multiple flags in one WHO command except where stated in the table above.">
271 <helpop key="motd" value="/MOTD [<server>]
273 Show the message of the day for <server>. Messages of the day often
274 contain important server rules and notices and should be read prior
277 <helpop key="oper" value="/OPER <login> <password>
279 Attempts to authenticate a user as an IRC operator.
281 Both successful and unsuccessful oper attempts are
282 logged, and sent to online IRC operators.">
284 <helpop key="list" value="/LIST [<pattern>]
286 Creates a list of all existing channels matching the glob pattern
287 <pattern>, e.g. *chat* or bot*.">
289 <helpop key="lusers" value="/LUSERS
291 Shows a count of local and remote users, servers and channels.">
293 <helpop key="userhost" value="/USERHOST <nick> [<nick>]
295 Returns the hostname and nickname of a user, and some other
296 miscellaneous information.">
298 <helpop key="away" value="/AWAY [<message>]
300 If a message is given, marks you as being away, otherwise
301 removes your away status and previous message.">
303 <helpop key="ison" value="/ISON <nick> [<nick> ...]
305 Returns a subset of the nicks you give, showing only those
306 that are currently online.">
308 <helpop key="invite" value="/INVITE <nick> <channel> [<time>]
310 Invites a user to a channel. If the channel is NOT +A, only
311 channel halfoperators or above can invite people. If +A is set,
312 anyone can invite people to the channel, as long as the person
313 doing the invite is a member of the channel they wish to invite
316 Invited users may override bans, +k, and similar in addition to
317 +i, depending on configuration.
319 If a time is provided, the invite expires after that time and the user
320 can no longer use it to enter the channel.">
322 <helpop key="pass" value="/PASS <password>
324 This command is used by your client when setting up
325 your IRC session to submit a server password to the
328 You should not use it during an established connection.">
330 <helpop key="whowas" value="/WHOWAS <nick>
332 Returns a list of times the user was seen recently on IRC along with
333 the time they were last seen and their server.">
335 <helpop key="links" value="/LINKS
337 Shows all servers linked to this one.">
339 <helpop key="map" value="/MAP
341 Shows a graphical representation of all users and servers on the
342 network, and the links between them, as a tree from the perspective
345 <helpop key="whois" value="/WHOIS <nick> [<server>]
347 Returns the WHOIS information of a user, their channels, hostname,
348 etc. If a second nickname or server is provided, then a whois is
349 performed from the server where the user is actually located rather
350 than locally, showing idle and signon times.">
352 <helpop key="time" value="/TIME [<server>]
354 Returns the local time of the server, or remote time of another
357 <helpop key="info" value="/INFO [<server>]
359 Returns information on the developers and supporters who made this
360 IRC server possible.">
362 <helpop key="setname" value="/SETNAME <name>
364 Sets your name to the specified name.">
367 #####################
369 #####################
371 <helpop key="coper" value="Oper Commands
374 OPERMOTD CHECK CLONES USERIP TLINE
375 ALLTIME WALLOPS GLOBOPS MODENOTICE
378 SETHOST SETIDENT CHGHOST CHGIDENT CHGNAME
381 SANICK NICKLOCK NICKUNLOCK
383 SAJOIN SAPART SAMODE SATOPIC SAKICK
385 KILL SAQUIT GLINE ZLINE QLINE
386 KLINE RLINE ELINE CBAN SHUN
387 FILTER OJOIN CLEARCHAN
389 CONNECT SQUIT RCONNECT RSQUIT
392 CLEARCACHE LOADMODULE UNLOADMODULE
393 RELOADMODULE GLOADMODULE GUNLOADMODULE
394 GRELOADMODULE CLOSE JUMPSERVER
395 LOCKSERV UNLOCKSERV">
397 <helpop key="userip" value="/USERIP <nick> [<nick>]
399 Returns the ip and nickname of the given users.">
401 <helpop key="tline" value="/TLINE <host/IP mask>
403 This command returns the number of local and global clients matched,
404 and the percentage of clients matched, plus how they were matched
405 (by IP address or by hostname).">
407 <helpop key="lockserv" value="/LOCKSERV :[<message>]
409 Locks out all new connections notifying connecting users that the
410 service is temporarily closed and to try again later.">
412 <helpop key="unlockserv" value="/UNLOCKSERV
414 Opens the server up again for new connections.">
416 <helpop key="jumpserver" value="/JUMPSERVER [<newserver> <newport> <(+|-)[flags]> :[<reason>]]
418 Sets or cancels jumpserver mode. If no parameters are given,
419 jumpserver mode is cancelled, if it is currently set. If parameters
420 are given, a server address must be given for <newserver> and a
421 server port must be given for <newport>. Zero or more status flags
422 should be given for 'flags', from the list below (if you do not
423 wish to specify any flags just place a '+' in this field):
425 1. +a: Redirect all users immediately (except for opers) and cause
426 them to quit with the given reason
428 2. +n: Redirect any new users who connect and cause them to quit
431 You may use + and - to set or unset these flags in the command, the
432 default flags are -a+n, which will just redirect new users. The
433 reason parameter is optional, and if not provided defaults to
434 'Please use this server/port instead' (the default given in various
437 <helpop key="filter" value="/FILTER <filter-definition> [<action> <flags> [<duration>] :<reason>]
439 This command will add a filter when more than one parameter is given,
440 for messages of the types specified by the flags, with the given
441 filter definition, action, duration (when the action is 'gline' or 'shun'),
444 The filter will take effect when a message of any type specified by
445 the flags and matching the definition is sent to the server, and
446 perform the specified action.
452 Block Blocks message and informs +s IRCops of the blocked message
453 and all relevant info
454 Silent Blocks message, but does not notify IRCops
456 Gline Glines the user for the specified duration
457 Shun Shuns the user for the specified duration (requires the shun module)
462 p Block private and channel messages
463 n Block private and channel notices
464 P Block part messages
465 q Block quit messages
466 o Don't match against opers
467 c Strip all color codes from the message before matching
468 * Represents all of the above flags
469 - Does nothing, a non-op for when you do not want to specify any
472 The reason for the filter will be used as the reason for the action,
473 unless the action is 'none', and is sent to the user when their text is
474 blocked by 'block' and 'silent' actions.
476 A gline duration may be specified in seconds, or in the format
477 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5
478 minutes and 6 seconds. All fields in this format are optional.
480 When only one parameter is provided (the filter pattern) the provided
481 filter will be removed. Note that if you remove a
482 configuration-defined filter, it will reappear at next rehash unless
483 it is also removed from the config file.">
485 <helpop key="ojoin" value="/OJOIN <channel>
487 Force joins you to the specified channel, and gives you +Y and any other
488 configuration-defined modes on it, preventing you from being kicked.
489 Depending on configuration, may announce that you have joined the
490 channel on official network business.">
492 <helpop key="clones" value="/CLONES <limit>
494 Retrieves a list of users with more clones than the specified
497 <helpop key="check" value="/CHECK <nick|ip|hostmask|channel> [<server>]
499 Allows opers to look up advanced information on channels, hostmasks
500 or IP addresses, in a similar way to WHO but in more detail, displaying
501 most information the IRCD has stored on the target, including all
504 With the second parameter given, runs the command remotely on the
507 <helpop key="alltime" value="/ALLTIME
509 Shows the time on all servers on the network.">
511 <helpop key="rconnect" value="/RCONNECT <source mask> <target mask>
513 The server matching <source mask> will try to connect to the first
514 server in the config file matching <target mask>.">
516 <helpop key="rsquit" value="/RSQUIT <target mask> [<reason>]
518 Causes a remote server matching <target mask> to be disconnected from
521 <helpop key="globops" value="/GLOBOPS <message>
523 Sends a message to all users with the +g snomask.">
525 <helpop key="cban" value="/CBAN <channel> [<duration> :[<reason>]]
527 Sets or removes a channel ban. You must specify all three parameters
528 to add a ban, and one parameter to remove a ban (just the channel).
530 The duration may be specified in seconds, or in the format
531 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
532 5 minutes and 6 seconds. All fields in this format are optional.">
534 <helpop key="sajoin" value="/SAJOIN [<nick>] <channel>[,<channel>]
536 Forces the user to join the channel(s).
537 If no nick is given, it joins the oper doing the /SAJOIN.">
539 <helpop key="sapart" value="/SAPART <nick> <channel>[,<channel>]
541 Forces the user to part the channel(s).">
543 <helpop key="samode" value="/SAMODE <target> (+|-)<modes> [<parameters for modes>]
545 Applies the given mode change to the channel or nick specified.">
547 <helpop key="sanick" value="/SANICK <nick> <new nick>
549 Changes the user's nick to the new nick.">
551 <helpop key="sakick" value="/SAKICK <channel> <nick> <reason>
553 Kicks the given user from the specified channel.">
555 <helpop key="satopic" value="/SATOPIC <channel> <new topic>
557 Applies the given topic to the specified channel.">
559 <helpop key="saquit" value="/SAQUIT <nick> <reason>
561 Forces user to quit with the specified reason.">
563 <helpop key="setidle" value="/SETIDLE <idle time>
565 Sets your idle time (in seconds) to the specified value.">
567 <helpop key="sethost" value="/SETHOST <host>
569 Sets your host to the specified host.">
571 <helpop key="setident" value="/SETIDENT <ident>
573 Sets your ident to the specified ident.">
575 <helpop key="swhois" line="/SWHOIS <nick> <swhois>
577 Sets the user's swhois field to the given swhois.">
579 <helpop key="mkpasswd" value="/MKPASSWD <hashtype> <plaintext>
581 Encodes the plaintext to a hash of the given type and displays
584 <helpop key="opermotd" value="/OPERMOTD
586 Displays the Oper MOTD.">
588 <helpop key="nicklock" value="/NICKLOCK <nick> <new nick>
590 Changes the user's nick to the new nick, and forces
591 it to remain as such for the remainder of the session.">
593 <helpop key="nickunlock" value="/NICKUNLOCK <nick>
595 Allows a previously locked user to change nicks again.">
597 <helpop key="chghost" value="/CHGHOST <nickname> <new hostname>
599 Changes the hostname of the user to the new hostname.">
601 <helpop key="chgname" value="/CHGNAME <nickname> <new name>
603 Changes the name of the user to the new name.">
605 <helpop key="chgident" value="/CHGIDENT <nickname> <new ident>
607 Changes the ident of the user to the new ident.">
609 <helpop key="shun" value="/SHUN <nick!user@host> [[<duration>] :<reason>]
611 Sets or removes a shun (server side ignore) on a host and ident mask.
612 You must specify all three parameters to add a shun, and one parameter
613 to remove a shun (just the nick!user@host section).
615 The duration may be specified in seconds, or in the format
616 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
617 5 minutes and 6 seconds. All fields in this format are optional.">
619 <helpop key="die" value="/DIE <server>
621 This command shuts down the local server. A single parameter is
622 required, which must match the name of the local server.">
624 <helpop key="restart" value="/RESTART <server>
626 This command restarts the local server. A single parameter is
627 required, which must match the name of the local server.">
629 <helpop key="commands" value="/COMMANDS
631 Shows all currently available commands.">
633 <helpop key="kill" value="/KILL <user> <reason>
635 This command will disconnect a user from IRC with the given reason.">
637 <helpop key="rehash" value="/REHASH <mask>
639 This command will cause the server configuration file to be reread and
640 values reinitialized for all servers matching the server mask, or the
641 local server if one is not specified.">
643 <helpop key="connect" value="/CONNECT <servermask>
645 Add a connection to the server matching the given server mask. You must
646 have configured the server for linking in your configuration file
647 before trying to link them.">
649 <helpop key="squit" value="/SQUIT <servermask>
651 Disconnects the server matching the given server mask from this server.">
653 <helpop key="modules" value="/MODULES
655 Lists currently loaded modules, their memory offsets, version numbers,
656 and flags. If you are not an operator, you will see reduced detail.">
658 <helpop key="loadmodule" value="/LOADMODULE <modname>
660 Loads the specified module into the local server.">
662 <helpop key="unloadmodule" value="/UNLOADMODULE <modname>
664 Unloads a module from the local server. The module cannot have the
665 static flag set (see the output of /MODULES).">
667 <helpop key="reloadmodule" value="/RELOADMODULE <modname>
669 Unloads and reloads a module on the local server. This module cannot
670 have the static flag set (see the output of /MODULES).">
672 <helpop key="gloadmodule" value="/GLOADMODULE <modname>
674 Loads the specified module on all linked servers.">
676 <helpop key="gunloadmodule" value="/GUNLOADMODULE <modname>
678 Unloads a module from all linked servers. The module cannot have the
679 static flag set (see the output of /MODULES).">
681 <helpop key="greloadmodule" value="/GRELOADMODULE <modname>
683 Unloads and reloads a module on all linked servers. This module cannot
684 have the static flag set (see the output of /MODULES).">
686 <helpop key="kline" value="/KLINE <user@host> [<duration> :<reason>]
688 Sets or removes a k-line (local host based ban) on a host and ident mask.
689 You must specify all three parameters to add a ban, and one parameter
690 to remove a ban (just the user@host section).
692 The duration may be specified in seconds, or in the format
693 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
694 5 minutes and 6 seconds. All fields in this format are optional.">
696 <helpop key="zline" value="/ZLINE <ipmask> [<duration> :<reason>]
698 Sets or removes a z-line (ip based ban) on an ip range mask.
699 You must specify all three parameters to add a ban, and one parameter
700 to remove a ban (just the ipmask).
702 The duration may be specified in seconds, or in the format
703 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
704 5 minutes and 6 seconds. All fields in this format are optional.">
706 <helpop key="qline" value="/QLINE <nickmask> [<duration> :<reason>]
708 Sets or removes a q-line (nick based ban) on a nick mask.
709 You must specify all three parameters to add a ban, and one parameter
710 to remove a ban (just the nickmask).
712 The duration may be specified in seconds, or in the format
713 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
714 5 minutes and 6 seconds. All fields in this format are optional.">
716 <helpop key="gline" value="/GLINE <user@host> [<duration> :<reason>]
718 Sets or removes a g-line (host based ban) on host mask.
719 You must specify all three parameters to add a ban, and one
720 parameter to remove a ban (just the user@host section).
722 The duration may be specified in seconds, or in the format
723 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
724 5 minutes and 6 seconds. All fields in this format are optional.">
726 <helpop key="eline" value="/ELINE <user@host> [<duration> :<reason>]
728 Sets or removes a e-line (global ban exception) on host mask.
729 You must specify at least 3 parameters to add an exception, and one
730 parameter to remove an exception (just the user@host section).
732 The duration may be specified in seconds, or in the format
733 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
734 5 minutes and 6 seconds. All fields in this format are optional.
736 This command has a few important limitations. Bans on *@<ip> can only
737 be negated by an eline on *@<ip>, bans on *@<host> can be negated by
738 elines on *@<ip>, or *@<host>, and bans on <ident>@* or <ident>@<host>
739 can be negated by any eline that matches.">
741 <helpop key="wallops" value="/WALLOPS <message>
743 Sends a message to all +w users.">
745 <helpop key="rline" value="/RLINE <regex> [<duration> :<reason>]
747 Sets or removes an r-line (regex line) on a n!u@h\\sgecos mask. You
748 must specify all three parameters to add an rline, and one parameter
749 to remove an rline (just the regex).
751 The duration may be specified in seconds, or in the format
752 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
753 5 minutes and 6 seconds. All fields in this format are optional.">
755 <helpop key="clearcache" value="/CLEARCACHE
757 This command clears the DNS cache of the local server.">
759 <helpop key="close" value="/CLOSE
761 Closes all unregistered connections to the local server.">
763 <helpop key="clearchan" value="/CLEARCHAN <channel> [<KILL|KICK|G|Z>] [<reason>]
765 Quits or kicks all non-opers from a channel, optionally G/Z-Lines them.
766 Useful for quickly nuking bot channels.
768 The default method, KILL, simply disconnects the victims from the server,
769 while methods G and Z also add G/Z-Lines for all the targets.
771 When used, the victims won't see each other getting kicked or quitting.">
773 <helpop key="modenotice" value="/MODENOTICE <modeletters> <message>
775 Sends a notice to all users who have the given mode(s) set.
776 If multiple mode letters are given, the notice is only sent to users
777 who have all of them set.">
779 <helpop key="cloak" value="/CLOAK <host>
781 Generate the cloak of a host or IP. This is useful for example when
782 trying to get the cloak of a user from /WHOWAS and they were not
783 using their cloak when they quit.">
785 ######################
786 # User/Channel Modes #
787 ######################
789 <helpop key="umodes" value="User Modes
792 c Blocks private messages and notices from users who do
793 not share a common channel with you (requires
795 d Deaf mode. User will not receive any messages or notices
796 from channels they are in (requires deaf module).
797 g In combination with /ACCEPT, provides for server side
798 ignore (requires callerid module).
799 h Marks as 'available for help' in WHOIS (IRCop only,
800 requires helpop module).
801 i Makes invisible to /WHO if the user using /WHO is not in
803 k Prevents the user from being kicked from channels, or
804 having op modes removed from them (services only,
805 requires servprotect module).
806 o Marks as a IRC operator.
807 s <mask> Receives server notices specified by <mask>
809 r Marks as a having a registered nickname
810 (requires services account module).
811 w Receives wallops messages.
812 x Gives a cloaked hostname (requires cloaking module).
813 z Only allow private messages from SSL users (requires
815 B Marks as a bot (requires botmode module).
816 G Censors messages sent to the user based on filters
817 configured for the network (requires censor module).
818 H Hides an oper's oper status from WHOIS (requires
820 I Hides a user's entire channel list in WHOIS from
821 non-IRCops (requires hidechans module).
822 L Stops redirections done by m_redirect (mode must be
823 enabled in the config).
824 R Blocks private messages from unregistered users
825 (requires services account module).
826 S Strips mIRC color/bold/underline codes out of private
827 messages to the user (requires stripcolor module).
828 W Receives notification when a user uses WHOIS on them
829 (IRCop only, requires showwhois module).">
831 <helpop key="chmodes" value="Channel Modes
834 v <nickname> Gives voice to <nickname>, allowing them to speak
835 while the channel is +m.
836 h <nickname> Gives halfop status to <nickname> (requires
837 customprefix module).
838 o <nickname> Gives op status to <nickname>.
839 a <nickname> Gives protected status to <nickname>, preventing
840 them from them from being kicked (+q only,
841 requires customprefix module).
842 q <nickname> Gives owner status to <nickname>, preventing them
843 from being kicked (Services or only, requires
844 customprefix module).
846 b <hostmask> Bans <hostmask> from the channel.
847 e <hostmask> Excepts <hostmask> from bans (requires
848 banexception module).
849 I <hostmask> Excepts <hostmask> from +i, allowing matching
850 users to join while the channel is invite-only
851 (requires inviteexception module).
853 c Blocks messages containing mIRC color codes
854 (requires blockcolor module).
855 d <time> Blocks messages to a channel from new users
856 until they have been in the channel for <time>
857 seconds (requires delaymsg module).
858 f [*]<lines>:<sec> Kicks on text flood equal to or above the
859 specified rate. With *, the user is banned
860 (requires messageflood module).
861 i Makes the channel invite-only.
862 Users can only join if an operator
863 uses /INVITE to invite them.
864 j <joins>:<sec> Limits joins to the specified rate (requires
866 k <key> Set the channel key (password) to <key>.
867 l <limit> Set the maximum allowed users to <limit>.
868 m Enable moderation. Only users with +v, +h, or +o
870 n Blocks users who are not members of the channel
872 p Make channel private, hiding it in users' whoises
873 and replacing it with * in /LIST.
874 r Marks the channel as registered with Services
875 (requires services account module).
876 s Make channel secret, hiding it in users' whoises
878 t Prevents users without +h or +o from changing the
880 u Makes the channel an auditorium; normal users only
881 see themselves or themselves and the operators,
882 while operators see all the users (requires
884 w <flag>:<banmask> Adds basic channel access controls of <flag> to
885 <banmask>, via the +w listmode.
886 For example, +w o:R:Brain will op anyone identified
887 to the account 'Brain' on join.
888 (requires autoop module)
889 z Blocks non-SSL clients from joining the channel.
891 A Allows anyone to invite users to the channel
892 (normally only chanops can invite, requires
894 B Blocks messages with too many capital letters,
895 as determined by the network configuration
896 (requires blockcaps module).
897 C Blocks any CTCPs to the channel (requires noctcp
899 D Delays join messages from users until they
900 message the channel (requires delayjoin module).
901 E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similar messages.
902 Kicks as default, blocks with ~ and bans with *
903 The last two parameters are optional.
904 F <changes>:<sec> Blocks nick changes when they equal or exceed the
905 specified rate (requires nickflood module).
906 G Censors messages to the channel based on the
907 network configuration (requires censor module).
908 H <num>:<duration> Displays the last <num> lines of chat to joining
909 users. <duration> is the maximum time to keep
910 lines in the history buffer (requires chanhistory
912 J <seconds> Prevents rejoin after kick for the specified
913 number of seconds. This prevents auto-rejoin
914 (requires kicknorejoin module).
915 K Blocks /KNOCK on the channel.
916 L <channel> If the channel reaches its limit set by +l,
917 redirect users to <channel> (requires redirect
919 M Blocks unregistered users from speaking (requires
920 services account module).
921 N Prevents users on the channel from changing nick
922 (requires nonicks module).
923 O Channel is IRCops only (can only be set by IRCops,
924 requires operchans module).
925 P Makes the channel permanent; Bans, invites, the
926 topic, modes, and such will not be lost when it
927 empties (can only be set by IRCops, requires
928 permchannels module).
929 Q Only ulined servers and their users can kick
930 (requires nokicks module)
931 R Blocks unregistered users from joining (requires
932 services account module).
933 S Strips mIRC color codes from messages to the
934 channel (requires stripcolor module).
935 T Blocks /NOTICEs to the channel from users who are
936 not at least halfop (requires nonotice module).
938 g <mask> Blocks messages matching the given glob mask
939 (requires chanfilter module).
940 X <mode> Makes channel operators immune to the specified
941 restrictive mode (requires exemptchanops module).
944 NOTE: A large number of these modes are dependent upon server-side modules
945 being loaded by a server/network administrator. The actual modes available
946 on your network may be very different to this list. Please consult your
947 help channel if you have any questions.">
949 ######################
951 ######################
953 <helpop key="stats" value="/STATS <symbol>
955 Shows various server statistics. Depending on configuration, some
956 symbols may be only available to opers.
960 e Show E-lines (local ban exemptions)
961 g Show G-lines (host bans)
962 k Show K-lines (local host bans)
963 q Show Q-lines (nick mask bans)
964 R Show R-lines (regular expression bans)
965 Z Show Z-lines (IP mask bans)
972 d Show configured DNSBLs and related statistics
973 m Show command statistics, number of times commands have been used
974 o Show a list of all valid oper usernames and hostmasks
975 p Show open client ports, and the port type (ssl, plaintext, etc)
977 z Show memory usage statistics
978 i Show connect class permissions
979 l Show all client connections with information (sendq, commands, bytes, time connected)
980 L Show all client connections with information and IP address
981 P Show online opers and their idle times
982 T Show bandwidth/socket statistics
983 U Show U-lined servers
984 Y Show connection classes
985 O Show opertypes and the allowed user and channel modes it can set
986 E Show socket engine events
987 S Show currently held registered nicknames
988 G Show how many local users are connected from each country according to GeoIP
990 Note that all /STATS use is broadcast to online IRC operators.">
992 ######################
994 ######################
996 <helpop key="snomasks" value="Server Notice Masks
998 a Allows receipt of local announcement messages.
999 A Allows receipt of remote announcement messages.
1000 c Allows receipt of local connect messages.
1001 C Allows receipt of remote connect messages.
1002 d Allows receipt of general (and sometimes random) debug
1004 f Allows receipt of flooding notices.
1005 g Allows receipt of globops (requires globops module).
1006 j Allows receipt of channel creation notices (requires
1008 J Allows receipt of remote channel creation notices (requires
1010 k Allows receipt of local kill messages.
1011 K Allows receipt of remote kill messages.
1012 l Allows receipt of local linking related
1014 L Allows receipt of remote linking related
1016 n See local nickname changes (requires seenicks module).
1017 N See remote nickname changes (requires seenicks modules).
1018 o Allows receipt of oper-up, oper-down, and oper-failure
1020 O Allows receipt of remote oper-up, oper-down, and oper-failure
1022 q Allows receipt of local quit messages.
1023 Q Allows receipt of remote quit messages.
1024 t Allows receipt of attempts to use /STATS (local and remote).
1025 v Allows receipt of oper-override notices (requires override module).
1026 x Allows receipt of local Xline notices (g/Z/q/k/e/R/shuns).
1027 X Allows receipt of remote Xline notices (g/Z/q/k/e/R/shuns).">
1029 ######################
1031 ######################
1033 <helpop key="extbans" value="Extended Bans
1036 Extbans are split into two types; matching extbans, which match on
1037 users in additional ways, and acting extbans, which restrict users
1038 in different ways to a standard ban.
1040 To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
1041 instead of a normal nick!user@host mask, to ban or exempt matching
1042 users. Ban exceptions on acting extbans exempt that user from matching
1043 an extban of that type, and from any channel mode corresponding to the
1044 restriction. Matching extbans may also be used for invite exceptions by
1045 setting +I <extban>.
1049 j:<channel> Matches anyone in the given channel. Does not support
1050 wildcards (requires channelban module).
1051 n:<class> Matches users in a matching connect class (requires
1053 r:<realname> Matches users with a matching realname (requires gecosban
1055 s:<server> Matches users on a matching server (requires serverban
1057 z:<certfp> Matches users with a matching SSL certificate fingerprint
1058 (requires sslmodes module)
1059 O:<opertype> Matches IRCops of a matching type, mostly useful as an
1060 an invite exception (requires operchans module).
1061 R:<account> Matches users logged into a matching account (requires
1062 services account module).
1063 U:<banmask> Matches unregistered users matching the given banmask.
1064 (requires services account module).
1068 c:<banmask> Blocks any messages that contain color codes from
1069 matching users (requires blockcolor module).
1070 m:<banmask> Blocks messages from matching users (requires muteban
1071 module). Users with +v or above are not affected.
1072 p:<banmask> Blocks part messages from matching users (requires
1074 A:<banmask> Blocks invites by matching users even when +A is set
1075 (requires allowinvite module).
1076 B:<banmask> Blocks all capital or nearly all capital messages from
1077 matching users (requires blockcaps module).
1078 C:<banmask> Blocks CTCPs from matching users (requires noctcp
1080 N:<banmask> Blocks nick changes from matching users (requires
1082 Q:<banmask> Blocks kicks by matching users (requires nokicks
1084 S:<banmask> Strips color/bold/underline from messages from matching
1085 users (requires stripcolor module).
1086 T:<banmask> Blocks notices from matching users (requires nonotice
1089 A ban given to an Acting extban may either be a nick!user@host mask
1090 (unless stated otherwise), matched against users as for a normal ban,
1091 or a Matching extban.
1093 There is an additional special type of extended ban, a redirect ban:
1095 Redirect n!u@h#channel will redirect the banned user to #channel
1096 when they try to join (requires banredirect module).">