7 <alias text="HELP" replace="HELPOP $2-">
9 <helpmsg nohelp="There is no help for the topic you searched for. Please try again.">
11 <helpop key="start" value="InspIRCd Help System
13 This system provides help for commands and modes.
14 Specify your question or a command name as the
15 parameter for this command.
17 /HELPOP CUSER - To see a list of user commands
18 /HELPOP COPER - To see a list of oper commands
19 /HELPOP UMODES - To see a list of user modes
20 /HELPOP CHMODES - To see a list of channel modes
21 /HELPOP SNOMASKS - To see a list of oper snotice masks
22 /HELPOP EXTBANS - To see a list of extended bans">
28 <helpop key="cuser" value="User Commands
31 PRIVMSG NOTICE NICK JOIN PART
32 CYCLE KNOCK MODE OPER TOPIC
33 KICK FPART REMOVE TBAN INVITE
34 UNINVITE AWAY DCCALLOW SILENCE ACCEPT
35 MKPASSWD VHOST TITLE SETNAME
37 WHOIS WHOWAS ISON USERHOST WATCH
39 ADMIN MAP LINKS LUSERS TIME
40 STATS VERSION INFO MODULES COMMANDS
43 USER PASS PING PONG QUIT">
45 <helpop key="sslinfo" value="/SSLINFO <nick>
47 Displays information on the SSL connection and certificate of the
50 <helpop key="uninvite" value="/UNINVITE <nick> <channel>
52 Uninvite a user from a channel, same syntax as INVITE.">
54 <helpop key="tban" value="/TBAN <channel> <duration> <banmask>
56 Sets a timed ban. The duration of the ban can be specified in the
57 following format: 1w2d3h4m6s which indicates a ban of one week, two
58 days, three hours, four minutes and six seconds. Alternatively the
59 ban may just be specified as a number of seconds. All timed bans
60 appear in the banlist as normal bans and may be safely removed
61 before their time is up.">
63 <helpop key="dccallow" value="/DCCALLOW - List allowed nicks
64 /DCCALLOW LIST - This also lists allowed nicks
65 /DCCALLOW +<nick> [<duration>] - Add a nick
66 /DCCALLOW -<nick> - Remove a nick
67 /DCCALLOW HELP - Display help
69 Duration is optional, and may be specified in seconds or in the
72 <helpop key="accept" value="/ACCEPT * - List accepted nicks
73 /ACCEPT +<nick> - Add a nick
74 /ACCEPT -<nick> - Remove a nick
75 This command accepts multiple nicks like so:
76 /ACCEPT +<nick1>,+<nick2>,-<nick3>
78 Manages your accept list. This list is used to determine who can
79 private message you when you have usermode +g set.">
81 <helpop key="cycle" value="/CYCLE <channel> :[<reason>]
83 Cycles a channel (leaving and rejoining), overrides restrictions that
84 would stop a new user joining, such as user limits and channel keys.">
86 <helpop key="title" value="/TITLE <name> <password>
88 Authenticate for a WHOIS title line and optionally a vhost using the
89 specified username and password.">
91 <helpop key="watch" value="/WATCH - List watched nicks that are online
92 /WATCH L - List watched nicks, online and offline
93 /WATCH C - Clear all watched nicks
94 /WATCH S - Show statistics
95 /WATCH +<nick> - Add a nick
96 /WATCH -<nick> - Remove a nick
97 This command accepts multiple nicks like so:
98 /WATCH +<nick1> +<nick2> -<nick3>">
100 <helpop key="vhost" value="/VHOST <username> <password>
102 Authenticate for a vhost using the specified username and password.">
104 <helpop key="remove" value="/REMOVE <channel> <nick> [<reason>]
106 Removes a user from a channel you specify. You must be at least a
107 channel halfoperator to remove a user. A removed user will part with
108 a message stating they were removed from the channel and by whom.">
110 <helpop key="rmode" value="/RMODE [channel] [modeletter] {[pattern]}
112 Removes listmodes from a channel.
113 E.g. /RMODE #Chan b m:* will remove all mute extbans.">
115 <helpop key="fpart" value="/FPART <channel> <nick> [<reason>]
117 This behaves identically to /REMOVE. /REMOVE is a built-in mIRC command
118 which caused trouble for some users.">
120 <helpop key="silence" value="/SILENCE - Shows a list of silenced masks
121 /SILENCE +<mask> [<flags>] - Add a mask
122 /SILENCE -<mask> - Remove a mask
124 A serverside ignore of the given n!u@h mask. The letter(s) at the end
125 specify what is to be ignored from this hostmask.
130 p Block private messages
131 c Block channel messages
133 n Block private notices
134 t Block channel notices
135 a Block all of the above
138 Multiple letters may be specified. For an exception, you must pair x
139 with what you want excepted. For example, if you wanted to except
140 everything from people with a host matching *.foo.net, you would do
141 /SILENCE +*!*@*.foo.net xa
143 /SILENCE without a parameter will list the masks that you have silenced.">
145 <helpop key="knock" value="/KNOCK <channel>
147 Sends a notice to a channel indicating you wish to join.">
149 <helpop key="user" value="/USER <ident> <local host> <remote host> :<real name>
151 This command is used by your client to register your
152 IRC session, providing your ident and real name to the
155 You should not use it during an established connection.">
157 <helpop key="nick" value="/NICK <new nick>
159 Change your nickname to <new nick>.">
161 <helpop key="quit" value="/QUIT [<reason>]
163 Quit from IRC and end your current session.">
165 <helpop key="version" value="/VERSION
167 Returns the server's version information.">
169 <helpop key="ping" value="/PING <server>
171 Ping a server. The server will answer with a PONG.">
173 <helpop key="pong" value="/PONG <server>
175 Your client should send this to answer server PINGs. You
176 should not issue this command manually.">
178 <helpop key="admin" value="/ADMIN [<server>]
180 Shows the administrative information for the given server.">
182 <helpop key="privmsg" value="/PRIVMSG <target> <text>
184 Sends a message to a user or channel specified in <target>.">
186 <helpop key="notice" value="/NOTICE <target> <text>
188 Sends a notice to a user or channel specified in <target>.">
190 <helpop key="join" value="/JOIN <channel>[,<channel>] [<key>][,<key>]
192 Joins one or more channels you provide the names for.">
194 <helpop key="names" value="/NAMES <channel>[,<channel>]
196 Return a list of users on the channels you provide.">
198 <helpop key="part" value="/PART <channel>[,<channel>] [<reason>]
200 Leaves one or more channels you specify.">
202 <helpop key="kick" value="/KICK <channel> <nick>[,<nick>] [<reason>]
204 Kicks a user from a channel you specify. You must be
205 at least a channel halfoperator to kick a user.">
207 <helpop key="mode" value="/MODE <target> (+|-)<modes> [<mode parameters>] - Change modes of <target>.
209 /MODE <target> - Show modes of <target>.
211 /MODE <channel> <list mode char> - List bans, exceptions, etc. set on <channel>.
213 Sets the mode for a channel or a nickname specified in <target>.
214 A user may only set modes upon themselves, and may not set the
215 +o usermode, and a user may only change channel modes of
216 channels where they are at least a halfoperator.
218 For a list of all user and channel modes, enter /HELPOP UMODES or
221 <helpop key="topic" value="/TOPIC <channel> [<topic>]
223 Sets or retrieves the channel topic. If a channel topic is
224 given in the command and either the channel is not +t, or
225 you are at least a halfoperator, the channel topic will be
226 changed to the new one you provide.">
228 <helpop key="who" value="/WHO <pattern> [<flags>][%[<fields>[,<querytype>]]] <pattern>
230 Looks up information about users matching the provided pattern. You can specify
231 a flag specific pattern, a channel name, user hostname, a user server name, a
232 user real name, or a user nickname. Matching users will only be included in the
235 1) The specified pattern is an exact channel name that does not have the
236 private or secret channel modes set and the user does not have the invisible
238 2) The specified pattern is an exact nickname.
239 3) You share one or more common channels with the user.
240 4) The user does not have the invisible user mode set.
241 5) You are a server operator with the users/auspex privilege.
243 If you specify any fields the response returned will be a WHOX response rather
244 than a RFC 1459 WHO response.
249 The following flags use <pattern> to match against the specified user data:
251 A Show users who have an away message matching <pattern>.
252 a Show users who have an account name matching <pattern>.
253 h Show users who have a hostname matching <pattern>. If the 'x' modifier
254 is specified then this will match against the real hostname instead of
255 the display hostname.
256 i Show users who have an IP address matching <pattern>.
257 m Show users who have the modes listed in <pattern>. The pattern
258 should be in the same format as a mode change e.g. +ow-i (server
260 n Show users who have a nickname matching <pattern>.
261 p Show users who are connected to a port in the <pattern> range (server
263 r Show users who have a real name matching <pattern>.
264 s Show users who are on a server with a name matching <pattern>. If the 'x'
265 modifier is specified then this will match against the real server name
266 instead of the masked server name.
267 t Show users who have connected in the last <pattern> seconds.
268 u Show users who have an ident (username) matching <pattern>.
270 The following flags filter users by their status:
272 f Only show users on remote (far) servers.
273 l Only show users on the local server.
274 o Only show server operators.
276 The following flags modify the command output:
278 x Show sensitive data like real user hostnames and, when hideserver is
279 enabled, real server hostnames.
281 You may combine one flag from the first group and multiple from the others in
287 a Include the user's account name in the response.
288 c Include the first common channel name in the response.
289 d Include the user's server distance from you in the response.
290 f Include the user's away status, oper status, and highest channel prefix
292 h Include the user's hostname in the response. If the 'x' flag was
293 specified then this is the real host rather than the display host.
294 i Include the user's IP address in the response.
295 l Include the user's idle time in the response.
296 n Include the user's nickname in the response.
297 o Include the user's channel operator rank level in the response.
298 r Include the user's real name in the response.
299 s Include the user's server name in the response. If the 'x' flag was
300 specified then this is the real server name rather than the masked server
302 t Include the query type in the response.
303 u Include the user's ident in the response.
307 <helpop key="motd" value="/MOTD [<server>]
309 Show the message of the day for <server>. Messages of the day often
310 contain important server rules and notices and should be read prior
313 <helpop key="oper" value="/OPER <login> <password>
315 Attempts to authenticate a user as an IRC operator.
317 Both successful and unsuccessful oper attempts are
318 logged, and sent to online IRC operators.">
320 <helpop key="list" value="/LIST [<pattern>]
322 Creates a list of all existing channels matching the glob pattern
323 <pattern>, e.g. *chat* or bot*.">
325 <helpop key="lusers" value="/LUSERS
327 Shows a count of local and remote users, servers and channels.">
329 <helpop key="userhost" value="/USERHOST <nick> [<nick>]
331 Returns the hostname and nickname of a user, and some other
332 miscellaneous information.">
334 <helpop key="away" value="/AWAY [<message>]
336 If a message is given, marks you as being away, otherwise
337 removes your away status and previous message.">
339 <helpop key="ison" value="/ISON <nick> [<nick> ...]
341 Returns a subset of the nicks you give, showing only those
342 that are currently online.">
344 <helpop key="invite" value="/INVITE <nick> <channel> [<time>]
346 Invites a user to a channel. If the channel is NOT +A, only
347 channel halfoperators or above can invite people. If +A is set,
348 anyone can invite people to the channel, as long as the person
349 doing the invite is a member of the channel they wish to invite
352 Invited users may override bans, +k, and similar in addition to
353 +i, depending on configuration.
355 If a time is provided, the invite expires after that time and the user
356 can no longer use it to enter the channel.">
358 <helpop key="pass" value="/PASS <password>
360 This command is used by your client when setting up
361 your IRC session to submit a server password to the
364 You should not use it during an established connection.">
366 <helpop key="whowas" value="/WHOWAS <nick>
368 Returns a list of times the user was seen recently on IRC along with
369 the time they were last seen and their server.">
371 <helpop key="links" value="/LINKS
373 Shows all servers linked to this one.">
375 <helpop key="map" value="/MAP
377 Shows a graphical representation of all users and servers on the
378 network, and the links between them, as a tree from the perspective
381 <helpop key="whois" value="/WHOIS <nick> [<server>]
383 Returns the WHOIS information of a user, their channels, hostname,
384 etc. If a second nickname or server is provided, then a whois is
385 performed from the server where the user is actually located rather
386 than locally, showing idle and signon times.">
388 <helpop key="time" value="/TIME [<server>]
390 Returns the local time of the server, or remote time of another
393 <helpop key="info" value="/INFO [<server>]
395 Returns information on the developers and supporters who made this
396 IRC server possible.">
398 <helpop key="setname" value="/SETNAME <name>
400 Sets your name to the specified name.">
403 #####################
405 #####################
407 <helpop key="coper" value="Oper Commands
410 OPERMOTD CHECK CLONES USERIP TLINE
411 ALLTIME WALLOPS GLOBOPS MODENOTICE
414 SETHOST SETIDENT CHGHOST CHGIDENT CHGNAME
417 SANICK NICKLOCK NICKUNLOCK
419 SAJOIN SAPART SAMODE SATOPIC SAKICK
421 KILL SAQUIT GLINE ZLINE QLINE
422 KLINE RLINE ELINE CBAN SHUN
423 FILTER OJOIN CLEARCHAN
425 CONNECT SQUIT RCONNECT RSQUIT
428 LOADMODULE UNLOADMODULE
429 RELOADMODULE GLOADMODULE GUNLOADMODULE
430 GRELOADMODULE CLOSE JUMPSERVER
431 LOCKSERV UNLOCKSERV">
433 <helpop key="userip" value="/USERIP <nick> [<nick>]
435 Returns the ip and nickname of the given users.">
437 <helpop key="tline" value="/TLINE <mask>
439 This command returns the number of local and global clients matched,
440 and the percentage of clients matched, plus how they were matched
441 (by IP address or by hostname). Mask should be given as either a
442 nick!user@host or user@IP (wildcards acceptable).">
444 <helpop key="lockserv" value="/LOCKSERV :[<message>]
446 Locks out all new connections notifying connecting users that the
447 service is temporarily closed and to try again later.">
449 <helpop key="unlockserv" value="/UNLOCKSERV
451 Opens the server up again for new connections.">
453 <helpop key="jumpserver" value="/JUMPSERVER [<newserver> <newport> <(+|-)[flags]> :[<reason>]]
455 Sets or cancels jumpserver mode. If no parameters are given,
456 jumpserver mode is cancelled, if it is currently set. If parameters
457 are given, a server address must be given for <newserver> and a
458 server port must be given for <newport>. Zero or more status flags
459 should be given for 'flags', from the list below (if you do not
460 wish to specify any flags just place a '+' in this field):
462 1. +a: Redirect all users immediately (except for opers) and cause
463 them to quit with the given reason
465 2. +n: Redirect any new users who connect and cause them to quit
468 You may use + and - to set or unset these flags in the command, the
469 default flags are -a+n, which will just redirect new users. The
470 reason parameter is optional, and if not provided defaults to
471 'Please use this server/port instead' (the default given in various
474 <helpop key="filter" value="/FILTER <filter-definition> [<action> <flags> [<duration>] :<reason>]
476 This command will add a filter when more than one parameter is given,
477 for messages of the types specified by the flags, with the given
478 filter definition, action, duration (when the action is 'gline' or 'shun'),
481 The filter will take effect when a message of any type specified by
482 the flags and matching the definition is sent to the server, and
483 perform the specified action.
489 Warn Lets the message through and informs +s IRCops of the message
490 and all relevant info
491 Block Blocks message and informs +s IRCops of the blocked message
492 and all relevant info
493 Silent Blocks message, but does not notify IRCops
495 Gline Glines the user for the specified duration
496 Zline Zlines the user for the specified duration
497 Shun Shuns the user for the specified duration (requires the shun module)
502 p Block private and channel messages
503 n Block private and channel notices
504 P Block part messages
505 q Block quit messages
506 o Don't match against opers
507 c Strip all formatting codes from the message before matching
508 * Represents all of the above flags
509 - Does nothing, a non-op for when you do not want to specify any
512 The reason for the filter will be used as the reason for the action,
513 unless the action is 'none', and is sent to the user when their text is
514 blocked by 'block' and 'silent' actions.
516 A gline duration may be specified in seconds, or in the format
517 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5
518 minutes and 6 seconds. All fields in this format are optional.
520 When only one parameter is provided (the filter pattern) the provided
521 filter will be removed. Note that if you remove a
522 configuration-defined filter, it will reappear at next rehash unless
523 it is also removed from the config file.">
525 <helpop key="ojoin" value="/OJOIN <channel>
527 Force joins you to the specified channel, and gives you +Y and any other
528 configuration-defined modes on it, preventing you from being kicked.
529 Depending on configuration, may announce that you have joined the
530 channel on official network business.">
532 <helpop key="clones" value="/CLONES <limit>
534 Retrieves a list of users with more clones than the specified
537 <helpop key="check" value="/CHECK <nick|ip|hostmask|channel> [<server>]
539 Allows opers to look up advanced information on channels, hostmasks
540 or IP addresses, in a similar way to WHO but in more detail, displaying
541 most information the IRCD has stored on the target, including all
544 With the second parameter given, runs the command remotely on the
547 <helpop key="alltime" value="/ALLTIME
549 Shows the time on all servers on the network.">
551 <helpop key="rconnect" value="/RCONNECT <source mask> <target mask>
553 The server matching <source mask> will try to connect to the first
554 server in the config file matching <target mask>.">
556 <helpop key="rsquit" value="/RSQUIT <target mask> [<reason>]
558 Causes a remote server matching <target mask> to be disconnected from
561 <helpop key="globops" value="/GLOBOPS <message>
563 Sends a message to all users with the +g snomask.">
565 <helpop key="cban" value="/CBAN <channel> [<duration> :[<reason>]]
567 Sets or removes a channel ban. You must specify all three parameters
568 to add a ban, and one parameter to remove a ban (just the channel).
570 The duration may be specified in seconds, or in the format
571 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
572 5 minutes and 6 seconds. All fields in this format are optional.">
574 <helpop key="sajoin" value="/SAJOIN [<nick>] <channel>[,<channel>]
576 Forces the user to join the channel(s).
577 If no nick is given, it joins the oper doing the /SAJOIN.">
579 <helpop key="sapart" value="/SAPART <nick> <channel>[,<channel>]
581 Forces the user to part the channel(s).">
583 <helpop key="samode" value="/SAMODE <target> (+|-)<modes> [<parameters for modes>]
585 Applies the given mode change to the channel or nick specified.">
587 <helpop key="sanick" value="/SANICK <nick> <new nick>
589 Changes the user's nick to the new nick.">
591 <helpop key="sakick" value="/SAKICK <channel> <nick> <reason>
593 Kicks the given user from the specified channel.">
595 <helpop key="satopic" value="/SATOPIC <channel> <new topic>
597 Applies the given topic to the specified channel.">
599 <helpop key="saquit" value="/SAQUIT <nick> <reason>
601 Forces user to quit with the specified reason.">
603 <helpop key="setidle" value="/SETIDLE <idle time>
605 Sets your idle time (in seconds) to the specified value.">
607 <helpop key="sethost" value="/SETHOST <host>
609 Sets your host to the specified host.">
611 <helpop key="setident" value="/SETIDENT <ident>
613 Sets your ident to the specified ident.">
615 <helpop key="swhois" line="/SWHOIS <nick> <swhois>
617 Sets the user's swhois field to the given swhois.">
619 <helpop key="mkpasswd" value="/MKPASSWD <hashtype> <plaintext>
621 Encodes the plaintext to a hash of the given type and displays
624 <helpop key="opermotd" value="/OPERMOTD
626 Displays the Oper MOTD.">
628 <helpop key="nicklock" value="/NICKLOCK <nick> <new nick>
630 Changes the user's nick to the new nick, and forces
631 it to remain as such for the remainder of the session.">
633 <helpop key="nickunlock" value="/NICKUNLOCK <nick>
635 Allows a previously locked user to change nicks again.">
637 <helpop key="chghost" value="/CHGHOST <nickname> <new hostname>
639 Changes the hostname of the user to the new hostname.">
641 <helpop key="chgname" value="/CHGNAME <nickname> <new name>
643 Changes the name of the user to the new name.">
645 <helpop key="chgident" value="/CHGIDENT <nickname> <new ident>
647 Changes the ident of the user to the new ident.">
649 <helpop key="shun" value="/SHUN <nick!user@host> [[<duration>] :<reason>]
651 Sets or removes a shun (server side ignore) on a host and ident mask.
652 You must specify all three parameters to add a shun, and one parameter
653 to remove a shun (just the nick!user@host section).
655 The duration may be specified in seconds, or in the format
656 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
657 5 minutes and 6 seconds. All fields in this format are optional.">
659 <helpop key="die" value="/DIE <server>
661 This command shuts down the local server. A single parameter is
662 required, which must match the name of the local server.">
664 <helpop key="restart" value="/RESTART <server>
666 This command restarts the local server. A single parameter is
667 required, which must match the name of the local server.">
669 <helpop key="commands" value="/COMMANDS
671 Shows all currently available commands.">
673 <helpop key="kill" value="/KILL <user> <reason>
675 This command will disconnect a user from IRC with the given reason.">
677 <helpop key="rehash" value="/REHASH <mask>
679 This command will cause the server configuration file to be reread and
680 values reinitialized for all servers matching the server mask, or the
681 local server if one is not specified.">
683 <helpop key="connect" value="/CONNECT <servermask>
685 Add a connection to the server matching the given server mask. You must
686 have configured the server for linking in your configuration file
687 before trying to link them.">
689 <helpop key="squit" value="/SQUIT <servermask>
691 Disconnects the server matching the given server mask from this server.">
693 <helpop key="modules" value="/MODULES
695 Lists currently loaded modules, their memory offsets, version numbers,
696 and flags. If you are not an operator, you will see reduced detail.">
698 <helpop key="loadmodule" value="/LOADMODULE <modname>
700 Loads the specified module into the local server.">
702 <helpop key="unloadmodule" value="/UNLOADMODULE <modname>
704 Unloads a module from the local server.">
706 <helpop key="reloadmodule" value="/RELOADMODULE <modname>
708 Unloads and reloads a module on the local server.">
710 <helpop key="gloadmodule" value="/GLOADMODULE <modname>
712 Loads the specified module on all linked servers.">
714 <helpop key="gunloadmodule" value="/GUNLOADMODULE <modname>
716 Unloads a module from all linked servers.">
718 <helpop key="greloadmodule" value="/GRELOADMODULE <modname>
720 Unloads and reloads a module on all linked servers.">
722 <helpop key="kline" value="/KLINE <user@host> [<duration> :<reason>]
724 Sets or removes a k-line (local host based ban) on a host and ident mask.
725 You must specify all three parameters to add a ban, and one parameter
726 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="zline" value="/ZLINE <ipmask> [<duration> :<reason>]
734 Sets or removes a z-line (ip based ban) on an ip range mask.
735 You must specify all three parameters to add a ban, and one parameter
736 to remove a ban (just the ipmask).
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 <helpop key="qline" value="/QLINE <nickmask> [<duration> :<reason>]
744 Sets or removes a q-line (nick based ban) on a nick mask.
745 You must specify all three parameters to add a ban, and one parameter
746 to remove a ban (just the nickmask).
748 The duration may be specified in seconds, or in the format
749 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
750 5 minutes and 6 seconds. All fields in this format are optional.">
752 <helpop key="gline" value="/GLINE <user@host> [<duration> :<reason>]
754 Sets or removes a g-line (host based ban) on host mask.
755 You must specify all three parameters to add a ban, and one
756 parameter to remove a ban (just the user@host section).
758 The duration may be specified in seconds, or in the format
759 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
760 5 minutes and 6 seconds. All fields in this format are optional.">
762 <helpop key="eline" value="/ELINE <user@host> [<duration> :<reason>]
764 Sets or removes a e-line (global ban exception) on host mask.
765 You must specify at least 3 parameters to add an exception, and one
766 parameter to remove an exception (just the user@host section).
768 The duration may be specified in seconds, or in the format
769 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
770 5 minutes and 6 seconds. All fields in this format are optional.
772 This command has a few important limitations. Bans on *@<ip> can only
773 be negated by an eline on *@<ip>, bans on *@<host> can be negated by
774 elines on *@<ip>, or *@<host>, and bans on <ident>@* or <ident>@<host>
775 can be negated by any eline that matches.">
777 <helpop key="wallops" value="/WALLOPS <message>
779 Sends a message to all +w users.">
781 <helpop key="rline" value="/RLINE <regex> [<duration> :<reason>]
783 Sets or removes an r-line (regex line) on a n!u@h\srealname mask. You
784 must specify all three parameters to add an rline, and one parameter
785 to remove an rline (just the regex).
787 The duration may be specified in seconds, or in the format
788 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
789 5 minutes and 6 seconds. All fields in this format are optional.">
791 <helpop key="close" value="/CLOSE
793 Closes all unregistered connections to the local server.">
795 <helpop key="clearchan" value="/CLEARCHAN <channel> [<KILL|KICK|G|Z>] [<reason>]
797 Quits or kicks all non-opers from a channel, optionally G/Z-Lines them.
798 Useful for quickly nuking bot channels.
800 The default method, KILL, simply disconnects the victims from the server,
801 while methods G and Z also add G/Z-Lines for all the targets.
803 When used, the victims won't see each other getting kicked or quitting.">
805 <helpop key="modenotice" value="/MODENOTICE <modeletters> <message>
807 Sends a notice to all users who have the given mode(s) set.
808 If multiple mode letters are given, the notice is only sent to users
809 who have all of them set.">
811 <helpop key="cloak" value="/CLOAK <host>
813 Generate the cloak of a host or IP. This is useful for example when
814 trying to get the cloak of a user from /WHOWAS and they were not
815 using their cloak when they quit.">
817 ######################
818 # User/Channel Modes #
819 ######################
821 <helpop key="umodes" value="User Modes
824 c Blocks private messages and notices from users who do
825 not share a common channel with you (requires the
827 d Deaf mode. User will not receive any messages or notices
828 from channels they are in (requires the deaf module).
829 g In combination with /ACCEPT, provides for server side
830 ignore (requires the callerid module).
831 h Marks as 'available for help' in WHOIS (IRCop only,
832 requires the helpop module).
833 i Makes invisible to /WHO if the user using /WHO is not in
835 k Prevents the user from being kicked from channels, or
836 having op modes removed from them (services only,
837 requires the servprotect module).
838 o Marks as a IRC operator.
839 s <mask> Receives server notices specified by <mask>
841 r Marks as a having a registered nickname
842 (requires the services account module).
843 w Receives wallops messages.
844 x Gives a cloaked hostname (requires the cloaking module).
845 z Only allow private messages from SSL users (requires the
847 B Marks as a bot (requires the botmode module).
848 G Censors messages sent to the user based on filters
849 configured for the network (requires the censor module).
850 H Hides an oper's oper status from WHOIS (requires the
852 I Hides a user's entire channel list in WHOIS from
853 non-IRCops (requires the hidechans module).
854 L Stops redirections done by m_redirect (mode must be
855 enabled in the config).
856 R Blocks private messages from unregistered users
857 (requires the services account module).
858 S Strips formatting codes out of private messages
859 to the user (requires the stripcolor module).
860 W Receives notification when a user uses WHOIS on them
861 (IRCop only, requires the showwhois module).">
863 <helpop key="chmodes" value="Channel Modes
866 v <nickname> Gives voice to <nickname>, allowing them to speak
867 while the channel is +m.
868 h <nickname> Gives halfop status to <nickname> (requires the
869 customprefix module).
870 o <nickname> Gives op status to <nickname>.
871 a <nickname> Gives protected status to <nickname>, preventing
872 them from being kicked (+q only, requires the
873 customprefix module).
874 q <nickname> Gives owner status to <nickname>, preventing them
875 from being kicked (Services or +q only, requires
876 the customprefix module).
878 b <hostmask> Bans <hostmask> from the channel.
879 e <hostmask> Excepts <hostmask> from bans (requires the
880 banexception module).
881 I <hostmask> Excepts <hostmask> from +i, allowing matching
882 users to join while the channel is invite-only
883 (requires the inviteexception module).
885 c Blocks messages that contain formatting codes
886 (requires the blockcolor module).
887 d <time> Blocks messages to a channel from new users
888 until they have been in the channel for <time>
889 seconds (requires the delaymsg module).
890 f [*]<lines>:<sec> Kicks on text flood equal to or above the
891 specified rate. With *, the user is banned
892 (requires the messageflood module).
893 g <mask> Blocks messages matching the given glob mask
894 (requires the chanfilter module).
895 i Makes the channel invite-only.
896 Users can only join if an operator
897 uses /INVITE to invite them.
898 j <joins>:<sec> Limits joins to the specified rate (requires
899 the joinflood module).
900 k <key> Set the channel key (password) to <key>.
901 l <limit> Set the maximum allowed users to <limit>.
902 m Enable moderation. Only users with +v, +h, or +o
904 n Blocks users who are not members of the channel
906 p Make channel private, hiding it in users' whoises
907 and replacing it with * in /LIST.
908 r Marks the channel as registered with Services
909 (requires the services account module).
910 s Make channel secret, hiding it in users' whoises
912 t Prevents users without +h or +o from changing the
914 u Makes the channel an auditorium; normal users only
915 see themselves or themselves and the operators,
916 while operators see all the users (requires the
918 w <flag>:<banmask> Adds basic channel access controls of <flag> to
919 <banmask>, via the +w listmode.
920 For example, +w o:R:Brain will op anyone identified
921 to the account 'Brain' on join.
922 (requires the autoop module)
923 z Blocks non-SSL clients from joining the channel.
925 A Allows anyone to invite users to the channel
926 (normally only chanops can invite, requires
927 the allowinvite module).
928 B Blocks messages with too many capital letters,
929 as determined by the network configuration
930 (requires the blockcaps module).
931 C Blocks any CTCPs to the channel (requires the
933 D Delays join messages from users until they message
934 the channel (requires the delayjoin module).
935 E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similar messages.
936 Kicks as default, blocks with ~ and bans with *
937 The last two parameters are optional.
938 F <changes>:<sec> Blocks nick changes when they equal or exceed the
939 specified rate (requires the nickflood module).
940 G Censors messages to the channel based on the
941 network configuration (requires the censor module).
942 H <num>:<duration> Displays the last <num> lines of chat to joining
943 users. <duration> is the maximum time to keep
944 lines in the history buffer (requires the
946 J <seconds> Prevents rejoin after kick for the specified
947 number of seconds. This prevents auto-rejoin
948 (requires the kicknorejoin module).
949 K Blocks /KNOCK on the channel.
950 L <channel> If the channel reaches its limit set by +l,
951 redirect users to <channel> (requires the
953 M Blocks unregistered users from speaking (requires
954 the services account module).
955 N Prevents users on the channel from changing nick
956 (requires the nonicks module).
957 O Channel is IRCops only (can only be set by IRCops,
958 requires the operchans module).
959 P Makes the channel permanent; Bans, invites, the
960 topic, modes, and such will not be lost when it
961 empties (can only be set by IRCops, requires
962 the permchannels module).
963 Q Only ulined servers and their users can kick
964 (requires the nokicks module)
965 R Blocks unregistered users from joining (requires
966 the services account module).
967 S Strips formatting codes from messages to the
968 channel (requires the stripcolor module).
969 T Blocks /NOTICEs to the channel from users who are
970 not at least halfop (requires the nonotice module).
971 X <type>:<status> Makes users of <status> or higher exempt to the
972 specified restriction <type>. For example: flood:h
973 (requires the exemptchanops module).
974 Possible restriction types to exempt with +X are:
976 auditorium-see Permission required to see the full user list of
977 a +u channel (requires the auditorium module).
978 auditorium-vis Permission required to be visible in a +u channel
979 (requires the auditorium module).
980 blockcaps Channel mode +B
981 blockcolor Channel mode +c
982 censor Channel mode +G
983 filter Channel mode +g
984 flood Channel mode +f
985 nickflood Channel mode +F
986 noctcp Channel mode +C
987 nonick Channel mode +N
988 nonotice Channel mode +T
989 regmoderated Channel mode +M
990 stripcolor Channel mode +S
991 topiclock Channel mode +t
994 NOTE: A large number of these modes are dependent upon server-side modules
995 being loaded by a server/network administrator. The actual modes available
996 on your network may be very different to this list. Please consult your
997 help channel if you have any questions.">
999 ######################
1001 ######################
1003 <helpop key="stats" value="/STATS <symbol>
1005 Shows various server statistics. Depending on configuration, some
1006 symbols may be only available to opers.
1010 e Show E-lines (local ban exemptions)
1011 g Show G-lines (host bans)
1012 k Show K-lines (local host bans)
1013 q Show Q-lines (nick mask bans)
1014 R Show R-lines (regular expression bans)
1015 Z Show Z-lines (IP mask bans)
1022 d Show configured DNSBLs and related statistics
1023 m Show command statistics, number of times commands have been used
1024 o Show a list of all valid oper usernames and hostmasks
1025 p Show open client ports, and the port type (ssl, plaintext, etc)
1026 u Show server uptime
1027 z Show memory usage statistics
1028 i Show connect class permissions
1029 l Show all client connections with information (sendq, commands, bytes, time connected)
1030 L Show all client connections with information and IP address
1031 P Show online opers and their idle times
1032 T Show bandwidth/socket statistics
1033 U Show U-lined servers
1034 Y Show connection classes
1035 O Show opertypes and the allowed user and channel modes it can set
1036 E Show socket engine events
1037 S Show currently held registered nicknames
1038 G Show how many local users are connected from each country according to GeoIP
1040 Note that all /STATS use is broadcast to online IRC operators.">
1042 ######################
1044 ######################
1046 <helpop key="snomasks" value="Server Notice Masks
1048 a Allows receipt of local announcement messages.
1049 A Allows receipt of remote announcement messages.
1050 c Allows receipt of local connect messages.
1051 C Allows receipt of remote connect messages.
1052 d Allows receipt of local DNSBL messages (requires the dnsbl module).
1053 D Allows receipt of remote DNSBL messages (requires the dnsbl module).
1054 f Allows receipt of local filter messages (requires the filter module).
1055 F Allows receipt of remote filter messages (requires the filter module).
1056 g Allows receipt of globops (requires the globops module).
1057 j Allows receipt of channel creation notices (requires the chancreate module).
1058 J Allows receipt of remote channel creation notices (requires the chancreate module).
1059 k Allows receipt of local kill messages.
1060 K Allows receipt of remote kill messages.
1061 l Allows receipt of local linking related messages.
1062 L Allows receipt of remote linking related messages.
1063 n See local nickname changes (requires the seenicks module).
1064 N See remote nickname changes (requires the seenicks modules).
1065 o Allows receipt of oper-up, oper-down, and oper-failure messages.
1066 O Allows receipt of remote oper-up, oper-down, and oper-failure messages.
1067 q Allows receipt of local quit messages.
1068 Q Allows receipt of remote quit messages.
1069 r Allows receipt of local oper commands (requires the operlog module).
1070 R Allows receipt of remote oper commands (requires the operlog module).
1071 t Allows receipt of attempts to use /STATS (local and remote).
1072 v Allows receipt of oper-override notices (requires the override module).
1073 x Allows receipt of local Xline notices (g/Z/q/k/e/R/shuns).
1074 X Allows receipt of remote Xline notices (g/Z/q/k/e/R/shuns).">
1076 ######################
1078 ######################
1080 <helpop key="extbans" value="Extended Bans
1083 Extbans are split into two types; matching extbans, which match on
1084 users in additional ways, and acting extbans, which restrict users
1085 in different ways to a standard ban.
1087 To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
1088 instead of a normal nick!user@host mask, to ban or exempt matching
1089 users. Ban exceptions on acting extbans exempt that user from matching
1090 an extban of that type, and from any channel mode corresponding to the
1091 restriction. Matching extbans may also be used for invite exceptions by
1092 setting +I <extban>.
1096 a:<mask> Matches user with both a matching banmask and realname,
1097 where <mask> is in the format nick!user@host+realname
1098 (requires gecosban module).
1099 j:<channel> Matches anyone in the given channel. Does not support
1100 wildcards (requires the channelban module).
1101 n:<class> Matches users in a matching connect class (requires the
1103 r:<realname> Matches users with a matching real name (requires the
1105 s:<server> Matches users on a matching server (requires the
1107 z:<certfp> Matches users having the given SSL certificate
1108 fingerprint (requires the sslmodes module).
1109 O:<opertype> Matches IRCops of a matching type, mostly useful as an
1110 an invite exception (requires the operchans module).
1111 R:<account> Matches users logged into a matching account (requires
1112 the services account module).
1113 U:<banmask> Matches unregistered users matching the given banmask.
1114 (requires the services account module).
1118 c:<banmask> Blocks any messages that contain formatting codes from
1119 matching users (requires the blockcolor module).
1120 m:<banmask> Blocks messages from matching users (requires the muteban
1121 module). Users with +v or above are not affected.
1122 p:<banmask> Blocks part messages from matching users (requires
1123 the nopartmsg module).
1124 A:<banmask> Blocks invites by matching users even when +A is set
1125 (requires the allowinvite module).
1126 B:<banmask> Blocks all capital or nearly all capital messages from
1127 matching users (requires the blockcaps module).
1128 C:<banmask> Blocks CTCPs from matching users (requires the noctcp
1130 N:<banmask> Blocks nick changes from matching users (requires
1131 the nonicks module).
1132 Q:<banmask> Blocks kicks by matching users (requires the nokicks
1134 S:<banmask> Strips formatting codes from messages from matching
1135 users (requires the stripcolor module).
1136 T:<banmask> Blocks notices from matching users (requires the
1139 A ban given to an Acting extban may either be a nick!user@host mask
1140 (unless stated otherwise), matched against users as for a normal ban,
1141 or a Matching extban.
1143 There is an additional special type of extended ban, a redirect ban:
1145 Redirect n!u@h#channel will redirect the banned user to #channel
1146 when they try to join (requires the banredirect module).">