7 <alias text="HELP" replace="HELPOP $2-">
9 <helpop key="start" value="InspIRCd Help System
11 This system provides help for commands and modes.
12 Specify your question or a command name as the
13 parameter for this command.
15 /HELPOP CUSER - To see a list of user commands
16 /HELPOP COPER - To see a list of oper commands
17 /HELPOP UMODES - To see a list of user modes
18 /HELPOP CHMODES - To see a list of channel modes
19 /HELPOP SNOMASKS - To see a list of oper snotice masks
20 /HELPOP EXTBANS - To see a list of extended bans">
22 <helpop key="nohelp" value="There is no help for the topic
23 you searched for. Please try again.">
29 <helpop key="cuser" value="User Commands
32 PRIVMSG NOTICE NICK JOIN PART
33 CYCLE KNOCK MODE OPER TOPIC
34 KICK FPART REMOVE TBAN INVITE
35 UNINVITE AWAY DCCALLOW SILENCE ACCEPT
36 MKPASSWD VHOST TITLE SETNAME
38 WHOIS WHOWAS ISON USERHOST WATCH
40 ADMIN MAP LINKS LUSERS TIME
41 STATS VERSION INFO MODULES COMMANDS
44 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 built-in mIRC command
119 which caused trouble for some users.">
121 <helpop key="silence" value="/SILENCE - Shows a list of silenced masks
122 /SILENCE +<mask> [<flags>] - Add a mask
123 /SILENCE -<mask> - Remove a mask
125 A serverside ignore of the given n!u@h mask. The letter(s) at the end
126 specify what is to be ignored from this hostmask.
131 p Block private messages
132 c Block channel messages
134 n Block private notices
135 t Block channel notices
136 a Block all of the above
139 Multiple letters may be specified. For an exception, you must pair x
140 with what you want excepted. For example, if you wanted to except
141 everything from people with a host matching *.foo.net, you would do
142 /SILENCE +*!*@*.foo.net xa
144 /SILENCE without a parameter will list the masks that you have silenced.">
146 <helpop key="knock" value="/KNOCK <channel>
148 Sends a notice to a channel indicating you wish to join.">
150 <helpop key="user" value="/USER <ident> <local host> <remote host> :<real name>
152 This command is used by your client to register your
153 IRC session, providing your ident and real name to the
156 You should not use it during an established connection.">
158 <helpop key="nick" value="/NICK <new nick>
160 Change your nickname to <new nick>.">
162 <helpop key="quit" value="/QUIT [<reason>]
164 Quit from IRC and end your current session.">
166 <helpop key="version" value="/VERSION
168 Returns the server's version information.">
170 <helpop key="ping" value="/PING <server>
172 Ping a server. The server will answer with a PONG.">
174 <helpop key="pong" value="/PONG <server>
176 Your client should send this to answer server PINGs. You
177 should not issue this command manually.">
179 <helpop key="admin" value="/ADMIN [<server>]
181 Shows the administrative information for the given server.">
183 <helpop key="privmsg" value="/PRIVMSG <target> <text>
185 Sends a message to a user or channel specified in <target>.">
187 <helpop key="notice" value="/NOTICE <target> <text>
189 Sends a notice to a user or channel specified in <target>.">
191 <helpop key="join" value="/JOIN <channel>[,<channel>] [<key>][,<key>]
193 Joins one or more channels you provide the names for.">
195 <helpop key="names" value="/NAMES <channel>[,<channel>]
197 Return a list of users on the channels you provide.">
199 <helpop key="part" value="/PART <channel>[,<channel>] [<reason>]
201 Leaves one or more channels you specify.">
203 <helpop key="kick" value="/KICK <channel> <nick>[,<nick>] [<reason>]
205 Kicks a user from a channel you specify. You must be
206 at least a channel halfoperator to kick a user.">
208 <helpop key="mode" value="/MODE <target> (+|-)<modes> [<mode parameters>] - Change modes of <target>.
210 /MODE <target> - Show modes of <target>.
212 /MODE <channel> <list mode char> - List bans, exceptions, etc. set on <channel>.
214 Sets the mode for a channel or a nickname specified in <target>.
215 A user may only set modes upon themselves, and may not set the
216 +o usermode, and a user may only change channel modes of
217 channels where they are at least a halfoperator.
219 For a list of all user and channel modes, enter /HELPOP UMODES or
222 <helpop key="topic" value="/TOPIC <channel> [<topic>]
224 Sets or retrieves the channel topic. If a channel topic is
225 given in the command and either the channel is not +t, or
226 you are at least a halfoperator, the channel topic will be
227 changed to the new one you provide.">
229 <helpop key="who" value="/WHO <pattern> [<flags>][%[<fields>[,<querytype>]]] <pattern>
231 Looks up information about users matching the provided pattern. You can specify
232 a flag specific pattern, a channel name, user hostname, a user server name, a
233 user real name, or a user nickname. Matching users will only be included in the
236 1) The specified pattern is an exact channel name that does not have the
237 private or secret channel modes set and the user does not have the invisible
239 2) The specified pattern is an exact nickname.
240 3) You share one or more common channels with the user.
241 4) The user does not have the invisible user mode set.
242 5) You are a server operator with the users/auspex privilege.
244 If you specify any fields the response returned will be a WHOX response rather
245 than a RFC 1459 WHO response.
250 The following flags use <pattern> to match against the specified user data:
252 A Show users who have an away message matching <pattern>.
253 a Show users who have an account name matching <pattern>.
254 h Show users who have a hostname matching <pattern>. If the 'x' modifier
255 is specified then this will match against the real hostname instead of
256 the display hostname.
257 i Show users who have an IP address matching <pattern>.
258 m Show users who have the modes listed in <pattern>. The pattern
259 should be in the same format as a mode change e.g. +ow-i (server
261 n Show users who have a nickname matching <pattern>.
262 p Show users who are connected to a port in the <pattern> range (server
264 r Show users who have a real name matching <pattern>.
265 s Show users who are on a server with a name matching <pattern>. If the 'x'
266 modifier is specified then this will match against the real server name
267 instead of the masked server name.
268 t Show users who have connected in the last <pattern> seconds.
269 u Show users who have an ident (username) matching <pattern>.
271 The following flags filter users by their status:
273 f Only show users on remote (far) servers.
274 l Only show users on the local server.
275 o Only show server operators.
277 The following flags modify the command output:
279 x Show sensitive data like real user hostnames and, when hideserver is
280 enabled, real server hostnames.
282 You may combine one flag from the first group and multiple from the others in
288 a Include the user's account name in the response.
289 c Include the first common channel name in the response.
290 d Include the user's server distance from you in the response.
291 f Include the user's away status, oper status, and highest channel prefix
293 h Include the user's hostname in the response. If the 'x' flag was
294 specified then this is the real host rather than the display host.
295 i Include the user's IP address in the response.
296 l Include the user's idle time in the response.
297 n Include the user's nickname in the response.
298 o Include the user's channel operator rank level in the response.
299 r Include the user's real name in the response.
300 s Include the user's server name in the response. If the 'x' flag was
301 specified then this is the real server name rather than the masked server
303 t Include the query type in the response.
304 u Include the user's ident in the response.
308 <helpop key="motd" value="/MOTD [<server>]
310 Show the message of the day for <server>. Messages of the day often
311 contain important server rules and notices and should be read prior
314 <helpop key="oper" value="/OPER <login> <password>
316 Attempts to authenticate a user as an IRC operator.
318 Both successful and unsuccessful oper attempts are
319 logged, and sent to online IRC operators.">
321 <helpop key="list" value="/LIST [<pattern>]
323 Creates a list of all existing channels matching the glob pattern
324 <pattern>, e.g. *chat* or bot*.">
326 <helpop key="lusers" value="/LUSERS
328 Shows a count of local and remote users, servers and channels.">
330 <helpop key="userhost" value="/USERHOST <nick> [<nick>]
332 Returns the hostname and nickname of a user, and some other
333 miscellaneous information.">
335 <helpop key="away" value="/AWAY [<message>]
337 If a message is given, marks you as being away, otherwise
338 removes your away status and previous message.">
340 <helpop key="ison" value="/ISON <nick> [<nick> ...]
342 Returns a subset of the nicks you give, showing only those
343 that are currently online.">
345 <helpop key="invite" value="/INVITE <nick> <channel> [<time>]
347 Invites a user to a channel. If the channel is NOT +A, only
348 channel halfoperators or above can invite people. If +A is set,
349 anyone can invite people to the channel, as long as the person
350 doing the invite is a member of the channel they wish to invite
353 Invited users may override bans, +k, and similar in addition to
354 +i, depending on configuration.
356 If a time is provided, the invite expires after that time and the user
357 can no longer use it to enter the channel.">
359 <helpop key="pass" value="/PASS <password>
361 This command is used by your client when setting up
362 your IRC session to submit a server password to the
365 You should not use it during an established connection.">
367 <helpop key="whowas" value="/WHOWAS <nick>
369 Returns a list of times the user was seen recently on IRC along with
370 the time they were last seen and their server.">
372 <helpop key="links" value="/LINKS
374 Shows all servers linked to this one.">
376 <helpop key="map" value="/MAP
378 Shows a graphical representation of all users and servers on the
379 network, and the links between them, as a tree from the perspective
382 <helpop key="whois" value="/WHOIS <nick> [<server>]
384 Returns the WHOIS information of a user, their channels, hostname,
385 etc. If a second nickname or server is provided, then a whois is
386 performed from the server where the user is actually located rather
387 than locally, showing idle and signon times.">
389 <helpop key="time" value="/TIME [<server>]
391 Returns the local time of the server, or remote time of another
394 <helpop key="info" value="/INFO [<server>]
396 Returns information on the developers and supporters who made this
397 IRC server possible.">
399 <helpop key="setname" value="/SETNAME <name>
401 Sets your name to the specified name.">
404 #####################
406 #####################
408 <helpop key="coper" value="Oper Commands
411 OPERMOTD CHECK CLONES USERIP TLINE
412 ALLTIME WALLOPS GLOBOPS MODENOTICE
415 SETHOST SETIDENT CHGHOST CHGIDENT CHGNAME
418 SANICK NICKLOCK NICKUNLOCK
420 SAJOIN SAPART SAMODE SATOPIC SAKICK
422 KILL SAQUIT GLINE ZLINE QLINE
423 KLINE RLINE ELINE CBAN SHUN
424 FILTER OJOIN CLEARCHAN
426 CONNECT SQUIT RCONNECT RSQUIT
429 LOADMODULE UNLOADMODULE
430 RELOADMODULE GLOADMODULE GUNLOADMODULE
431 GRELOADMODULE CLOSE JUMPSERVER
432 LOCKSERV UNLOCKSERV">
434 <helpop key="userip" value="/USERIP <nick> [<nick>]
436 Returns the ip and nickname of the given users.">
438 <helpop key="tline" value="/TLINE <mask>
440 This command returns the number of local and global clients matched,
441 and the percentage of clients matched, plus how they were matched
442 (by IP address or by hostname). Mask should be given as either a
443 nick!user@host or user@IP (wildcards acceptable).">
445 <helpop key="lockserv" value="/LOCKSERV :[<message>]
447 Locks out all new connections notifying connecting users that the
448 service is temporarily closed and to try again later.">
450 <helpop key="unlockserv" value="/UNLOCKSERV
452 Opens the server up again for new connections.">
454 <helpop key="jumpserver" value="/JUMPSERVER [<newserver> <newport> <(+|-)[flags]> :[<reason>]]
456 Sets or cancels jumpserver mode. If no parameters are given,
457 jumpserver mode is cancelled, if it is currently set. If parameters
458 are given, a server address must be given for <newserver> and a
459 server port must be given for <newport>. Zero or more status flags
460 should be given for 'flags', from the list below (if you do not
461 wish to specify any flags just place a '+' in this field):
463 1. +a: Redirect all users immediately (except for opers) and cause
464 them to quit with the given reason
466 2. +n: Redirect any new users who connect and cause them to quit
469 You may use + and - to set or unset these flags in the command, the
470 default flags are -a+n, which will just redirect new users. The
471 reason parameter is optional, and if not provided defaults to
472 'Please use this server/port instead' (the default given in various
475 <helpop key="filter" value="/FILTER <filter-definition> [<action> <flags> [<duration>] :<reason>]
477 This command will add a filter when more than one parameter is given,
478 for messages of the types specified by the flags, with the given
479 filter definition, action, duration (when the action is 'gline' or 'shun'),
482 The filter will take effect when a message of any type specified by
483 the flags and matching the definition is sent to the server, and
484 perform the specified action.
490 Block Blocks message and informs +s IRCops of the blocked message
491 and all relevant info
492 Silent Blocks message, but does not notify IRCops
494 Gline Glines the user for the specified duration
495 Shun Shuns the user for the specified duration (requires the shun module)
500 p Block private and channel messages
501 n Block private and channel notices
502 P Block part messages
503 q Block quit messages
504 o Don't match against opers
505 c Strip all formatting codes from the message before matching
506 * Represents all of the above flags
507 - Does nothing, a non-op for when you do not want to specify any
510 The reason for the filter will be used as the reason for the action,
511 unless the action is 'none', and is sent to the user when their text is
512 blocked by 'block' and 'silent' actions.
514 A gline duration may be specified in seconds, or in the format
515 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5
516 minutes and 6 seconds. All fields in this format are optional.
518 When only one parameter is provided (the filter pattern) the provided
519 filter will be removed. Note that if you remove a
520 configuration-defined filter, it will reappear at next rehash unless
521 it is also removed from the config file.">
523 <helpop key="ojoin" value="/OJOIN <channel>
525 Force joins you to the specified channel, and gives you +Y and any other
526 configuration-defined modes on it, preventing you from being kicked.
527 Depending on configuration, may announce that you have joined the
528 channel on official network business.">
530 <helpop key="clones" value="/CLONES <limit>
532 Retrieves a list of users with more clones than the specified
535 <helpop key="check" value="/CHECK <nick|ip|hostmask|channel> [<server>]
537 Allows opers to look up advanced information on channels, hostmasks
538 or IP addresses, in a similar way to WHO but in more detail, displaying
539 most information the IRCD has stored on the target, including all
542 With the second parameter given, runs the command remotely on the
545 <helpop key="alltime" value="/ALLTIME
547 Shows the time on all servers on the network.">
549 <helpop key="rconnect" value="/RCONNECT <source mask> <target mask>
551 The server matching <source mask> will try to connect to the first
552 server in the config file matching <target mask>.">
554 <helpop key="rsquit" value="/RSQUIT <target mask> [<reason>]
556 Causes a remote server matching <target mask> to be disconnected from
559 <helpop key="globops" value="/GLOBOPS <message>
561 Sends a message to all users with the +g snomask.">
563 <helpop key="cban" value="/CBAN <channel> [<duration> :[<reason>]]
565 Sets or removes a channel ban. You must specify all three parameters
566 to add a ban, and one parameter to remove a ban (just the channel).
568 The duration may be specified in seconds, or in the format
569 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
570 5 minutes and 6 seconds. All fields in this format are optional.">
572 <helpop key="sajoin" value="/SAJOIN [<nick>] <channel>[,<channel>]
574 Forces the user to join the channel(s).
575 If no nick is given, it joins the oper doing the /SAJOIN.">
577 <helpop key="sapart" value="/SAPART <nick> <channel>[,<channel>]
579 Forces the user to part the channel(s).">
581 <helpop key="samode" value="/SAMODE <target> (+|-)<modes> [<parameters for modes>]
583 Applies the given mode change to the channel or nick specified.">
585 <helpop key="sanick" value="/SANICK <nick> <new nick>
587 Changes the user's nick to the new nick.">
589 <helpop key="sakick" value="/SAKICK <channel> <nick> <reason>
591 Kicks the given user from the specified channel.">
593 <helpop key="satopic" value="/SATOPIC <channel> <new topic>
595 Applies the given topic to the specified channel.">
597 <helpop key="saquit" value="/SAQUIT <nick> <reason>
599 Forces user to quit with the specified reason.">
601 <helpop key="setidle" value="/SETIDLE <idle time>
603 Sets your idle time (in seconds) to the specified value.">
605 <helpop key="sethost" value="/SETHOST <host>
607 Sets your host to the specified host.">
609 <helpop key="setident" value="/SETIDENT <ident>
611 Sets your ident to the specified ident.">
613 <helpop key="swhois" line="/SWHOIS <nick> <swhois>
615 Sets the user's swhois field to the given swhois.">
617 <helpop key="mkpasswd" value="/MKPASSWD <hashtype> <plaintext>
619 Encodes the plaintext to a hash of the given type and displays
622 <helpop key="opermotd" value="/OPERMOTD
624 Displays the Oper MOTD.">
626 <helpop key="nicklock" value="/NICKLOCK <nick> <new nick>
628 Changes the user's nick to the new nick, and forces
629 it to remain as such for the remainder of the session.">
631 <helpop key="nickunlock" value="/NICKUNLOCK <nick>
633 Allows a previously locked user to change nicks again.">
635 <helpop key="chghost" value="/CHGHOST <nickname> <new hostname>
637 Changes the hostname of the user to the new hostname.">
639 <helpop key="chgname" value="/CHGNAME <nickname> <new name>
641 Changes the name of the user to the new name.">
643 <helpop key="chgident" value="/CHGIDENT <nickname> <new ident>
645 Changes the ident of the user to the new ident.">
647 <helpop key="shun" value="/SHUN <nick!user@host> [[<duration>] :<reason>]
649 Sets or removes a shun (server side ignore) on a host and ident mask.
650 You must specify all three parameters to add a shun, and one parameter
651 to remove a shun (just the nick!user@host section).
653 The duration may be specified in seconds, or in the format
654 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
655 5 minutes and 6 seconds. All fields in this format are optional.">
657 <helpop key="die" value="/DIE <server>
659 This command shuts down the local server. A single parameter is
660 required, which must match the name of the local server.">
662 <helpop key="restart" value="/RESTART <server>
664 This command restarts the local server. A single parameter is
665 required, which must match the name of the local server.">
667 <helpop key="commands" value="/COMMANDS
669 Shows all currently available commands.">
671 <helpop key="kill" value="/KILL <user> <reason>
673 This command will disconnect a user from IRC with the given reason.">
675 <helpop key="rehash" value="/REHASH <mask>
677 This command will cause the server configuration file to be reread and
678 values reinitialized for all servers matching the server mask, or the
679 local server if one is not specified.">
681 <helpop key="connect" value="/CONNECT <servermask>
683 Add a connection to the server matching the given server mask. You must
684 have configured the server for linking in your configuration file
685 before trying to link them.">
687 <helpop key="squit" value="/SQUIT <servermask>
689 Disconnects the server matching the given server mask from this server.">
691 <helpop key="modules" value="/MODULES
693 Lists currently loaded modules, their memory offsets, version numbers,
694 and flags. If you are not an operator, you will see reduced detail.">
696 <helpop key="loadmodule" value="/LOADMODULE <modname>
698 Loads the specified module into the local server.">
700 <helpop key="unloadmodule" value="/UNLOADMODULE <modname>
702 Unloads a module from the local server.">
704 <helpop key="reloadmodule" value="/RELOADMODULE <modname>
706 Unloads and reloads a module on the local server.">
708 <helpop key="gloadmodule" value="/GLOADMODULE <modname>
710 Loads the specified module on all linked servers.">
712 <helpop key="gunloadmodule" value="/GUNLOADMODULE <modname>
714 Unloads a module from all linked servers.">
716 <helpop key="greloadmodule" value="/GRELOADMODULE <modname>
718 Unloads and reloads a module on all linked servers.">
720 <helpop key="kline" value="/KLINE <user@host> [<duration> :<reason>]
722 Sets or removes a k-line (local host based ban) on a host and ident mask.
723 You must specify all three parameters to add a ban, and one parameter
724 to remove a ban (just the user@host section).
726 The duration may be specified in seconds, or in the format
727 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
728 5 minutes and 6 seconds. All fields in this format are optional.">
730 <helpop key="zline" value="/ZLINE <ipmask> [<duration> :<reason>]
732 Sets or removes a z-line (ip based ban) on an ip range mask.
733 You must specify all three parameters to add a ban, and one parameter
734 to remove a ban (just the ipmask).
736 The duration may be specified in seconds, or in the format
737 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
738 5 minutes and 6 seconds. All fields in this format are optional.">
740 <helpop key="qline" value="/QLINE <nickmask> [<duration> :<reason>]
742 Sets or removes a q-line (nick based ban) on a nick mask.
743 You must specify all three parameters to add a ban, and one parameter
744 to remove a ban (just the nickmask).
746 The duration may be specified in seconds, or in the format
747 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
748 5 minutes and 6 seconds. All fields in this format are optional.">
750 <helpop key="gline" value="/GLINE <user@host> [<duration> :<reason>]
752 Sets or removes a g-line (host based ban) on host mask.
753 You must specify all three parameters to add a ban, and one
754 parameter to remove a ban (just the user@host section).
756 The duration may be specified in seconds, or in the format
757 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
758 5 minutes and 6 seconds. All fields in this format are optional.">
760 <helpop key="eline" value="/ELINE <user@host> [<duration> :<reason>]
762 Sets or removes a e-line (global ban exception) on host mask.
763 You must specify at least 3 parameters to add an exception, and one
764 parameter to remove an exception (just the user@host section).
766 The duration may be specified in seconds, or in the format
767 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
768 5 minutes and 6 seconds. All fields in this format are optional.
770 This command has a few important limitations. Bans on *@<ip> can only
771 be negated by an eline on *@<ip>, bans on *@<host> can be negated by
772 elines on *@<ip>, or *@<host>, and bans on <ident>@* or <ident>@<host>
773 can be negated by any eline that matches.">
775 <helpop key="wallops" value="/WALLOPS <message>
777 Sends a message to all +w users.">
779 <helpop key="rline" value="/RLINE <regex> [<duration> :<reason>]
781 Sets or removes an r-line (regex line) on a n!u@h\srealname mask. You
782 must specify all three parameters to add an rline, and one parameter
783 to remove an rline (just the regex).
785 The duration may be specified in seconds, or in the format
786 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
787 5 minutes and 6 seconds. All fields in this format are optional.">
789 <helpop key="close" value="/CLOSE
791 Closes all unregistered connections to the local server.">
793 <helpop key="clearchan" value="/CLEARCHAN <channel> [<KILL|KICK|G|Z>] [<reason>]
795 Quits or kicks all non-opers from a channel, optionally G/Z-Lines them.
796 Useful for quickly nuking bot channels.
798 The default method, KILL, simply disconnects the victims from the server,
799 while methods G and Z also add G/Z-Lines for all the targets.
801 When used, the victims won't see each other getting kicked or quitting.">
803 <helpop key="modenotice" value="/MODENOTICE <modeletters> <message>
805 Sends a notice to all users who have the given mode(s) set.
806 If multiple mode letters are given, the notice is only sent to users
807 who have all of them set.">
809 <helpop key="cloak" value="/CLOAK <host>
811 Generate the cloak of a host or IP. This is useful for example when
812 trying to get the cloak of a user from /WHOWAS and they were not
813 using their cloak when they quit.">
815 ######################
816 # User/Channel Modes #
817 ######################
819 <helpop key="umodes" value="User Modes
822 c Blocks private messages and notices from users who do
823 not share a common channel with you (requires the
825 d Deaf mode. User will not receive any messages or notices
826 from channels they are in (requires the deaf module).
827 g In combination with /ACCEPT, provides for server side
828 ignore (requires the callerid module).
829 h Marks as 'available for help' in WHOIS (IRCop only,
830 requires the helpop module).
831 i Makes invisible to /WHO if the user using /WHO is not in
833 k Prevents the user from being kicked from channels, or
834 having op modes removed from them (services only,
835 requires the servprotect module).
836 o Marks as a IRC operator.
837 s <mask> Receives server notices specified by <mask>
839 r Marks as a having a registered nickname
840 (requires the services account module).
841 w Receives wallops messages.
842 x Gives a cloaked hostname (requires the cloaking module).
843 z Only allow private messages from SSL users (requires the
845 B Marks as a bot (requires the botmode module).
846 G Censors messages sent to the user based on filters
847 configured for the network (requires the censor module).
848 H Hides an oper's oper status from WHOIS (requires the
850 I Hides a user's entire channel list in WHOIS from
851 non-IRCops (requires the hidechans module).
852 L Stops redirections done by m_redirect (mode must be
853 enabled in the config).
854 R Blocks private messages from unregistered users
855 (requires the services account module).
856 S Strips formatting codes out of private messages
857 to the user (requires the stripcolor module).
858 W Receives notification when a user uses WHOIS on them
859 (IRCop only, requires the showwhois module).">
861 <helpop key="chmodes" value="Channel Modes
864 v <nickname> Gives voice to <nickname>, allowing them to speak
865 while the channel is +m.
866 h <nickname> Gives halfop status to <nickname> (requires the
867 customprefix module).
868 o <nickname> Gives op status to <nickname>.
869 a <nickname> Gives protected status to <nickname>, preventing
870 them from being kicked (+q only, requires the
871 customprefix module).
872 q <nickname> Gives owner status to <nickname>, preventing them
873 from being kicked (Services or +q only, requires
874 the customprefix module).
876 b <hostmask> Bans <hostmask> from the channel.
877 e <hostmask> Excepts <hostmask> from bans (requires the
878 banexception module).
879 I <hostmask> Excepts <hostmask> from +i, allowing matching
880 users to join while the channel is invite-only
881 (requires the inviteexception module).
883 c Blocks messages that contain formatting codes
884 (requires the blockcolor module).
885 d <time> Blocks messages to a channel from new users
886 until they have been in the channel for <time>
887 seconds (requires the delaymsg module).
888 f [*]<lines>:<sec> Kicks on text flood equal to or above the
889 specified rate. With *, the user is banned
890 (requires the messageflood module).
891 g <mask> Blocks messages matching the given glob mask
892 (requires the chanfilter module).
893 i Makes the channel invite-only.
894 Users can only join if an operator
895 uses /INVITE to invite them.
896 j <joins>:<sec> Limits joins to the specified rate (requires
897 the joinflood module).
898 k <key> Set the channel key (password) to <key>.
899 l <limit> Set the maximum allowed users to <limit>.
900 m Enable moderation. Only users with +v, +h, or +o
902 n Blocks users who are not members of the channel
904 p Make channel private, hiding it in users' whoises
905 and replacing it with * in /LIST.
906 r Marks the channel as registered with Services
907 (requires the services account module).
908 s Make channel secret, hiding it in users' whoises
910 t Prevents users without +h or +o from changing the
912 u Makes the channel an auditorium; normal users only
913 see themselves or themselves and the operators,
914 while operators see all the users (requires the
916 w <flag>:<banmask> Adds basic channel access controls of <flag> to
917 <banmask>, via the +w listmode.
918 For example, +w o:R:Brain will op anyone identified
919 to the account 'Brain' on join.
920 (requires the autoop module)
921 z Blocks non-SSL clients from joining the channel.
923 A Allows anyone to invite users to the channel
924 (normally only chanops can invite, requires
925 the allowinvite module).
926 B Blocks messages with too many capital letters,
927 as determined by the network configuration
928 (requires the blockcaps module).
929 C Blocks any CTCPs to the channel (requires the
931 D Delays join messages from users until they message
932 the channel (requires the delayjoin module).
933 E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similar messages.
934 Kicks as default, blocks with ~ and bans with *
935 The last two parameters are optional.
936 F <changes>:<sec> Blocks nick changes when they equal or exceed the
937 specified rate (requires the nickflood module).
938 G Censors messages to the channel based on the
939 network configuration (requires the censor module).
940 H <num>:<duration> Displays the last <num> lines of chat to joining
941 users. <duration> is the maximum time to keep
942 lines in the history buffer (requires the
944 J <seconds> Prevents rejoin after kick for the specified
945 number of seconds. This prevents auto-rejoin
946 (requires the kicknorejoin module).
947 K Blocks /KNOCK on the channel.
948 L <channel> If the channel reaches its limit set by +l,
949 redirect users to <channel> (requires the
951 M Blocks unregistered users from speaking (requires
952 the services account module).
953 N Prevents users on the channel from changing nick
954 (requires the nonicks module).
955 O Channel is IRCops only (can only be set by IRCops,
956 requires the operchans module).
957 P Makes the channel permanent; Bans, invites, the
958 topic, modes, and such will not be lost when it
959 empties (can only be set by IRCops, requires
960 the permchannels module).
961 Q Only ulined servers and their users can kick
962 (requires the nokicks module)
963 R Blocks unregistered users from joining (requires
964 the services account module).
965 S Strips formatting codes from messages to the
966 channel (requires the stripcolor module).
967 T Blocks /NOTICEs to the channel from users who are
968 not at least halfop (requires the nonotice module).
969 X <type>:<status> Makes users of <status> or higher exempt to the
970 specified restriction <type>. For example: flood:h
971 (requires the exemptchanops module).
972 Possible restriction types to exempt with +X are:
974 auditorium-see Permission required to see the full user list of
975 a +u channel (requires the auditorium module).
976 auditorium-vis Permission required to be visible in a +u channel
977 (requires the auditorium module).
978 blockcaps Channel mode +B
979 blockcolor Channel mode +c
980 censor Channel mode +G
981 filter Channel mode +g
982 flood Channel mode +f
983 nickflood Channel mode +F
984 noctcp Channel mode +C
985 nonick Channel mode +N
986 nonotice Channel mode +T
987 regmoderated Channel mode +M
988 stripcolor Channel mode +S
989 topiclock Channel mode +t
992 NOTE: A large number of these modes are dependent upon server-side modules
993 being loaded by a server/network administrator. The actual modes available
994 on your network may be very different to this list. Please consult your
995 help channel if you have any questions.">
997 ######################
999 ######################
1001 <helpop key="stats" value="/STATS <symbol>
1003 Shows various server statistics. Depending on configuration, some
1004 symbols may be only available to opers.
1008 e Show E-lines (local ban exemptions)
1009 g Show G-lines (host bans)
1010 k Show K-lines (local host bans)
1011 q Show Q-lines (nick mask bans)
1012 R Show R-lines (regular expression bans)
1013 Z Show Z-lines (IP mask bans)
1020 d Show configured DNSBLs and related statistics
1021 m Show command statistics, number of times commands have been used
1022 o Show a list of all valid oper usernames and hostmasks
1023 p Show open client ports, and the port type (ssl, plaintext, etc)
1024 u Show server uptime
1025 z Show memory usage statistics
1026 i Show connect class permissions
1027 l Show all client connections with information (sendq, commands, bytes, time connected)
1028 L Show all client connections with information and IP address
1029 P Show online opers and their idle times
1030 T Show bandwidth/socket statistics
1031 U Show U-lined servers
1032 Y Show connection classes
1033 O Show opertypes and the allowed user and channel modes it can set
1034 E Show socket engine events
1035 S Show currently held registered nicknames
1036 G Show how many local users are connected from each country according to GeoIP
1038 Note that all /STATS use is broadcast to online IRC operators.">
1040 ######################
1042 ######################
1044 <helpop key="snomasks" value="Server Notice Masks
1046 a Allows receipt of local announcement messages.
1047 A Allows receipt of remote announcement messages.
1048 c Allows receipt of local connect messages.
1049 C Allows receipt of remote connect messages.
1050 d Allows receipt of general (and sometimes random) debug messages.
1051 f Allows receipt of flooding notices.
1052 g Allows receipt of globops (requires the globops module).
1053 j Allows receipt of channel creation notices (requires the chancreate module).
1054 J Allows receipt of remote channel creation notices (requires the chancreate module).
1055 k Allows receipt of local kill messages.
1056 K Allows receipt of remote kill messages.
1057 l Allows receipt of local linking related messages.
1058 L Allows receipt of remote linking related messages.
1059 n See local nickname changes (requires the seenicks module).
1060 N See remote nickname changes (requires the seenicks modules).
1061 o Allows receipt of oper-up, oper-down, and oper-failure messages.
1062 O Allows receipt of remote oper-up, oper-down, and oper-failure messages.
1063 q Allows receipt of local quit messages.
1064 Q Allows receipt of remote quit messages.
1065 r Allows receipt of local oper commands (requires the operlog module).
1066 R Allows receipt of remote oper commands (requires the operlog module).
1067 t Allows receipt of attempts to use /STATS (local and remote).
1068 v Allows receipt of oper-override notices (requires the override module).
1069 x Allows receipt of local Xline notices (g/Z/q/k/e/R/shuns).
1070 X Allows receipt of remote Xline notices (g/Z/q/k/e/R/shuns).">
1072 ######################
1074 ######################
1076 <helpop key="extbans" value="Extended Bans
1079 Extbans are split into two types; matching extbans, which match on
1080 users in additional ways, and acting extbans, which restrict users
1081 in different ways to a standard ban.
1083 To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
1084 instead of a normal nick!user@host mask, to ban or exempt matching
1085 users. Ban exceptions on acting extbans exempt that user from matching
1086 an extban of that type, and from any channel mode corresponding to the
1087 restriction. Matching extbans may also be used for invite exceptions by
1088 setting +I <extban>.
1092 j:<channel> Matches anyone in the given channel. Does not support
1093 wildcards (requires the channelban module).
1094 n:<class> Matches users in a matching connect class (requires the
1096 r:<realname> Matches users with a matching real name (requires the
1098 s:<server> Matches users on a matching server (requires the
1100 z:<certfp> Matches users having the given SSL certificate
1101 fingerprint (requires the sslmodes module).
1102 O:<opertype> Matches IRCops of a matching type, mostly useful as an
1103 an invite exception (requires the operchans module).
1104 R:<account> Matches users logged into a matching account (requires
1105 the services account module).
1106 U:<banmask> Matches unregistered users matching the given banmask.
1107 (requires the services account module).
1111 c:<banmask> Blocks any messages that contain formatting codes from
1112 matching users (requires the blockcolor module).
1113 m:<banmask> Blocks messages from matching users (requires the muteban
1114 module). Users with +v or above are not affected.
1115 p:<banmask> Blocks part messages from matching users (requires
1116 the nopartmsg module).
1117 A:<banmask> Blocks invites by matching users even when +A is set
1118 (requires the allowinvite module).
1119 B:<banmask> Blocks all capital or nearly all capital messages from
1120 matching users (requires the blockcaps module).
1121 C:<banmask> Blocks CTCPs from matching users (requires the noctcp
1123 N:<banmask> Blocks nick changes from matching users (requires
1124 the nonicks module).
1125 Q:<banmask> Blocks kicks by matching users (requires the nokicks
1127 S:<banmask> Strips formatting codes from messages from matching
1128 users (requires the stripcolor module).
1129 T:<banmask> Blocks notices from matching users (requires the
1132 A ban given to an Acting extban may either be a nick!user@host mask
1133 (unless stated otherwise), matched against users as for a normal ban,
1134 or a Matching extban.
1136 There is an additional special type of extended ban, a redirect ban:
1138 Redirect n!u@h#channel will redirect the banned user to #channel
1139 when they try to join (requires the banredirect module).">