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="squery" value="/SQUERY <target> <text>
47 Sends a message to the network service specified in <target>.">
49 <helpop key="sslinfo" value="/SSLINFO <nick>
51 Displays information on the SSL connection and certificate of the
54 <helpop key="uninvite" value="/UNINVITE <nick> <channel>
56 Uninvite a user from a channel, same syntax as INVITE.">
58 <helpop key="tban" value="/TBAN <channel> <duration> <banmask>
60 Sets a timed ban. The duration of the ban can be specified in the
61 following format: 1w2d3h4m6s which indicates a ban of one week, two
62 days, three hours, four minutes and six seconds. Alternatively the
63 ban may just be specified as a number of seconds. All timed bans
64 appear in the banlist as normal bans and may be safely removed
65 before their time is up.">
67 <helpop key="dccallow" value="/DCCALLOW - List allowed nicks
68 /DCCALLOW LIST - This also lists allowed nicks
69 /DCCALLOW +<nick> [<duration>] - Add a nick
70 /DCCALLOW -<nick> - Remove a nick
71 /DCCALLOW HELP - Display help
73 Duration is optional, and may be specified in seconds or in the
76 <helpop key="accept" value="/ACCEPT * - List accepted nicks
77 /ACCEPT +<nick> - Add a nick
78 /ACCEPT -<nick> - Remove a nick
79 This command accepts multiple nicks like so:
80 /ACCEPT +<nick1>,+<nick2>,-<nick3>
82 Manages your accept list. This list is used to determine who can
83 private message you when you have usermode +g set.">
85 <helpop key="cycle" value="/CYCLE <channel> :[<reason>]
87 Cycles a channel (leaving and rejoining), overrides restrictions that
88 would stop a new user joining, such as user limits and channel keys.">
90 <helpop key="title" value="/TITLE <name> <password>
92 Authenticate for a WHOIS title line and optionally a vhost using the
93 specified username and password.">
95 <helpop key="watch" value="/WATCH - List watched nicks that are online
96 /WATCH L - List watched nicks, online and offline
97 /WATCH C - Clear all watched nicks
98 /WATCH S - Show statistics
99 /WATCH +<nick> - Add a nick
100 /WATCH -<nick> - Remove a nick
101 This command accepts multiple nicks like so:
102 /WATCH +<nick1> +<nick2> -<nick3>">
104 <helpop key="vhost" value="/VHOST <username> <password>
106 Authenticate for a vhost using the specified username and password.">
108 <helpop key="remove" value="/REMOVE <channel> <nick> [<reason>]
110 Removes a user from a channel you specify. You must be at least a
111 channel halfoperator to remove a user. A removed user will part with
112 a message stating they were removed from the channel and by whom.">
114 <helpop key="rmode" value="/RMODE [channel] [modeletter] {[pattern]}
116 Removes listmodes from a channel.
117 E.g. /RMODE #Chan b m:* will remove all mute extbans.">
119 <helpop key="fpart" value="/FPART <channel> <nick> [<reason>]
121 This behaves identically to /REMOVE. /REMOVE is a built-in mIRC command
122 which caused trouble for some users.">
124 <helpop key="silence" value="/SILENCE - Shows a list of silenced masks
125 /SILENCE +<mask> [<flags>] - Add a mask
126 /SILENCE -<mask> - Remove a mask
128 A serverside ignore of the given n!u@h mask. The letter(s) at the end
129 specify what is to be ignored from this hostmask.
134 p Block private messages
135 c Block channel messages
137 n Block private notices
138 t Block channel notices
139 a Block all of the above
142 Multiple letters may be specified. For an exception, you must pair x
143 with what you want excepted. For example, if you wanted to except
144 everything from people with a host matching *.foo.net, you would do
145 /SILENCE +*!*@*.foo.net xa
147 /SILENCE without a parameter will list the masks that you have silenced.">
149 <helpop key="knock" value="/KNOCK <channel>
151 Sends a notice to a channel indicating you wish to join.">
153 <helpop key="user" value="/USER <ident> <local host> <remote host> :<real name>
155 This command is used by your client to register your
156 IRC session, providing your ident and real name to the
159 You should not use it during an established connection.">
161 <helpop key="nick" value="/NICK <new nick>
163 Change your nickname to <new nick>.">
165 <helpop key="quit" value="/QUIT [<reason>]
167 Quit from IRC and end your current session.">
169 <helpop key="version" value="/VERSION
171 Returns the server's version information.">
173 <helpop key="ping" value="/PING <server>
175 Ping a server. The server will answer with a PONG.">
177 <helpop key="pong" value="/PONG <server>
179 Your client should send this to answer server PINGs. You
180 should not issue this command manually.">
182 <helpop key="admin" value="/ADMIN [<server>]
184 Shows the administrative information for the given server.">
186 <helpop key="privmsg" value="/PRIVMSG <target> <text>
188 Sends a message to a user or channel specified in <target>.">
190 <helpop key="notice" value="/NOTICE <target> <text>
192 Sends a notice to a user or channel specified in <target>.">
194 <helpop key="join" value="/JOIN <channel>[,<channel>] [<key>][,<key>]
196 Joins one or more channels you provide the names for.">
198 <helpop key="names" value="/NAMES <channel>[,<channel>]
200 Return a list of users on the channels you provide.">
202 <helpop key="part" value="/PART <channel>[,<channel>] [<reason>]
204 Leaves one or more channels you specify.">
206 <helpop key="kick" value="/KICK <channel> <nick>[,<nick>] [<reason>]
208 Kicks a user from a channel you specify. You must be
209 at least a channel halfoperator to kick a user.">
211 <helpop key="mode" value="/MODE <target> (+|-)<modes> [<mode parameters>] - Change modes of <target>.
213 /MODE <target> - Show modes of <target>.
215 /MODE <channel> <list mode char> - List bans, exceptions, etc. set on <channel>.
217 Sets the mode for a channel or a nickname specified in <target>.
218 A user may only set modes upon themselves, and may not set the
219 +o usermode, and a user may only change channel modes of
220 channels where they are at least a halfoperator.
222 For a list of all user and channel modes, enter /HELPOP UMODES or
225 <helpop key="topic" value="/TOPIC <channel> [<topic>]
227 Sets or retrieves the channel topic. If a channel topic is
228 given in the command and either the channel is not +t, or
229 you are at least a halfoperator, the channel topic will be
230 changed to the new one you provide.">
232 <helpop key="who" value="/WHO <pattern> [<flags>][%[<fields>[,<querytype>]]] <pattern>
234 Looks up information about users matching the provided pattern. You can specify
235 a flag specific pattern, a channel name, user hostname, a user server name, a
236 user real name, or a user nickname. Matching users will only be included in the
239 1) The specified pattern is an exact channel name that does not have the
240 private or secret channel modes set and the user does not have the invisible
242 2) The specified pattern is an exact nickname.
243 3) You share one or more common channels with the user.
244 4) The user does not have the invisible user mode set.
245 5) You are a server operator with the users/auspex privilege.
247 If you specify any fields the response returned will be a WHOX response rather
248 than a RFC 1459 WHO response.
253 The following flags use <pattern> to match against the specified user data:
255 A Show users who have an away message matching <pattern>.
256 a Show users who have an account name matching <pattern>.
257 h Show users who have a hostname matching <pattern>. If the 'x' modifier
258 is specified then this will match against the real hostname instead of
259 the display hostname.
260 i Show users who have an IP address matching <pattern>.
261 m Show users who have the modes listed in <pattern>. The pattern
262 should be in the same format as a mode change e.g. +ow-i (server
264 n Show users who have a nickname matching <pattern>.
265 p Show users who are connected to a port in the <pattern> range (server
267 r Show users who have a real name matching <pattern>.
268 s Show users who are on a server with a name matching <pattern>. If the 'x'
269 modifier is specified then this will match against the real server name
270 instead of the masked server name.
271 t Show users who have connected in the last <pattern> seconds.
272 u Show users who have an ident (username) matching <pattern>.
274 The following flags filter users by their status:
276 f Only show users on remote (far) servers.
277 l Only show users on the local server.
278 o Only show server operators.
280 The following flags modify the command output:
282 x Show sensitive data like real user hostnames and, when hideserver is
283 enabled, real server hostnames.
285 You may combine one flag from the first group and multiple from the others in
291 a Include the user's account name in the response.
292 c Include the first common channel name in the response.
293 d Include the user's server distance from you in the response.
294 f Include the user's away status, oper status, and highest channel prefix
296 h Include the user's hostname in the response. If the 'x' flag was
297 specified then this is the real host rather than the display host.
298 i Include the user's IP address in the response.
299 l Include the user's idle time in the response.
300 n Include the user's nickname in the response.
301 o Include the user's channel operator rank level in the response.
302 r Include the user's real name in the response.
303 s Include the user's server name in the response. If the 'x' flag was
304 specified then this is the real server name rather than the masked server
306 t Include the query type in the response.
307 u Include the user's ident in the response.
311 <helpop key="motd" value="/MOTD [<server>]
313 Show the message of the day for <server>. Messages of the day often
314 contain important server rules and notices and should be read prior
317 <helpop key="oper" value="/OPER <login> <password>
319 Attempts to authenticate a user as an IRC operator.
321 Both successful and unsuccessful oper attempts are
322 logged, and sent to online IRC operators.">
324 <helpop key="list" value="/LIST [<pattern>]
326 Creates a list of all existing channels matching the glob pattern
327 <pattern>, e.g. *chat* or bot*.">
329 <helpop key="lusers" value="/LUSERS
331 Shows a count of local and remote users, servers and channels.">
333 <helpop key="userhost" value="/USERHOST <nick> [<nick>]
335 Returns the hostname and nickname of a user, and some other
336 miscellaneous information.">
338 <helpop key="away" value="/AWAY [<message>]
340 If a message is given, marks you as being away, otherwise
341 removes your away status and previous message.">
343 <helpop key="ison" value="/ISON <nick> [<nick> ...]
345 Returns a subset of the nicks you give, showing only those
346 that are currently online.">
348 <helpop key="invite" value="/INVITE <nick> <channel> [<time>]
350 Invites a user to a channel. If the channel is NOT +A, only
351 channel halfoperators or above can invite people. If +A is set,
352 anyone can invite people to the channel, as long as the person
353 doing the invite is a member of the channel they wish to invite
356 Invited users may override bans, +k, and similar in addition to
357 +i, depending on configuration.
359 If a time is provided, the invite expires after that time and the user
360 can no longer use it to enter the channel.">
362 <helpop key="pass" value="/PASS <password>
364 This command is used by your client when setting up
365 your IRC session to submit a server password to the
368 You should not use it during an established connection.">
370 <helpop key="whowas" value="/WHOWAS <nick>
372 Returns a list of times the user was seen recently on IRC along with
373 the time they were last seen and their server.">
375 <helpop key="links" value="/LINKS
377 Shows all servers linked to this one.">
379 <helpop key="map" value="/MAP
381 Shows a graphical representation of all users and servers on the
382 network, and the links between them, as a tree from the perspective
385 <helpop key="whois" value="/WHOIS <nick> [<server>]
387 Returns the WHOIS information of a user, their channels, hostname,
388 etc. If a second nickname or server is provided, then a whois is
389 performed from the server where the user is actually located rather
390 than locally, showing idle and signon times.">
392 <helpop key="time" value="/TIME [<server>]
394 Returns the local time of the server, or remote time of another
397 <helpop key="info" value="/INFO [<server>]
399 Returns information on the developers and supporters who made this
400 IRC server possible.">
402 <helpop key="setname" value="/SETNAME <name>
404 Sets your name to the specified name.">
407 #####################
409 #####################
411 <helpop key="coper" value="Oper Commands
414 OPERMOTD CHECK CLONES USERIP TLINE
415 ALLTIME WALLOPS GLOBOPS MODENOTICE
418 SETHOST SETIDENT CHGHOST CHGIDENT CHGNAME
421 SANICK NICKLOCK NICKUNLOCK
423 SAJOIN SAPART SAMODE SATOPIC SAKICK
425 KILL SAQUIT GLINE ZLINE QLINE
426 KLINE RLINE ELINE CBAN SHUN
427 FILTER OJOIN CLEARCHAN
429 CONNECT SQUIT RCONNECT RSQUIT
432 LOADMODULE UNLOADMODULE
433 RELOADMODULE GLOADMODULE GUNLOADMODULE
434 GRELOADMODULE CLOSE JUMPSERVER
435 LOCKSERV UNLOCKSERV">
437 <helpop key="userip" value="/USERIP <nick> [<nick>]
439 Returns the ip and nickname of the given users.">
441 <helpop key="tline" value="/TLINE <mask>
443 This command returns the number of local and global clients matched,
444 and the percentage of clients matched, plus how they were matched
445 (by IP address or by hostname). Mask should be given as either a
446 nick!user@host or user@IP (wildcards acceptable).">
448 <helpop key="lockserv" value="/LOCKSERV :[<message>]
450 Locks out all new connections notifying connecting users that the
451 service is temporarily closed and to try again later.">
453 <helpop key="unlockserv" value="/UNLOCKSERV
455 Opens the server up again for new connections.">
457 <helpop key="jumpserver" value="/JUMPSERVER [<newserver> <newport> <(+|-)[flags]> :[<reason>]]
459 Sets or cancels jumpserver mode. If no parameters are given,
460 jumpserver mode is cancelled, if it is currently set. If parameters
461 are given, a server address must be given for <newserver> and a
462 server port must be given for <newport>. Zero or more status flags
463 should be given for 'flags', from the list below (if you do not
464 wish to specify any flags just place a '+' in this field):
466 1. +a: Redirect all users immediately (except for opers) and cause
467 them to quit with the given reason
469 2. +n: Redirect any new users who connect and cause them to quit
472 You may use + and - to set or unset these flags in the command, the
473 default flags are -a+n, which will just redirect new users. The
474 reason parameter is optional, and if not provided defaults to
475 'Please use this server/port instead' (the default given in various
478 <helpop key="filter" value="/FILTER <filter-definition> [<action> <flags> [<duration>] :<reason>]
480 This command will add a filter when more than one parameter is given,
481 for messages of the types specified by the flags, with the given
482 filter definition, action, duration (when the action is 'gline',
483 'zline' or 'shun'), and reason.
485 The filter will take effect when a message of any type specified by
486 the flags and matching the definition is sent to the server, and
487 perform the specified action.
493 Warn Lets the message through and informs +s IRCops of the message
494 and all relevant info
495 Block Blocks message and informs +s IRCops of the blocked message
496 and all relevant info
497 Silent Blocks message, but does not notify IRCops
499 Gline G-lines the user for the specified duration
500 Zline Z-lines the user for the specified duration
501 Shun Shuns the user for the specified duration (requires the shun module)
506 p Block private and channel messages
507 n Block private and channel notices
508 P Block part messages
509 q Block quit messages
510 o Don't match against opers
511 c Strip all formatting codes from the message before matching
512 * Represents all of the above flags
513 - Does nothing, a non-op for when you do not want to specify any
516 The reason for the filter will be used as the reason for the action,
517 unless the action is 'none', and is sent to the user when their text is
518 blocked by 'block' and 'silent' actions.
520 A G-line, Z-line or shun duration may be specified in seconds, or in the
521 format 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5
522 minutes and 6 seconds. All fields in this format are optional.
524 When only one parameter is provided (the filter pattern) the provided
525 filter will be removed. Note that if you remove a
526 configuration-defined filter, it will reappear at next rehash unless
527 it is also removed from the config file.">
529 <helpop key="ojoin" value="/OJOIN <channel>
531 Force joins you to the specified channel, and gives you +Y and any other
532 configuration-defined modes on it, preventing you from being kicked.
533 Depending on configuration, may announce that you have joined the
534 channel on official network business.">
536 <helpop key="clones" value="/CLONES <limit>
538 Retrieves a list of users with more clones than the specified
541 <helpop key="check" value="/CHECK <nick|ip|hostmask|channel> [<server>]
543 Allows opers to look up advanced information on channels, hostmasks
544 or IP addresses, in a similar way to WHO but in more detail, displaying
545 most information the IRCD has stored on the target, including all
548 With the second parameter given, runs the command remotely on the
551 <helpop key="alltime" value="/ALLTIME
553 Shows the time on all servers on the network.">
555 <helpop key="rconnect" value="/RCONNECT <source mask> <target mask>
557 The server matching <source mask> will try to connect to the first
558 server in the config file matching <target mask>.">
560 <helpop key="rsquit" value="/RSQUIT <target mask> [<reason>]
562 Causes a remote server matching <target mask> to be disconnected from
565 <helpop key="globops" value="/GLOBOPS <message>
567 Sends a message to all users with the +g snomask.">
569 <helpop key="cban" value="/CBAN <channel> [<duration> :[<reason>]]
571 Sets or removes a channel ban. You must specify all three parameters
572 to add a ban, and one parameter to remove a ban (just the channel).
574 The duration may be specified in seconds, or in the format
575 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
576 5 minutes and 6 seconds. All fields in this format are optional.">
578 <helpop key="sajoin" value="/SAJOIN [<nick>] <channel>[,<channel>]
580 Forces the user to join the channel(s).
581 If no nick is given, it joins the oper doing the /SAJOIN.">
583 <helpop key="sapart" value="/SAPART <nick> <channel>[,<channel>]
585 Forces the user to part the channel(s).">
587 <helpop key="samode" value="/SAMODE <target> (+|-)<modes> [<parameters for modes>]
589 Applies the given mode change to the channel or nick specified.">
591 <helpop key="sanick" value="/SANICK <nick> <new nick>
593 Changes the user's nick to the new nick.">
595 <helpop key="sakick" value="/SAKICK <channel> <nick> <reason>
597 Kicks the given user from the specified channel.">
599 <helpop key="satopic" value="/SATOPIC <channel> <new topic>
601 Applies the given topic to the specified channel.">
603 <helpop key="saquit" value="/SAQUIT <nick> <reason>
605 Forces user to quit with the specified reason.">
607 <helpop key="setidle" value="/SETIDLE <idle time>
609 Sets your idle time (in seconds) to the specified value.">
611 <helpop key="sethost" value="/SETHOST <host>
613 Sets your host to the specified host.">
615 <helpop key="setident" value="/SETIDENT <ident>
617 Sets your ident to the specified ident.">
619 <helpop key="swhois" line="/SWHOIS <nick> <swhois>
621 Sets the user's swhois field to the given swhois.">
623 <helpop key="mkpasswd" value="/MKPASSWD <hashtype> <plaintext>
625 Encodes the plaintext to a hash of the given type and displays
628 <helpop key="opermotd" value="/OPERMOTD
630 Displays the Oper MOTD.">
632 <helpop key="nicklock" value="/NICKLOCK <nick> <new nick>
634 Changes the user's nick to the new nick, and forces
635 it to remain as such for the remainder of the session.">
637 <helpop key="nickunlock" value="/NICKUNLOCK <nick>
639 Allows a previously locked user to change nicks again.">
641 <helpop key="chghost" value="/CHGHOST <nickname> <new hostname>
643 Changes the hostname of the user to the new hostname.">
645 <helpop key="chgname" value="/CHGNAME <nickname> <new name>
647 Changes the name of the user to the new name.">
649 <helpop key="chgident" value="/CHGIDENT <nickname> <new ident>
651 Changes the ident of the user to the new ident.">
653 <helpop key="shun" value="/SHUN <nick!user@host> [[<duration>] :<reason>]
655 Sets or removes a shun (server side ignore) on a host and ident mask.
656 You must specify all three parameters to add a shun, and one parameter
657 to remove a shun (just the nick!user@host section).
659 The duration may be specified in seconds, or in the format
660 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
661 5 minutes and 6 seconds. All fields in this format are optional.">
663 <helpop key="die" value="/DIE <server>
665 This command shuts down the local server. A single parameter is
666 required, which must match the name of the local server.">
668 <helpop key="restart" value="/RESTART <server>
670 This command restarts the local server. A single parameter is
671 required, which must match the name of the local server.">
673 <helpop key="commands" value="/COMMANDS
675 Shows all currently available commands.">
677 <helpop key="kill" value="/KILL <user> <reason>
679 This command will disconnect a user from IRC with the given reason.">
681 <helpop key="rehash" value="/REHASH <mask>
683 This command will cause the server configuration file to be reread and
684 values reinitialized for all servers matching the server mask, or the
685 local server if one is not specified.">
687 <helpop key="connect" value="/CONNECT <servermask>
689 Add a connection to the server matching the given server mask. You must
690 have configured the server for linking in your configuration file
691 before trying to link them.">
693 <helpop key="squit" value="/SQUIT <servermask>
695 Disconnects the server matching the given server mask from this server.">
697 <helpop key="modules" value="/MODULES
699 Lists currently loaded modules, their memory offsets, version numbers,
700 and flags. If you are not an operator, you will see reduced detail.">
702 <helpop key="loadmodule" value="/LOADMODULE <modname>
704 Loads the specified module into the local server.">
706 <helpop key="unloadmodule" value="/UNLOADMODULE <modname>
708 Unloads a module from the local server.">
710 <helpop key="reloadmodule" value="/RELOADMODULE <modname>
712 Unloads and reloads a module on the local server.">
714 <helpop key="gloadmodule" value="/GLOADMODULE <modname>
716 Loads the specified module on all linked servers.">
718 <helpop key="gunloadmodule" value="/GUNLOADMODULE <modname>
720 Unloads a module from all linked servers.">
722 <helpop key="greloadmodule" value="/GRELOADMODULE <modname>
724 Unloads and reloads a module on all linked servers.">
726 <helpop key="kline" value="/KLINE <user@host> [<duration> :<reason>]
728 Sets or removes a K-line (local host based ban) on a host and ident mask.
729 You must specify all three parameters to add a ban, and one parameter
730 to remove a ban (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 <helpop key="zline" value="/ZLINE <ipmask> [<duration> :<reason>]
738 Sets or removes a Z-line (ip based ban) on an ip range mask.
739 You must specify all three parameters to add a ban, and one parameter
740 to remove a ban (just the ipmask).
742 The duration may be specified in seconds, or in the format
743 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
744 5 minutes and 6 seconds. All fields in this format are optional.">
746 <helpop key="qline" value="/QLINE <nickmask> [<duration> :<reason>]
748 Sets or removes a Q-line (nick based ban) on a nick mask.
749 You must specify all three parameters to add a ban, and one parameter
750 to remove a ban (just the nickmask).
752 The duration may be specified in seconds, or in the format
753 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
754 5 minutes and 6 seconds. All fields in this format are optional.">
756 <helpop key="gline" value="/GLINE <user@host> [<duration> :<reason>]
758 Sets or removes a G-line (host based ban) on host mask.
759 You must specify all three parameters to add a ban, and one
760 parameter to remove a ban (just the user@host section).
762 The duration may be specified in seconds, or in the format
763 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
764 5 minutes and 6 seconds. All fields in this format are optional.">
766 <helpop key="eline" value="/ELINE <user@host> [<duration> :<reason>]
768 Sets or removes a E-line (global ban exception) on host mask.
769 You must specify at least 3 parameters to add an exception, and one
770 parameter to remove an exception (just the user@host section).
772 The duration may be specified in seconds, or in the format
773 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
774 5 minutes and 6 seconds. All fields in this format are optional.
776 This command has a few important limitations. Bans on *@<ip> can only
777 be negated by an E-line on *@<ip>, bans on *@<host> can be negated by
778 E-lines on *@<ip>, or *@<host>, and bans on <ident>@* or <ident>@<host>
779 can be negated by any E-line that matches.">
781 <helpop key="wallops" value="/WALLOPS <message>
783 Sends a message to all +w users.">
785 <helpop key="rline" value="/RLINE <regex> [<duration> :<reason>]
787 Sets or removes an R-line (regex line) on a n!u@h\srealname mask. You
788 must specify all three parameters to add an R-line, and one parameter
789 to remove an R-line (just the regex).
791 The duration may be specified in seconds, or in the format
792 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
793 5 minutes and 6 seconds. All fields in this format are optional.">
795 <helpop key="close" value="/CLOSE
797 Closes all unregistered connections to the local server.">
799 <helpop key="clearchan" value="/CLEARCHAN <channel> [<KILL|KICK|G|Z>] [<reason>]
801 Quits or kicks all non-opers from a channel, optionally G/Z-lines them.
802 Useful for quickly nuking bot channels.
804 The default method, KILL, simply disconnects the victims from the server,
805 while methods G and Z also add G/Z-lines for all the targets.
807 When used, the victims won't see each other getting kicked or quitting.">
809 <helpop key="modenotice" value="/MODENOTICE <modeletters> <message>
811 Sends a notice to all users who have the given mode(s) set.
812 If multiple mode letters are given, the notice is only sent to users
813 who have all of them set.">
815 <helpop key="cloak" value="/CLOAK <host>
817 Generate the cloak of a host or IP. This is useful for example when
818 trying to get the cloak of a user from /WHOWAS and they were not
819 using their cloak when they quit.">
821 ######################
822 # User/Channel Modes #
823 ######################
825 <helpop key="umodes" value="User Modes
828 c Blocks private messages and notices from users who do
829 not share a common channel with you (requires the
831 d Deaf mode. User will not receive any messages or notices
832 from channels they are in (requires the deaf module).
833 g In combination with /ACCEPT, provides for server side
834 ignore (requires the callerid module).
835 h Marks as 'available for help' in WHOIS (IRCop only,
836 requires the helpop module).
837 i Makes invisible to /WHO if the user using /WHO is not in
839 k Prevents the user from being kicked from channels, or
840 having op modes removed from them (services only,
841 requires the servprotect module).
842 o Marks as a IRC operator.
843 s <mask> Receives server notices specified by <mask>
845 r Marks as a having a registered nickname
846 (requires the services account module).
847 w Receives wallops messages.
848 x Gives a cloaked hostname (requires the cloaking module).
849 z Only allow private messages from SSL users (requires the
851 B Marks as a bot (requires the botmode module).
852 G Censors messages sent to the user based on filters
853 configured for the network (requires the censor module).
854 H Hides an oper's oper status from WHOIS (requires the
856 I Hides a user's entire channel list in WHOIS from
857 non-IRCops (requires the hidechans module).
858 L Stops redirections done by m_redirect (mode must be
859 enabled in the config).
860 R Blocks private messages from unregistered users
861 (requires the services account module).
862 S Strips formatting codes out of private messages
863 to the user (requires the stripcolor module).
864 W Receives notification when a user uses WHOIS on them
865 (IRCop only, requires the showwhois module).">
867 <helpop key="chmodes" value="Channel Modes
870 v <nickname> Gives voice to <nickname>, allowing them to speak
871 while the channel is +m.
872 h <nickname> Gives halfop status to <nickname> (requires the
873 customprefix module).
874 o <nickname> Gives op status to <nickname>.
875 a <nickname> Gives protected status to <nickname>, preventing
876 them from being kicked (+q only, requires the
877 customprefix module).
878 q <nickname> Gives owner status to <nickname>, preventing them
879 from being kicked (Services or +q only, requires
880 the customprefix module).
882 b <hostmask> Bans <hostmask> from the channel.
883 e <hostmask> Excepts <hostmask> from bans (requires the
884 banexception module).
885 I <hostmask> Excepts <hostmask> from +i, allowing matching
886 users to join while the channel is invite-only
887 (requires the inviteexception module).
889 c Blocks messages that contain formatting codes
890 (requires the blockcolor module).
891 d <time> Blocks messages to a channel from new users
892 until they have been in the channel for <time>
893 seconds (requires the delaymsg module).
894 f [*]<lines>:<sec> Kicks on text flood equal to or above the
895 specified rate. With *, the user is banned
896 (requires the messageflood module).
897 g <mask> Blocks messages matching the given glob mask
898 (requires the chanfilter module).
899 i Makes the channel invite-only.
900 Users can only join if an operator
901 uses /INVITE to invite them.
902 j <joins>:<sec> Limits joins to the specified rate (requires
903 the joinflood module).
904 k <key> Set the channel key (password) to <key>.
905 l <limit> Set the maximum allowed users to <limit>.
906 m Enable moderation. Only users with +v, +h, or +o
908 n Blocks users who are not members of the channel
910 p Make channel private, hiding it in users' whoises
911 and replacing it with * in /LIST.
912 r Marks the channel as registered with Services
913 (requires the services account module).
914 s Make channel secret, hiding it in users' whoises
916 t Prevents users without +h or +o from changing the
918 u Makes the channel an auditorium; normal users only
919 see themselves or themselves and the operators,
920 while operators see all the users (requires the
922 w <flag>:<banmask> Adds basic channel access controls of <flag> to
923 <banmask>, via the +w listmode.
924 For example, +w o:R:Brain will op anyone identified
925 to the account 'Brain' on join.
926 (requires the autoop module)
927 z Blocks non-SSL clients from joining the channel.
929 A Allows anyone to invite users to the channel
930 (normally only chanops can invite, requires
931 the allowinvite module).
932 B Blocks messages with too many capital letters,
933 as determined by the network configuration
934 (requires the blockcaps module).
935 C Blocks any CTCPs to the channel (requires the
937 D Delays join messages from users until they message
938 the channel (requires the delayjoin module).
939 E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similar messages.
940 Kicks as default, blocks with ~ and bans with *
941 The last two parameters are optional.
942 F <changes>:<sec> Blocks nick changes when they equal or exceed the
943 specified rate (requires the nickflood module).
944 G Censors messages to the channel based on the
945 network configuration (requires the censor module).
946 H <num>:<duration> Displays the last <num> lines of chat to joining
947 users. <duration> is the maximum time to keep
948 lines in the history buffer (requires the
950 J <seconds> Prevents rejoin after kick for the specified
951 number of seconds. This prevents auto-rejoin
952 (requires the kicknorejoin module).
953 K Blocks /KNOCK on the channel.
954 L <channel> If the channel reaches its limit set by +l,
955 redirect users to <channel> (requires the
957 M Blocks unregistered users from speaking (requires
958 the services account module).
959 N Prevents users on the channel from changing nick
960 (requires the nonicks module).
961 O Channel is IRCops only (can only be set by IRCops,
962 requires the operchans module).
963 P Makes the channel permanent; Bans, invites, the
964 topic, modes, and such will not be lost when it
965 empties (can only be set by IRCops, requires
966 the permchannels module).
967 Q Only ulined servers and their users can kick
968 (requires the nokicks module)
969 R Blocks unregistered users from joining (requires
970 the services account module).
971 S Strips formatting codes from messages to the
972 channel (requires the stripcolor module).
973 T Blocks /NOTICEs to the channel from users who are
974 not at least halfop (requires the nonotice module).
975 X <type>:<status> Makes users of <status> or higher exempt to the
976 specified restriction <type>. For example: flood:h
977 (requires the exemptchanops module).
978 Possible restriction types to exempt with +X are:
980 auditorium-see Permission required to see the full user list of
981 a +u channel (requires the auditorium module).
982 auditorium-vis Permission required to be visible in a +u channel
983 (requires the auditorium module).
984 blockcaps Channel mode +B
985 blockcolor Channel mode +c
986 censor Channel mode +G
987 filter Channel mode +g
988 flood Channel mode +f
989 nickflood Channel mode +F
990 noctcp Channel mode +C
991 nonick Channel mode +N
992 nonotice Channel mode +T
993 regmoderated Channel mode +M
994 stripcolor Channel mode +S
995 topiclock Channel mode +t
998 NOTE: A large number of these modes are dependent upon server-side modules
999 being loaded by a server/network administrator. The actual modes available
1000 on your network may be very different to this list. Please consult your
1001 help channel if you have any questions.">
1003 ######################
1005 ######################
1007 <helpop key="stats" value="/STATS <symbol>
1009 Shows various server statistics. Depending on configuration, some
1010 symbols may be only available to opers.
1014 e Show E-lines (local ban exemptions)
1015 g Show G-lines (host bans)
1016 k Show K-lines (local host bans)
1017 q Show Q-lines (nick mask bans)
1018 R Show R-lines (regular expression bans)
1019 Z Show Z-lines (IP mask bans)
1026 d Show configured DNSBLs and related statistics
1027 m Show command statistics, number of times commands have been used
1028 o Show a list of all valid oper usernames and hostmasks
1029 p Show open client ports, and the port type (ssl, plaintext, etc)
1030 u Show server uptime
1031 z Show memory usage statistics
1032 i Show connect class permissions
1033 l Show all client connections with information (sendq, commands, bytes, time connected)
1034 L Show all client connections with information and IP address
1035 P Show online opers and their idle times
1036 T Show bandwidth/socket statistics
1037 U Show U-lined servers
1038 Y Show connection classes
1039 O Show opertypes and the allowed user and channel modes it can set
1040 E Show socket engine events
1041 S Show currently held registered nicknames
1042 G Show how many local users are connected from each country according to GeoIP
1044 Note that all /STATS use is broadcast to online IRC operators.">
1046 ######################
1048 ######################
1050 <helpop key="snomasks" value="Server Notice Masks
1052 a Allows receipt of local announcement messages.
1053 A Allows receipt of remote announcement messages.
1054 c Allows receipt of local connect messages.
1055 C Allows receipt of remote connect messages.
1056 d Allows receipt of local DNSBL messages (requires the dnsbl module).
1057 D Allows receipt of remote DNSBL messages (requires the dnsbl module).
1058 f Allows receipt of local filter messages (requires the filter module).
1059 F Allows receipt of remote filter messages (requires the filter module).
1060 g Allows receipt of globops (requires the globops module).
1061 j Allows receipt of channel creation notices (requires the chancreate module).
1062 J Allows receipt of remote channel creation notices (requires the chancreate module).
1063 k Allows receipt of local kill messages.
1064 K Allows receipt of remote kill messages.
1065 l Allows receipt of local linking related messages.
1066 L Allows receipt of remote linking related messages.
1067 n See local nickname changes (requires the seenicks module).
1068 N See remote nickname changes (requires the seenicks modules).
1069 o Allows receipt of oper-up, oper-down, and oper-failure messages.
1070 O Allows receipt of remote oper-up, oper-down, and oper-failure messages.
1071 q Allows receipt of local quit messages.
1072 Q Allows receipt of remote quit messages.
1073 r Allows receipt of local oper commands (requires the operlog module).
1074 R Allows receipt of remote oper commands (requires the operlog module).
1075 t Allows receipt of attempts to use /STATS (local and remote).
1076 v Allows receipt of oper-override notices (requires the override module).
1077 x Allows receipt of local X-line notices (G/Z/Q/K/E/R/SHUN/CBan).
1078 X Allows receipt of remote X-line notices (G/Z/Q/K/E/R/SHUN/CBan).">
1080 ######################
1082 ######################
1084 <helpop key="extbans" value="Extended Bans
1087 Extbans are split into two types; matching extbans, which match on
1088 users in additional ways, and acting extbans, which restrict users
1089 in different ways to a standard ban.
1091 To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
1092 instead of a normal nick!user@host mask, to ban or exempt matching
1093 users. Ban exceptions on acting extbans exempt that user from matching
1094 an extban of that type, and from any channel mode corresponding to the
1095 restriction. Matching extbans may also be used for invite exceptions by
1096 setting +I <extban>.
1100 a:<mask> Matches user with both a matching banmask and realname,
1101 where <mask> is in the format nick!user@host+realname
1102 (requires gecosban module).
1103 j:<channel> Matches anyone in the given channel. Does not support
1104 wildcards (requires the channelban module).
1105 n:<class> Matches users in a matching connect class (requires the
1107 r:<realname> Matches users with a matching real name (requires the
1109 s:<server> Matches users on a matching server (requires the
1111 z:<certfp> Matches users having the given SSL certificate
1112 fingerprint (requires the sslmodes module).
1113 O:<opertype> Matches IRCops of a matching type, mostly useful as an
1114 an invite exception (requires the operchans module).
1115 R:<account> Matches users logged into a matching account (requires
1116 the services account module).
1117 U:<banmask> Matches unregistered users matching the given banmask.
1118 (requires the services account module).
1122 c:<banmask> Blocks any messages that contain formatting codes from
1123 matching users (requires the blockcolor module).
1124 m:<banmask> Blocks messages from matching users (requires the muteban
1125 module). Users with +v or above are not affected.
1126 p:<banmask> Blocks part messages from matching users (requires
1127 the nopartmsg module).
1128 A:<banmask> Blocks invites by matching users even when +A is set
1129 (requires the allowinvite module).
1130 B:<banmask> Blocks all capital or nearly all capital messages from
1131 matching users (requires the blockcaps module).
1132 C:<banmask> Blocks CTCPs from matching users (requires the noctcp
1134 N:<banmask> Blocks nick changes from matching users (requires
1135 the nonicks module).
1136 Q:<banmask> Blocks kicks by matching users (requires the nokicks
1138 S:<banmask> Strips formatting codes from messages from matching
1139 users (requires the stripcolor module).
1140 T:<banmask> Blocks notices from matching users (requires the
1143 A ban given to an Acting extban may either be a nick!user@host mask
1144 (unless stated otherwise), matched against users as for a normal ban,
1145 or a Matching extban.
1147 There is an additional special type of extended ban, a redirect ban:
1149 Redirect n!u@h#channel will redirect the banned user to #channel
1150 when they try to join (requires the banredirect module).">