1 # Sample configuration file for the helpop module.
2 # You can either copy this into your conf folder and set up the module to use it,
3 # or you can customize the responses for your network and/or add more.
5 # The way the new helpop system works is simple. You use one or more helpop tags.
6 # <helpop key="moo" value="something here">.
7 # key is what the user is looking for (i.e. /helpop moo), and value is what they get back
8 # (note that it can span multiple lines!).
14 <alias text="HELP" replace="HELPOP $2-">
16 <helpmsg nohelp="There is no help for the topic you searched for. Please try again.">
18 <helpop key="start" value="InspIRCd Help System
20 This system provides help for commands and modes.
21 Specify your question or a command name as the
22 parameter for this command.
24 /HELPOP CUSER - To see a list of user commands
25 /HELPOP COPER - To see a list of oper commands
26 /HELPOP UMODES - To see a list of user modes
27 /HELPOP CHMODES - To see a list of channel modes
28 /HELPOP SNOMASKS - To see a list of oper snotice masks
29 /HELPOP EXTBANS - To see a list of extended bans">
31 <helpop key="cuser" value="User Commands
34 ACCEPT ADMIN AWAY COMMANDS CYCLE DCCALLOW
35 FPART INFO INVITE ISON JOIN KICK
36 KNOCK LINKS LIST LUSERS MAP MKPASSWD
37 MODE MODULES MOTD NAMES NICK NOTICE
38 OPER PART PASS PING PONG PRIVMSG
39 QUIT REMOVE SETNAME SILENCE SQUERY SSLINFO
40 STATS TBAN TIME TITLE TOPIC UNINVITE
41 USER USERHOST VERSION VHOST WATCH WHO
44 <helpop key="squery" value="/SQUERY <target> <text>
46 Sends a message to the network service specified in <target>.">
48 <helpop key="sslinfo" value="/SSLINFO <nick>
50 Displays information on the SSL connection and certificate of the
53 <helpop key="uninvite" value="/UNINVITE <nick> <channel>
55 Uninvite a user from a channel, same syntax as INVITE.">
57 <helpop key="tban" value="/TBAN <channel> <duration> <banmask>
59 Sets a timed ban. The duration of the ban can be specified in the
60 following format: 1w2d3h4m6s which indicates a ban of one week, two
61 days, three hours, four minutes and six seconds. Alternatively the
62 ban may just be specified as a number of seconds. All timed bans
63 appear in the banlist as normal bans and may be safely removed
64 before their time is up.">
66 <helpop key="dccallow" value="/DCCALLOW - List allowed nicks
67 /DCCALLOW LIST - This also lists allowed nicks
68 /DCCALLOW +<nick> [<duration>] - Add a nick
69 /DCCALLOW -<nick> - Remove a nick
70 /DCCALLOW HELP - Display help
72 Duration is optional, and may be specified in seconds or in the
75 <helpop key="accept" value="/ACCEPT * - List accepted nicks
76 /ACCEPT +<nick> - Add a nick
77 /ACCEPT -<nick> - Remove a nick
78 This command accepts multiple nicks like so:
79 /ACCEPT +<nick1>,+<nick2>,-<nick3>
81 Manages your accept list. This list is used to determine who can
82 private message you when you have usermode +g set.">
84 <helpop key="cycle" value="/CYCLE <channel> :[<reason>]
86 Cycles a channel (leaving and rejoining), overrides restrictions that
87 would stop a new user joining, such as user limits and channel keys.">
89 <helpop key="title" value="/TITLE <name> <password>
91 Authenticate for a WHOIS title line and optionally a vhost using the
92 specified username and password.">
94 <helpop key="watch" value="/WATCH - List watched nicks that are online
95 /WATCH L - List watched nicks, online and offline
96 /WATCH C - Clear all watched nicks
97 /WATCH S - Show statistics
98 /WATCH +<nick> - Add a nick
99 /WATCH -<nick> - Remove a nick
100 This command accepts multiple nicks like so:
101 /WATCH +<nick1> +<nick2> -<nick3>">
103 <helpop key="vhost" value="/VHOST <username> <password>
105 Authenticate for a vhost using the specified username and password.">
107 <helpop key="remove" value="/REMOVE <channel> <nick> [<reason>]
109 Removes a user from a channel you specify. You must be at least a
110 channel halfoperator to remove a user. A removed user will part with
111 a message stating they were removed from the channel and by whom.">
113 <helpop key="rmode" value="/RMODE [channel] [modeletter] {[pattern]}
115 Removes listmodes from a channel.
116 E.g. /RMODE #Chan b m:* will remove all mute extbans.">
118 <helpop key="fpart" value="/FPART <channel> <nick> [<reason>]
120 This behaves identically to /REMOVE. /REMOVE is a built-in mIRC command
121 which caused trouble for some users.">
123 <helpop key="silence" value="/SILENCE - Shows a list of silenced masks
124 /SILENCE +<mask> [<flags>] - Add a mask
125 /SILENCE -<mask> - Remove a mask
127 A serverside ignore of the given n!u@h mask. The letter(s) at the end
128 specify what is to be ignored from this hostmask.
133 p Block private messages
134 c Block channel messages
136 n Block private notices
137 t Block channel notices
138 a Block all of the above
141 Multiple letters may be specified. For an exception, you must pair x
142 with what you want excepted. For example, if you wanted to except
143 everything from people with a host matching *.foo.net, you would do
144 /SILENCE +*!*@*.foo.net xa
146 /SILENCE without a parameter will list the masks that you have silenced.">
148 <helpop key="knock" value="/KNOCK <channel>
150 Sends a notice to a channel indicating you wish to join.">
152 <helpop key="user" value="/USER <ident> <local host> <remote host> :<real name>
154 This command is used by your client to register your
155 IRC session, providing your ident and real name to the
158 You should not use it during an established connection.">
160 <helpop key="nick" value="/NICK <new nick>
162 Change your nickname to <new nick>.">
164 <helpop key="quit" value="/QUIT [<reason>]
166 Quit from IRC and end your current session.">
168 <helpop key="version" value="/VERSION
170 Returns the server's version information.">
172 <helpop key="ping" value="/PING <server>
174 Ping a server. The server will answer with a PONG.">
176 <helpop key="pong" value="/PONG <server>
178 Your client should send this to answer server PINGs. You
179 should not issue this command manually.">
181 <helpop key="admin" value="/ADMIN [<server>]
183 Shows the administrative information for the given server.">
185 <helpop key="privmsg" value="/PRIVMSG <target> <text>
187 Sends a message to a user or channel specified in <target>.">
189 <helpop key="notice" value="/NOTICE <target> <text>
191 Sends a notice to a user or channel specified in <target>.">
193 <helpop key="join" value="/JOIN <channel>[,<channel>] [<key>][,<key>]
195 Joins one or more channels you provide the names for.">
197 <helpop key="names" value="/NAMES <channel>[,<channel>]
199 Return a list of users on the channels you provide.">
201 <helpop key="part" value="/PART <channel>[,<channel>] [<reason>]
203 Leaves one or more channels you specify.">
205 <helpop key="kick" value="/KICK <channel> <nick>[,<nick>] [<reason>]
207 Kicks a user from a channel you specify. You must be
208 at least a channel halfoperator to kick a user.">
210 <helpop key="mode" value="/MODE <target> (+|-)<modes> [<mode parameters>] - Change modes of <target>.
212 /MODE <target> - Show modes of <target>.
214 /MODE <channel> <list mode char> - List bans, exceptions, etc. set on <channel>.
216 Sets the mode for a channel or a nickname specified in <target>.
217 A user may only set modes upon themselves, and may not set the
218 +o usermode, and a user may only change channel modes of
219 channels where they are at least a halfoperator.
221 For a list of all user and channel modes, enter /HELPOP UMODES or
224 <helpop key="topic" value="/TOPIC <channel> [<topic>]
226 Sets or retrieves the channel topic. If a channel topic is
227 given in the command and either the channel is not +t, or
228 you are at least a halfoperator, the channel topic will be
229 changed to the new one you provide.">
231 <helpop key="who" value="/WHO <pattern> [<flags>][%[<fields>[,<querytype>]]] <pattern>
233 Looks up information about users matching the provided pattern. You can specify
234 a flag specific pattern, a channel name, user hostname, a user server name, a
235 user real name, or a user nickname. Matching users will only be included in the
238 1) The specified pattern is an exact channel name that does not have the
239 private or secret channel modes set and the user does not have the invisible
241 2) The specified pattern is an exact nickname.
242 3) You share one or more common channels with the user.
243 4) The user does not have the invisible user mode set.
244 5) You are a server operator with the users/auspex privilege.
246 If you specify any fields the response returned will be a WHOX response rather
247 than a RFC 1459 WHO response.
252 The following flags use <pattern> to match against the specified user data:
254 A Show users who have an away message matching <pattern>.
255 a Show users who have an account name matching <pattern>.
256 h Show users who have a hostname matching <pattern>. If the 'x' modifier
257 is specified then this will match against the real hostname instead of
258 the display hostname.
259 i Show users who have an IP address matching <pattern>.
260 m Show users who have the modes listed in <pattern>. The pattern
261 should be in the same format as a mode change e.g. +ow-i (server
263 n Show users who have a nickname matching <pattern>.
264 p Show users who are connected to a port in the <pattern> range (server
266 r Show users who have a real name matching <pattern>.
267 s Show users who are on a server with a name matching <pattern>. If the 'x'
268 modifier is specified then this will match against the real server name
269 instead of the masked server name.
270 t Show users who have connected in the last <pattern> seconds.
271 u Show users who have an ident (username) matching <pattern>.
273 The following flags filter users by their status:
275 f Only show users on remote (far) servers.
276 l Only show users on the local server.
277 o Only show server operators.
279 The following flags modify the command output:
281 x Show sensitive data like real user hostnames and, when hideserver is
282 enabled, real server hostnames.
284 You may combine one flag from the first group and multiple from the others in
290 a Include the user's account name in the response.
291 c Include the first common channel name in the response.
292 d Include the user's server distance from you in the response.
293 f Include the user's away status, oper status, and highest channel prefix
295 h Include the user's hostname in the response. If the 'x' flag was
296 specified then this is the real host rather than the display host.
297 i Include the user's IP address in the response.
298 l Include the user's idle time in the response.
299 n Include the user's nickname in the response.
300 o Include the user's channel operator rank level in the response.
301 r Include the user's real name in the response.
302 s Include the user's server name in the response. If the 'x' flag was
303 specified then this is the real server name rather than the masked server
305 t Include the query type in the response.
306 u Include the user's ident in the response.
310 <helpop key="motd" value="/MOTD [<server>]
312 Show the message of the day for <server>. Messages of the day often
313 contain important server rules and notices and should be read prior
316 <helpop key="oper" value="/OPER <login> <password>
318 Attempts to authenticate a user as an IRC operator.
320 Both successful and unsuccessful oper attempts are
321 logged, and sent to online IRC operators.">
323 <helpop key="list" value="/LIST [<pattern>]
325 Creates a list of all existing channels matching the glob pattern
326 <pattern>, e.g. *chat* or bot*.">
328 <helpop key="lusers" value="/LUSERS
330 Shows a count of local and remote users, servers and channels.">
332 <helpop key="userhost" value="/USERHOST <nick> [<nick>]
334 Returns the hostname and nickname of a user, and some other
335 miscellaneous information.">
337 <helpop key="away" value="/AWAY [<message>]
339 If a message is given, marks you as being away, otherwise
340 removes your away status and previous message.">
342 <helpop key="ison" value="/ISON <nick> [<nick> ...]
344 Returns a subset of the nicks you give, showing only those
345 that are currently online.">
347 <helpop key="invite" value="/INVITE <nick> <channel> [<time>]
349 Invites a user to a channel. If the channel is NOT +A, only
350 channel halfoperators or above can invite people. If +A is set,
351 anyone can invite people to the channel, as long as the person
352 doing the invite is a member of the channel they wish to invite
355 Invited users may override bans, +k, and similar in addition to
356 +i, depending on configuration.
358 If a time is provided, the invite expires after that time and the user
359 can no longer use it to enter the channel.">
361 <helpop key="pass" value="/PASS <password>
363 This command is used by your client when setting up
364 your IRC session to submit a server password to the
367 You should not use it during an established connection.">
369 <helpop key="whowas" value="/WHOWAS <nick>
371 Returns a list of times the user was seen recently on IRC along with
372 the time they were last seen and their server.">
374 <helpop key="links" value="/LINKS
376 Shows all servers linked to this one.">
378 <helpop key="map" value="/MAP
380 Shows a graphical representation of all users and servers on the
381 network, and the links between them, as a tree from the perspective
384 <helpop key="whois" value="/WHOIS <nick> [<server>]
386 Returns the WHOIS information of a user, their channels, hostname,
387 etc. If a second nickname or server is provided, then a whois is
388 performed from the server where the user is actually located rather
389 than locally, showing idle and signon times.">
391 <helpop key="time" value="/TIME [<server>]
393 Returns the local time of the server, or remote time of another
396 <helpop key="info" value="/INFO [<server>]
398 Returns information on the developers and supporters who made this
399 IRC server possible.">
401 <helpop key="setname" value="/SETNAME <name>
403 Sets your name to the specified name.">
406 <helpop key="coper" value="Oper Commands
409 ALLTIME CBAN CHECK CHGHOST CHGIDENT
410 CHGNAME CLEARCHAN CLOAK CLONES CLOSE
411 CONNECT DIE ELINE FILTER GLINE
412 GLOADMODULE GLOBOPS GRELOADMODULE GUNLOADMODULE JUMPSERVER
413 KILL KLINE LOADMODULE LOCKSERV MODENOTICE
414 NICKLOCK NICKUNLOCK OJOIN OPERMOTD QLINE
415 RCONNECT REHASH RELOADMODULE RESTART RLINE
416 RSQUIT SAJOIN SAKICK SAMODE SANICK
417 SAPART SAQUIT SATOPIC SETHOST SETIDENT
418 SETIDLE SHUN SQUIT SWHOIS TLINE
419 UNLOADMODULE UNLOCKSERV USERIP WALLOPS ZLINE">
421 <helpop key="userip" value="/USERIP <nick> [<nick>]
423 Returns the ip and nickname of the given users.">
425 <helpop key="tline" value="/TLINE <mask>
427 This command returns the number of local and global clients matched,
428 and the percentage of clients matched, plus how they were matched
429 (by IP address or by hostname). Mask should be given as either a
430 nick!user@host or user@IP (wildcards acceptable).">
432 <helpop key="lockserv" value="/LOCKSERV :[<message>]
434 Locks out all new connections notifying connecting users that the
435 service is temporarily closed and to try again later.">
437 <helpop key="unlockserv" value="/UNLOCKSERV
439 Opens the server up again for new connections.">
441 <helpop key="jumpserver" value="/JUMPSERVER [<newserver> <newport> <(+|-)[flags]> :[<reason>]]
443 Sets or cancels jumpserver mode. If no parameters are given,
444 jumpserver mode is cancelled, if it is currently set. If parameters
445 are given, a server address must be given for <newserver> and a
446 server port must be given for <newport>. Zero or more status flags
447 should be given for 'flags', from the list below (if you do not
448 wish to specify any flags just place a '+' in this field):
450 1. +a: Redirect all users immediately (except for opers) and cause
451 them to quit with the given reason
453 2. +n: Redirect any new users who connect and cause them to quit
456 You may use + and - to set or unset these flags in the command, the
457 default flags are -a+n, which will just redirect new users. The
458 reason parameter is optional, and if not provided defaults to
459 'Please use this server/port instead' (the default given in various
462 <helpop key="filter" value="/FILTER <filter-definition> [<action> <flags> [<duration>] :<reason>]
464 This command will add a filter when more than one parameter is given,
465 for messages of the types specified by the flags, with the given
466 filter definition, action, duration (when the action is 'gline',
467 'zline' or 'shun'), and reason.
469 The filter will take effect when a message of any type specified by
470 the flags and matching the definition is sent to the server, and
471 perform the specified action.
477 Warn Lets the message through and informs +s IRCops of the message
478 and all relevant info
479 Block Blocks message and informs +s IRCops of the blocked message
480 and all relevant info
481 Silent Blocks message, but does not notify IRCops
483 Gline G-lines the user for the specified duration
484 Zline Z-lines the user for the specified duration
485 Shun Shuns the user for the specified duration (requires the shun module)
490 p Block private and channel messages
491 n Block private and channel notices
492 P Block part messages
493 q Block quit messages
494 o Don't match against opers
495 c Strip all formatting codes from the message before matching
496 * Represents all of the above flags
497 - Does nothing, a non-op for when you do not want to specify any
500 The reason for the filter will be used as the reason for the action,
501 unless the action is 'none', and is sent to the user when their text is
502 blocked by 'block' and 'silent' actions.
504 A G-line, Z-line or shun duration may be specified in seconds, or in the
505 format 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5
506 minutes and 6 seconds. All fields in this format are optional.
508 When only one parameter is provided (the filter pattern) the provided
509 filter will be removed. Note that if you remove a
510 configuration-defined filter, it will reappear at next rehash unless
511 it is also removed from the config file.">
513 <helpop key="ojoin" value="/OJOIN <channel>
515 Force joins you to the specified channel, and gives you +Y and any other
516 configuration-defined modes on it, preventing you from being kicked.
517 Depending on configuration, may announce that you have joined the
518 channel on official network business.">
520 <helpop key="clones" value="/CLONES <limit>
522 Retrieves a list of users with more clones than the specified
525 <helpop key="check" value="/CHECK <nick|ip|hostmask|channel> [<server>]
527 Allows opers to look up advanced information on channels, hostmasks
528 or IP addresses, in a similar way to WHO but in more detail, displaying
529 most information the IRCD has stored on the target, including all
532 With the second parameter given, runs the command remotely on the
535 <helpop key="alltime" value="/ALLTIME
537 Shows the time on all servers on the network.">
539 <helpop key="rconnect" value="/RCONNECT <source mask> <target mask>
541 The server matching <source mask> will try to connect to the first
542 server in the config file matching <target mask>.">
544 <helpop key="rsquit" value="/RSQUIT <target mask> [<reason>]
546 Causes a remote server matching <target mask> to be disconnected from
549 <helpop key="globops" value="/GLOBOPS <message>
551 Sends a message to all users with the +g snomask.">
553 <helpop key="cban" value="/CBAN <channel> [<duration> :[<reason>]]
555 Sets or removes a channel ban. You must specify all three parameters
556 to add a ban, and one parameter to remove a ban (just the channel).
558 The duration may be specified in seconds, or in the format
559 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
560 5 minutes and 6 seconds. All fields in this format are optional.">
562 <helpop key="sajoin" value="/SAJOIN [<nick>] <channel>[,<channel>]
564 Forces the user to join the channel(s).
565 If no nick is given, it joins the oper doing the /SAJOIN.">
567 <helpop key="sapart" value="/SAPART <nick> <channel>[,<channel>]
569 Forces the user to part the channel(s).">
571 <helpop key="samode" value="/SAMODE <target> (+|-)<modes> [<parameters for modes>]
573 Applies the given mode change to the channel or nick specified.">
575 <helpop key="sanick" value="/SANICK <nick> <new nick>
577 Changes the user's nick to the new nick.">
579 <helpop key="sakick" value="/SAKICK <channel> <nick> <reason>
581 Kicks the given user from the specified channel.">
583 <helpop key="satopic" value="/SATOPIC <channel> <new topic>
585 Applies the given topic to the specified channel.">
587 <helpop key="saquit" value="/SAQUIT <nick> <reason>
589 Forces user to quit with the specified reason.">
591 <helpop key="setidle" value="/SETIDLE <idle time>
593 Sets your idle time (in seconds) to the specified value.">
595 <helpop key="sethost" value="/SETHOST <host>
597 Sets your host to the specified host.">
599 <helpop key="setident" value="/SETIDENT <ident>
601 Sets your ident to the specified ident.">
603 <helpop key="swhois" line="/SWHOIS <nick> <swhois>
605 Sets the user's swhois field to the given swhois.">
607 <helpop key="mkpasswd" value="/MKPASSWD <hashtype> <plaintext>
609 Encodes the plaintext to a hash of the given type and displays
612 <helpop key="opermotd" value="/OPERMOTD
614 Displays the Oper MOTD.">
616 <helpop key="nicklock" value="/NICKLOCK <nick> <new nick>
618 Changes the user's nick to the new nick, and forces
619 it to remain as such for the remainder of the session.">
621 <helpop key="nickunlock" value="/NICKUNLOCK <nick>
623 Allows a previously locked user to change nicks again.">
625 <helpop key="chghost" value="/CHGHOST <nickname> <new hostname>
627 Changes the hostname of the user to the new hostname.">
629 <helpop key="chgname" value="/CHGNAME <nickname> <new name>
631 Changes the name of the user to the new name.">
633 <helpop key="chgident" value="/CHGIDENT <nickname> <new ident>
635 Changes the ident of the user to the new ident.">
637 <helpop key="shun" value="/SHUN <nick!user@host> [[<duration>] :<reason>]
639 Sets or removes a shun (server side ignore) on a host and ident mask.
640 You must specify all three parameters to add a shun, and one parameter
641 to remove a shun (just the nick!user@host section).
643 The duration may be specified in seconds, or in the format
644 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
645 5 minutes and 6 seconds. All fields in this format are optional.">
647 <helpop key="die" value="/DIE <server>
649 This command shuts down the local server. A single parameter is
650 required, which must match the name of the local server.">
652 <helpop key="restart" value="/RESTART <server>
654 This command restarts the local server. A single parameter is
655 required, which must match the name of the local server.">
657 <helpop key="commands" value="/COMMANDS
659 Shows all currently available commands.">
661 <helpop key="kill" value="/KILL <user> <reason>
663 This command will disconnect a user from IRC with the given reason.">
665 <helpop key="rehash" value="/REHASH <mask>
667 This command will cause the server configuration file to be reread and
668 values reinitialized for all servers matching the server mask, or the
669 local server if one is not specified.">
671 <helpop key="connect" value="/CONNECT <servermask>
673 Add a connection to the server matching the given server mask. You must
674 have configured the server for linking in your configuration file
675 before trying to link them.">
677 <helpop key="squit" value="/SQUIT <servermask>
679 Disconnects the server matching the given server mask from this server.">
681 <helpop key="modules" value="/MODULES
683 Lists currently loaded modules, their memory offsets, version numbers,
684 and flags. If you are not an operator, you will see reduced detail.">
686 <helpop key="loadmodule" value="/LOADMODULE <modname>
688 Loads the specified module into the local server.">
690 <helpop key="unloadmodule" value="/UNLOADMODULE <modname>
692 Unloads a module from the local server.">
694 <helpop key="reloadmodule" value="/RELOADMODULE <modname>
696 Unloads and reloads a module on the local server.">
698 <helpop key="gloadmodule" value="/GLOADMODULE <modname>
700 Loads the specified module on all linked servers.">
702 <helpop key="gunloadmodule" value="/GUNLOADMODULE <modname>
704 Unloads a module from all linked servers.">
706 <helpop key="greloadmodule" value="/GRELOADMODULE <modname>
708 Unloads and reloads a module on all linked servers.">
710 <helpop key="kline" value="/KLINE <user@host> [<duration> :<reason>]
712 Sets or removes a K-line (local host based ban) on a host and ident mask.
713 You must specify all three parameters to add a ban, and one parameter
714 to remove a ban (just the user@host section).
716 The duration may be specified in seconds, or in the format
717 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
718 5 minutes and 6 seconds. All fields in this format are optional.">
720 <helpop key="zline" value="/ZLINE <ipmask> [<duration> :<reason>]
722 Sets or removes a Z-line (ip based ban) on an ip range mask.
723 You must specify all three parameters to add a ban, and one parameter
724 to remove a ban (just the ipmask).
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="qline" value="/QLINE <nickmask> [<duration> :<reason>]
732 Sets or removes a Q-line (nick based ban) on a nick mask.
733 You must specify all three parameters to add a ban, and one parameter
734 to remove a ban (just the nickmask).
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="gline" value="/GLINE <user@host> [<duration> :<reason>]
742 Sets or removes a G-line (host based ban) on host mask.
743 You must specify all three parameters to add a ban, and one
744 parameter to remove a ban (just the user@host section).
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="eline" value="/ELINE <user@host> [<duration> :<reason>]
752 Sets or removes a E-line (global ban exception) on host mask.
753 You must specify at least 3 parameters to add an exception, and one
754 parameter to remove an exception (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 This command has a few important limitations. Bans on *@<ip> can only
761 be negated by an E-line on *@<ip>, bans on *@<host> can be negated by
762 E-lines on *@<ip>, or *@<host>, and bans on <ident>@* or <ident>@<host>
763 can be negated by any E-line that matches.">
765 <helpop key="wallops" value="/WALLOPS <message>
767 Sends a message to all +w users.">
769 <helpop key="rline" value="/RLINE <regex> [<duration> :<reason>]
771 Sets or removes an R-line (regex line) on a n!u@h\srealname mask. You
772 must specify all three parameters to add an R-line, and one parameter
773 to remove an R-line (just the regex).
775 The duration may be specified in seconds, or in the format
776 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
777 5 minutes and 6 seconds. All fields in this format are optional.">
779 <helpop key="close" value="/CLOSE
781 Closes all unregistered connections to the local server.">
783 <helpop key="clearchan" value="/CLEARCHAN <channel> [<KILL|KICK|G|Z>] [<reason>]
785 Quits or kicks all non-opers from a channel, optionally G/Z-lines them.
786 Useful for quickly nuking bot channels.
788 The default method, KILL, simply disconnects the victims from the server,
789 while methods G and Z also add G/Z-lines for all the targets.
791 When used, the victims won't see each other getting kicked or quitting.">
793 <helpop key="modenotice" value="/MODENOTICE <modeletters> <message>
795 Sends a notice to all users who have the given mode(s) set.
796 If multiple mode letters are given, the notice is only sent to users
797 who have all of them set.">
799 <helpop key="cloak" value="/CLOAK <host>
801 Generate the cloak of a host or IP. This is useful for example when
802 trying to get the cloak of a user from /WHOWAS and they were not
803 using their cloak when they quit.">
805 <helpop key="umodes" value="User Modes
808 c Blocks private messages and notices from users who do
809 not share a common channel with you (requires the
811 d Deaf mode. User will not receive any messages or notices
812 from channels they are in (requires the deaf module).
813 g In combination with /ACCEPT, provides for server side
814 ignore (requires the callerid module).
815 h Marks as 'available for help' in WHOIS (IRCop only,
816 requires the helpop module).
817 i Makes invisible to /WHO if the user using /WHO is not in
819 k Prevents the user from being kicked from channels, or
820 having op modes removed from them (services only,
821 requires the servprotect module).
822 o Marks as a IRC operator.
823 s <mask> Receives server notices specified by <mask>
825 r Marks as a having a registered nickname
826 (requires the services account module).
827 w Receives wallops messages.
828 x Gives a cloaked hostname (requires the cloaking module).
829 z Only allow private messages from SSL users (requires the
831 B Marks as a bot (requires the botmode module).
832 G Censors messages sent to the user based on filters
833 configured for the network (requires the censor module).
834 H Hides an oper's oper status from WHOIS (requires the
836 I Hides a user's entire channel list in WHOIS from
837 non-IRCops (requires the hidechans module).
838 L Stops redirections done by m_redirect (mode must be
839 enabled in the config).
840 R Blocks private messages from unregistered users
841 (requires the services account module).
842 S Strips formatting codes out of private messages
843 to the user (requires the stripcolor module).
844 W Receives notification when a user uses WHOIS on them
845 (IRCop only, requires the showwhois module).">
847 <helpop key="chmodes" value="Channel Modes
850 v <nickname> Gives voice to <nickname>, allowing them to speak
851 while the channel is +m.
852 h <nickname> Gives halfop status to <nickname> (requires the
853 customprefix module).
854 o <nickname> Gives op status to <nickname>.
855 a <nickname> Gives protected status to <nickname>, preventing
856 them from being kicked (+q only, requires the
857 customprefix module).
858 q <nickname> Gives owner status to <nickname>, preventing them
859 from being kicked (Services or +q only, requires
860 the customprefix module).
862 b <hostmask> Bans <hostmask> from the channel.
863 e <hostmask> Excepts <hostmask> from bans (requires the
864 banexception module).
865 I <hostmask> Excepts <hostmask> from +i, allowing matching
866 users to join while the channel is invite-only
867 (requires the inviteexception module).
869 c Blocks messages that contain formatting codes
870 (requires the blockcolor module).
871 d <time> Blocks messages to a channel from new users
872 until they have been in the channel for <time>
873 seconds (requires the delaymsg module).
874 f [*]<lines>:<sec> Kicks on text flood equal to or above the
875 specified rate. With *, the user is banned
876 (requires the messageflood module).
877 g <mask> Blocks messages matching the given glob mask
878 (requires the chanfilter module).
879 i Makes the channel invite-only.
880 Users can only join if an operator
881 uses /INVITE to invite them.
882 j <joins>:<sec> Limits joins to the specified rate (requires
883 the joinflood module).
884 k <key> Set the channel key (password) to <key>.
885 l <limit> Set the maximum allowed users to <limit>.
886 m Enable moderation. Only users with +v, +h, or +o
888 n Blocks users who are not members of the channel
890 p Make channel private, hiding it in users' whoises
891 and replacing it with * in /LIST.
892 r Marks the channel as registered with Services
893 (requires the services account module).
894 s Make channel secret, hiding it in users' whoises
896 t Prevents users without +h or +o from changing the
898 u Makes the channel an auditorium; normal users only
899 see themselves or themselves and the operators,
900 while operators see all the users (requires the
902 w <flag>:<banmask> Adds basic channel access controls of <flag> to
903 <banmask>, via the +w listmode.
904 For example, +w o:R:Brain will op anyone identified
905 to the account 'Brain' on join.
906 (requires the autoop module)
907 z Blocks non-SSL clients from joining the channel.
909 A Allows anyone to invite users to the channel
910 (normally only chanops can invite, requires
911 the allowinvite module).
912 B Blocks messages with too many capital letters,
913 as determined by the network configuration
914 (requires the blockcaps module).
915 C Blocks any CTCPs to the channel (requires the
917 D Delays join messages from users until they message
918 the channel (requires the delayjoin module).
919 E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similar messages.
920 Kicks as default, blocks with ~ and bans with *
921 The last two parameters are optional.
922 F <changes>:<sec> Blocks nick changes when they equal or exceed the
923 specified rate (requires the nickflood module).
924 G Censors messages to the channel based on the
925 network configuration (requires the censor module).
926 H <num>:<duration> Displays the last <num> lines of chat to joining
927 users. <duration> is the maximum time to keep
928 lines in the history buffer (requires the
930 J <seconds> Prevents rejoin after kick for the specified
931 number of seconds. This prevents auto-rejoin
932 (requires the kicknorejoin module).
933 K Blocks /KNOCK on the channel.
934 L <channel> If the channel reaches its limit set by +l,
935 redirect users to <channel> (requires the
937 M Blocks unregistered users from speaking (requires
938 the services account module).
939 N Prevents users on the channel from changing nick
940 (requires the nonicks module).
941 O Channel is IRCops only (can only be set by IRCops,
942 requires the operchans module).
943 P Makes the channel permanent; Bans, invites, the
944 topic, modes, and such will not be lost when it
945 empties (can only be set by IRCops, requires
946 the permchannels module).
947 Q Only ulined servers and their users can kick
948 (requires the nokicks module)
949 R Blocks unregistered users from joining (requires
950 the services account module).
951 S Strips formatting codes from messages to the
952 channel (requires the stripcolor module).
953 T Blocks /NOTICEs to the channel from users who are
954 not at least halfop (requires the nonotice module).
955 X <type>:<status> Makes users of <status> or higher exempt to the
956 specified restriction <type>. For example: flood:h
957 (requires the exemptchanops module).
958 Possible restriction types to exempt with +X are:
960 auditorium-see Permission required to see the full user list of
961 a +u channel (requires the auditorium module).
962 auditorium-vis Permission required to be visible in a +u channel
963 (requires the auditorium module).
964 blockcaps Channel mode +B
965 blockcolor Channel mode +c
966 censor Channel mode +G
967 filter Channel mode +g
968 flood Channel mode +f
969 nickflood Channel mode +F
970 noctcp Channel mode +C
971 nonick Channel mode +N
972 nonotice Channel mode +T
973 regmoderated Channel mode +M
974 stripcolor Channel mode +S
975 topiclock Channel mode +t
978 NOTE: A large number of these modes are dependent upon server-side modules
979 being loaded by a server/network administrator. The actual modes available
980 on your network may be very different to this list. Please consult your
981 help channel if you have any questions.">
983 <helpop key="stats" value="/STATS <symbol>
985 Shows various server statistics. Depending on configuration, some
986 symbols may be only available to opers.
990 e Show E-lines (local ban exemptions)
991 g Show G-lines (host bans)
992 k Show K-lines (local host bans)
993 q Show Q-lines (nick mask bans)
994 R Show R-lines (regular expression bans)
995 Z Show Z-lines (IP mask bans)
1002 d Show configured DNSBLs and related statistics
1003 m Show command statistics, number of times commands have been used
1004 o Show a list of all valid oper usernames and hostmasks
1005 p Show open client ports, and the port type (ssl, plaintext, etc)
1006 u Show server uptime
1007 z Show memory usage statistics
1008 i Show connect class permissions
1009 l Show all client connections with information (sendq, commands, bytes, time connected)
1010 L Show all client connections with information and IP address
1011 P Show online opers and their idle times
1012 T Show bandwidth/socket statistics
1013 U Show U-lined servers
1014 Y Show connection classes
1015 O Show opertypes and the allowed user and channel modes it can set
1016 E Show socket engine events
1017 S Show currently held registered nicknames
1018 G Show how many local users are connected from each country according to GeoIP
1020 Note that all /STATS use is broadcast to online IRC operators.">
1022 <helpop key="snomasks" value="Server Notice Masks
1024 a Allows receipt of local announcement messages.
1025 A Allows receipt of remote announcement messages.
1026 c Allows receipt of local connect messages.
1027 C Allows receipt of remote connect messages.
1028 d Allows receipt of local DNSBL messages (requires the dnsbl module).
1029 D Allows receipt of remote DNSBL messages (requires the dnsbl module).
1030 f Allows receipt of local filter messages (requires the filter module).
1031 F Allows receipt of remote filter messages (requires the filter module).
1032 g Allows receipt of globops (requires the globops module).
1033 j Allows receipt of channel creation notices (requires the chancreate module).
1034 J Allows receipt of remote channel creation notices (requires the chancreate module).
1035 k Allows receipt of local kill messages.
1036 K Allows receipt of remote kill messages.
1037 l Allows receipt of local linking related messages.
1038 L Allows receipt of remote linking related messages.
1039 n See local nickname changes (requires the seenicks module).
1040 N See remote nickname changes (requires the seenicks modules).
1041 o Allows receipt of oper-up, oper-down, and oper-failure messages.
1042 O Allows receipt of remote oper-up, oper-down, and oper-failure messages.
1043 q Allows receipt of local quit messages.
1044 Q Allows receipt of remote quit messages.
1045 r Allows receipt of local oper commands (requires the operlog module).
1046 R Allows receipt of remote oper commands (requires the operlog module).
1047 t Allows receipt of attempts to use /STATS (local and remote).
1048 v Allows receipt of oper-override notices (requires the override module).
1049 x Allows receipt of local X-line notices (G/Z/Q/K/E/R/SHUN/CBan).
1050 X Allows receipt of remote X-line notices (G/Z/Q/K/E/R/SHUN/CBan).">
1052 <helpop key="extbans" value="Extended Bans
1055 Extbans are split into two types; matching extbans, which match on
1056 users in additional ways, and acting extbans, which restrict users
1057 in different ways to a standard ban.
1059 To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
1060 instead of a normal nick!user@host mask, to ban or exempt matching
1061 users. Ban exceptions on acting extbans exempt that user from matching
1062 an extban of that type, and from any channel mode corresponding to the
1063 restriction. Matching extbans may also be used for invite exceptions by
1064 setting +I <extban>.
1068 a:<mask> Matches user with both a matching banmask and realname,
1069 where <mask> is in the format nick!user@host+realname
1070 (requires gecosban module).
1071 j:<channel> Matches anyone in the given channel. Does not support
1072 wildcards (requires the channelban module).
1073 n:<class> Matches users in a matching connect class (requires
1074 the classban module).
1075 r:<realname> Matches users with a matching real name (requires the
1077 s:<server> Matches users on a matching server (requires the
1079 z:<certfp> Matches users having the given SSL certificate
1080 fingerprint (requires the sslmodes module).
1081 O:<opertype> Matches IRCops of a matching type, mostly useful as an
1082 an invite exception (requires the operchans module).
1083 R:<account> Matches users logged into a matching account (requires
1084 the services account module).
1085 U:<banmask> Matches unregistered users matching the given banmask.
1086 (requires the services account module).
1090 c:<banmask> Blocks any messages that contain formatting codes from
1091 matching users (requires the blockcolor module).
1092 m:<banmask> Blocks messages from matching users (requires the muteban
1093 module). Users with +v or above are not affected.
1094 p:<banmask> Blocks part messages from matching users (requires
1095 the nopartmsg module).
1096 A:<banmask> Blocks invites by matching users even when +A is set
1097 (requires the allowinvite module).
1098 B:<banmask> Blocks all capital or nearly all capital messages from
1099 matching users (requires the blockcaps module).
1100 C:<banmask> Blocks CTCPs from matching users (requires the noctcp
1102 N:<banmask> Blocks nick changes from matching users (requires
1103 the nonicks module).
1104 Q:<banmask> Blocks kicks by matching users (requires the nokicks
1106 S:<banmask> Strips formatting codes from messages from matching
1107 users (requires the stripcolor module).
1108 T:<banmask> Blocks notices from matching users (requires the
1111 A ban given to an Acting extban may either be a nick!user@host mask
1112 (unless stated otherwise), matched against users as for a normal ban,
1113 or a Matching extban.
1115 There is an additional special type of extended ban, a redirect ban:
1117 Redirect n!u@h#channel will redirect the banned user to #channel
1118 when they try to join (requires the banredirect module).">