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 PRIVMSG NOTICE NICK JOIN PART
35 CYCLE KNOCK MODE OPER TOPIC
36 KICK FPART REMOVE TBAN INVITE
37 UNINVITE AWAY DCCALLOW SILENCE ACCEPT
38 MKPASSWD VHOST TITLE SETNAME
40 WHOIS WHOWAS ISON USERHOST WATCH
42 ADMIN MAP LINKS LUSERS TIME
43 STATS VERSION INFO MODULES COMMANDS
46 USER PASS PING PONG QUIT">
48 <helpop key="squery" value="/SQUERY <target> <text>
50 Sends a message to the network service specified in <target>.">
52 <helpop key="sslinfo" value="/SSLINFO <nick>
54 Displays information on the SSL connection and certificate of the
57 <helpop key="uninvite" value="/UNINVITE <nick> <channel>
59 Uninvite a user from a channel, same syntax as INVITE.">
61 <helpop key="tban" value="/TBAN <channel> <duration> <banmask>
63 Sets a timed ban. The duration of the ban can be specified in the
64 following format: 1w2d3h4m6s which indicates a ban of one week, two
65 days, three hours, four minutes and six seconds. Alternatively the
66 ban may just be specified as a number of seconds. All timed bans
67 appear in the banlist as normal bans and may be safely removed
68 before their time is up.">
70 <helpop key="dccallow" value="/DCCALLOW - List allowed nicks
71 /DCCALLOW LIST - This also lists allowed nicks
72 /DCCALLOW +<nick> [<duration>] - Add a nick
73 /DCCALLOW -<nick> - Remove a nick
74 /DCCALLOW HELP - Display help
76 Duration is optional, and may be specified in seconds or in the
79 <helpop key="accept" value="/ACCEPT * - List accepted nicks
80 /ACCEPT +<nick> - Add a nick
81 /ACCEPT -<nick> - Remove a nick
82 This command accepts multiple nicks like so:
83 /ACCEPT +<nick1>,+<nick2>,-<nick3>
85 Manages your accept list. This list is used to determine who can
86 private message you when you have usermode +g set.">
88 <helpop key="cycle" value="/CYCLE <channel> :[<reason>]
90 Cycles a channel (leaving and rejoining), overrides restrictions that
91 would stop a new user joining, such as user limits and channel keys.">
93 <helpop key="title" value="/TITLE <name> <password>
95 Authenticate for a WHOIS title line and optionally a vhost using the
96 specified username and password.">
98 <helpop key="watch" value="/WATCH - List watched nicks that are online
99 /WATCH L - List watched nicks, online and offline
100 /WATCH C - Clear all watched nicks
101 /WATCH S - Show statistics
102 /WATCH +<nick> - Add a nick
103 /WATCH -<nick> - Remove a nick
104 This command accepts multiple nicks like so:
105 /WATCH +<nick1> +<nick2> -<nick3>">
107 <helpop key="vhost" value="/VHOST <username> <password>
109 Authenticate for a vhost using the specified username and password.">
111 <helpop key="remove" value="/REMOVE <channel> <nick> [<reason>]
113 Removes a user from a channel you specify. You must be at least a
114 channel halfoperator to remove a user. A removed user will part with
115 a message stating they were removed from the channel and by whom.">
117 <helpop key="rmode" value="/RMODE [channel] [modeletter] {[pattern]}
119 Removes listmodes from a channel.
120 E.g. /RMODE #Chan b m:* will remove all mute extbans.">
122 <helpop key="fpart" value="/FPART <channel> <nick> [<reason>]
124 This behaves identically to /REMOVE. /REMOVE is a built-in mIRC command
125 which caused trouble for some users.">
127 <helpop key="silence" value="/SILENCE - Shows a list of silenced masks
128 /SILENCE +<mask> [<flags>] - Add a mask
129 /SILENCE -<mask> - Remove a mask
131 A serverside ignore of the given n!u@h mask. The letter(s) at the end
132 specify what is to be ignored from this hostmask.
137 p Block private messages
138 c Block channel messages
140 n Block private notices
141 t Block channel notices
142 a Block all of the above
145 Multiple letters may be specified. For an exception, you must pair x
146 with what you want excepted. For example, if you wanted to except
147 everything from people with a host matching *.foo.net, you would do
148 /SILENCE +*!*@*.foo.net xa
150 /SILENCE without a parameter will list the masks that you have silenced.">
152 <helpop key="knock" value="/KNOCK <channel>
154 Sends a notice to a channel indicating you wish to join.">
156 <helpop key="user" value="/USER <ident> <local host> <remote host> :<real name>
158 This command is used by your client to register your
159 IRC session, providing your ident and real name to the
162 You should not use it during an established connection.">
164 <helpop key="nick" value="/NICK <new nick>
166 Change your nickname to <new nick>.">
168 <helpop key="quit" value="/QUIT [<reason>]
170 Quit from IRC and end your current session.">
172 <helpop key="version" value="/VERSION
174 Returns the server's version information.">
176 <helpop key="ping" value="/PING <server>
178 Ping a server. The server will answer with a PONG.">
180 <helpop key="pong" value="/PONG <server>
182 Your client should send this to answer server PINGs. You
183 should not issue this command manually.">
185 <helpop key="admin" value="/ADMIN [<server>]
187 Shows the administrative information for the given server.">
189 <helpop key="privmsg" value="/PRIVMSG <target> <text>
191 Sends a message to a user or channel specified in <target>.">
193 <helpop key="notice" value="/NOTICE <target> <text>
195 Sends a notice to a user or channel specified in <target>.">
197 <helpop key="join" value="/JOIN <channel>[,<channel>] [<key>][,<key>]
199 Joins one or more channels you provide the names for.">
201 <helpop key="names" value="/NAMES <channel>[,<channel>]
203 Return a list of users on the channels you provide.">
205 <helpop key="part" value="/PART <channel>[,<channel>] [<reason>]
207 Leaves one or more channels you specify.">
209 <helpop key="kick" value="/KICK <channel> <nick>[,<nick>] [<reason>]
211 Kicks a user from a channel you specify. You must be
212 at least a channel halfoperator to kick a user.">
214 <helpop key="mode" value="/MODE <target> (+|-)<modes> [<mode parameters>] - Change modes of <target>.
216 /MODE <target> - Show modes of <target>.
218 /MODE <channel> <list mode char> - List bans, exceptions, etc. set on <channel>.
220 Sets the mode for a channel or a nickname specified in <target>.
221 A user may only set modes upon themselves, and may not set the
222 +o usermode, and a user may only change channel modes of
223 channels where they are at least a halfoperator.
225 For a list of all user and channel modes, enter /HELPOP UMODES or
228 <helpop key="topic" value="/TOPIC <channel> [<topic>]
230 Sets or retrieves the channel topic. If a channel topic is
231 given in the command and either the channel is not +t, or
232 you are at least a halfoperator, the channel topic will be
233 changed to the new one you provide.">
235 <helpop key="who" value="/WHO <pattern> [<flags>][%[<fields>[,<querytype>]]] <pattern>
237 Looks up information about users matching the provided pattern. You can specify
238 a flag specific pattern, a channel name, user hostname, a user server name, a
239 user real name, or a user nickname. Matching users will only be included in the
242 1) The specified pattern is an exact channel name that does not have the
243 private or secret channel modes set and the user does not have the invisible
245 2) The specified pattern is an exact nickname.
246 3) You share one or more common channels with the user.
247 4) The user does not have the invisible user mode set.
248 5) You are a server operator with the users/auspex privilege.
250 If you specify any fields the response returned will be a WHOX response rather
251 than a RFC 1459 WHO response.
256 The following flags use <pattern> to match against the specified user data:
258 A Show users who have an away message matching <pattern>.
259 a Show users who have an account name matching <pattern>.
260 h Show users who have a hostname matching <pattern>. If the 'x' modifier
261 is specified then this will match against the real hostname instead of
262 the display hostname.
263 i Show users who have an IP address matching <pattern>.
264 m Show users who have the modes listed in <pattern>. The pattern
265 should be in the same format as a mode change e.g. +ow-i (server
267 n Show users who have a nickname matching <pattern>.
268 p Show users who are connected to a port in the <pattern> range (server
270 r Show users who have a real name matching <pattern>.
271 s Show users who are on a server with a name matching <pattern>. If the 'x'
272 modifier is specified then this will match against the real server name
273 instead of the masked server name.
274 t Show users who have connected in the last <pattern> seconds.
275 u Show users who have an ident (username) matching <pattern>.
277 The following flags filter users by their status:
279 f Only show users on remote (far) servers.
280 l Only show users on the local server.
281 o Only show server operators.
283 The following flags modify the command output:
285 x Show sensitive data like real user hostnames and, when hideserver is
286 enabled, real server hostnames.
288 You may combine one flag from the first group and multiple from the others in
294 a Include the user's account name in the response.
295 c Include the first common channel name in the response.
296 d Include the user's server distance from you in the response.
297 f Include the user's away status, oper status, and highest channel prefix
299 h Include the user's hostname in the response. If the 'x' flag was
300 specified then this is the real host rather than the display host.
301 i Include the user's IP address in the response.
302 l Include the user's idle time in the response.
303 n Include the user's nickname in the response.
304 o Include the user's channel operator rank level in the response.
305 r Include the user's real name in the response.
306 s Include the user's server name in the response. If the 'x' flag was
307 specified then this is the real server name rather than the masked server
309 t Include the query type in the response.
310 u Include the user's ident in the response.
314 <helpop key="motd" value="/MOTD [<server>]
316 Show the message of the day for <server>. Messages of the day often
317 contain important server rules and notices and should be read prior
320 <helpop key="oper" value="/OPER <login> <password>
322 Attempts to authenticate a user as an IRC operator.
324 Both successful and unsuccessful oper attempts are
325 logged, and sent to online IRC operators.">
327 <helpop key="list" value="/LIST [<pattern>]
329 Creates a list of all existing channels matching the glob pattern
330 <pattern>, e.g. *chat* or bot*.">
332 <helpop key="lusers" value="/LUSERS
334 Shows a count of local and remote users, servers and channels.">
336 <helpop key="userhost" value="/USERHOST <nick> [<nick>]
338 Returns the hostname and nickname of a user, and some other
339 miscellaneous information.">
341 <helpop key="away" value="/AWAY [<message>]
343 If a message is given, marks you as being away, otherwise
344 removes your away status and previous message.">
346 <helpop key="ison" value="/ISON <nick> [<nick> ...]
348 Returns a subset of the nicks you give, showing only those
349 that are currently online.">
351 <helpop key="invite" value="/INVITE <nick> <channel> [<time>]
353 Invites a user to a channel. If the channel is NOT +A, only
354 channel halfoperators or above can invite people. If +A is set,
355 anyone can invite people to the channel, as long as the person
356 doing the invite is a member of the channel they wish to invite
359 Invited users may override bans, +k, and similar in addition to
360 +i, depending on configuration.
362 If a time is provided, the invite expires after that time and the user
363 can no longer use it to enter the channel.">
365 <helpop key="pass" value="/PASS <password>
367 This command is used by your client when setting up
368 your IRC session to submit a server password to the
371 You should not use it during an established connection.">
373 <helpop key="whowas" value="/WHOWAS <nick>
375 Returns a list of times the user was seen recently on IRC along with
376 the time they were last seen and their server.">
378 <helpop key="links" value="/LINKS
380 Shows all servers linked to this one.">
382 <helpop key="map" value="/MAP
384 Shows a graphical representation of all users and servers on the
385 network, and the links between them, as a tree from the perspective
388 <helpop key="whois" value="/WHOIS <nick> [<server>]
390 Returns the WHOIS information of a user, their channels, hostname,
391 etc. If a second nickname or server is provided, then a whois is
392 performed from the server where the user is actually located rather
393 than locally, showing idle and signon times.">
395 <helpop key="time" value="/TIME [<server>]
397 Returns the local time of the server, or remote time of another
400 <helpop key="info" value="/INFO [<server>]
402 Returns information on the developers and supporters who made this
403 IRC server possible.">
405 <helpop key="setname" value="/SETNAME <name>
407 Sets your name to the specified name.">
410 <helpop key="coper" value="Oper Commands
413 OPERMOTD CHECK CLONES USERIP TLINE
414 ALLTIME WALLOPS GLOBOPS MODENOTICE
417 SETHOST SETIDENT CHGHOST CHGIDENT CHGNAME
420 SANICK NICKLOCK NICKUNLOCK
422 SAJOIN SAPART SAMODE SATOPIC SAKICK
424 KILL SAQUIT GLINE ZLINE QLINE
425 KLINE RLINE ELINE CBAN SHUN
426 FILTER OJOIN CLEARCHAN
428 CONNECT SQUIT RCONNECT RSQUIT
431 LOADMODULE UNLOADMODULE
432 RELOADMODULE GLOADMODULE GUNLOADMODULE
433 GRELOADMODULE CLOSE JUMPSERVER
434 LOCKSERV UNLOCKSERV">
436 <helpop key="userip" value="/USERIP <nick> [<nick>]
438 Returns the ip and nickname of the given users.">
440 <helpop key="tline" value="/TLINE <mask>
442 This command returns the number of local and global clients matched,
443 and the percentage of clients matched, plus how they were matched
444 (by IP address or by hostname). Mask should be given as either a
445 nick!user@host or user@IP (wildcards acceptable).">
447 <helpop key="lockserv" value="/LOCKSERV :[<message>]
449 Locks out all new connections notifying connecting users that the
450 service is temporarily closed and to try again later.">
452 <helpop key="unlockserv" value="/UNLOCKSERV
454 Opens the server up again for new connections.">
456 <helpop key="jumpserver" value="/JUMPSERVER [<newserver> <newport> <(+|-)[flags]> :[<reason>]]
458 Sets or cancels jumpserver mode. If no parameters are given,
459 jumpserver mode is cancelled, if it is currently set. If parameters
460 are given, a server address must be given for <newserver> and a
461 server port must be given for <newport>. Zero or more status flags
462 should be given for 'flags', from the list below (if you do not
463 wish to specify any flags just place a '+' in this field):
465 1. +a: Redirect all users immediately (except for opers) and cause
466 them to quit with the given reason
468 2. +n: Redirect any new users who connect and cause them to quit
471 You may use + and - to set or unset these flags in the command, the
472 default flags are -a+n, which will just redirect new users. The
473 reason parameter is optional, and if not provided defaults to
474 'Please use this server/port instead' (the default given in various
477 <helpop key="filter" value="/FILTER <filter-definition> [<action> <flags> [<duration>] :<reason>]
479 This command will add a filter when more than one parameter is given,
480 for messages of the types specified by the flags, with the given
481 filter definition, action, duration (when the action is 'gline',
482 'zline' or 'shun'), and reason.
484 The filter will take effect when a message of any type specified by
485 the flags and matching the definition is sent to the server, and
486 perform the specified action.
492 Warn Lets the message through and informs +s IRCops of the message
493 and all relevant info
494 Block Blocks message and informs +s IRCops of the blocked message
495 and all relevant info
496 Silent Blocks message, but does not notify IRCops
498 Gline G-lines the user for the specified duration
499 Zline Z-lines the user for the specified duration
500 Shun Shuns the user for the specified duration (requires the shun module)
505 p Block private and channel messages
506 n Block private and channel notices
507 P Block part messages
508 q Block quit messages
509 o Don't match against opers
510 c Strip all formatting codes from the message before matching
511 * Represents all of the above flags
512 - Does nothing, a non-op for when you do not want to specify any
515 The reason for the filter will be used as the reason for the action,
516 unless the action is 'none', and is sent to the user when their text is
517 blocked by 'block' and 'silent' actions.
519 A G-line, Z-line or shun duration may be specified in seconds, or in the
520 format 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5
521 minutes and 6 seconds. All fields in this format are optional.
523 When only one parameter is provided (the filter pattern) the provided
524 filter will be removed. Note that if you remove a
525 configuration-defined filter, it will reappear at next rehash unless
526 it is also removed from the config file.">
528 <helpop key="ojoin" value="/OJOIN <channel>
530 Force joins you to the specified channel, and gives you +Y and any other
531 configuration-defined modes on it, preventing you from being kicked.
532 Depending on configuration, may announce that you have joined the
533 channel on official network business.">
535 <helpop key="clones" value="/CLONES <limit>
537 Retrieves a list of users with more clones than the specified
540 <helpop key="check" value="/CHECK <nick|ip|hostmask|channel> [<server>]
542 Allows opers to look up advanced information on channels, hostmasks
543 or IP addresses, in a similar way to WHO but in more detail, displaying
544 most information the IRCD has stored on the target, including all
547 With the second parameter given, runs the command remotely on the
550 <helpop key="alltime" value="/ALLTIME
552 Shows the time on all servers on the network.">
554 <helpop key="rconnect" value="/RCONNECT <source mask> <target mask>
556 The server matching <source mask> will try to connect to the first
557 server in the config file matching <target mask>.">
559 <helpop key="rsquit" value="/RSQUIT <target mask> [<reason>]
561 Causes a remote server matching <target mask> to be disconnected from
564 <helpop key="globops" value="/GLOBOPS <message>
566 Sends a message to all users with the +g snomask.">
568 <helpop key="cban" value="/CBAN <channel> [<duration> :[<reason>]]
570 Sets or removes a channel ban. You must specify all three parameters
571 to add a ban, and one parameter to remove a ban (just the channel).
573 The duration may be specified in seconds, or in the format
574 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
575 5 minutes and 6 seconds. All fields in this format are optional.">
577 <helpop key="sajoin" value="/SAJOIN [<nick>] <channel>[,<channel>]
579 Forces the user to join the channel(s).
580 If no nick is given, it joins the oper doing the /SAJOIN.">
582 <helpop key="sapart" value="/SAPART <nick> <channel>[,<channel>]
584 Forces the user to part the channel(s).">
586 <helpop key="samode" value="/SAMODE <target> (+|-)<modes> [<parameters for modes>]
588 Applies the given mode change to the channel or nick specified.">
590 <helpop key="sanick" value="/SANICK <nick> <new nick>
592 Changes the user's nick to the new nick.">
594 <helpop key="sakick" value="/SAKICK <channel> <nick> <reason>
596 Kicks the given user from the specified channel.">
598 <helpop key="satopic" value="/SATOPIC <channel> <new topic>
600 Applies the given topic to the specified channel.">
602 <helpop key="saquit" value="/SAQUIT <nick> <reason>
604 Forces user to quit with the specified reason.">
606 <helpop key="setidle" value="/SETIDLE <idle time>
608 Sets your idle time (in seconds) to the specified value.">
610 <helpop key="sethost" value="/SETHOST <host>
612 Sets your host to the specified host.">
614 <helpop key="setident" value="/SETIDENT <ident>
616 Sets your ident to the specified ident.">
618 <helpop key="swhois" line="/SWHOIS <nick> <swhois>
620 Sets the user's swhois field to the given swhois.">
622 <helpop key="mkpasswd" value="/MKPASSWD <hashtype> <plaintext>
624 Encodes the plaintext to a hash of the given type and displays
627 <helpop key="opermotd" value="/OPERMOTD
629 Displays the Oper MOTD.">
631 <helpop key="nicklock" value="/NICKLOCK <nick> <new nick>
633 Changes the user's nick to the new nick, and forces
634 it to remain as such for the remainder of the session.">
636 <helpop key="nickunlock" value="/NICKUNLOCK <nick>
638 Allows a previously locked user to change nicks again.">
640 <helpop key="chghost" value="/CHGHOST <nickname> <new hostname>
642 Changes the hostname of the user to the new hostname.">
644 <helpop key="chgname" value="/CHGNAME <nickname> <new name>
646 Changes the name of the user to the new name.">
648 <helpop key="chgident" value="/CHGIDENT <nickname> <new ident>
650 Changes the ident of the user to the new ident.">
652 <helpop key="shun" value="/SHUN <nick!user@host> [[<duration>] :<reason>]
654 Sets or removes a shun (server side ignore) on a host and ident mask.
655 You must specify all three parameters to add a shun, and one parameter
656 to remove a shun (just the nick!user@host section).
658 The duration may be specified in seconds, or in the format
659 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
660 5 minutes and 6 seconds. All fields in this format are optional.">
662 <helpop key="die" value="/DIE <server>
664 This command shuts down the local server. A single parameter is
665 required, which must match the name of the local server.">
667 <helpop key="restart" value="/RESTART <server>
669 This command restarts the local server. A single parameter is
670 required, which must match the name of the local server.">
672 <helpop key="commands" value="/COMMANDS
674 Shows all currently available commands.">
676 <helpop key="kill" value="/KILL <user> <reason>
678 This command will disconnect a user from IRC with the given reason.">
680 <helpop key="rehash" value="/REHASH <mask>
682 This command will cause the server configuration file to be reread and
683 values reinitialized for all servers matching the server mask, or the
684 local server if one is not specified.">
686 <helpop key="connect" value="/CONNECT <servermask>
688 Add a connection to the server matching the given server mask. You must
689 have configured the server for linking in your configuration file
690 before trying to link them.">
692 <helpop key="squit" value="/SQUIT <servermask>
694 Disconnects the server matching the given server mask from this server.">
696 <helpop key="modules" value="/MODULES
698 Lists currently loaded modules, their memory offsets, version numbers,
699 and flags. If you are not an operator, you will see reduced detail.">
701 <helpop key="loadmodule" value="/LOADMODULE <modname>
703 Loads the specified module into the local server.">
705 <helpop key="unloadmodule" value="/UNLOADMODULE <modname>
707 Unloads a module from the local server.">
709 <helpop key="reloadmodule" value="/RELOADMODULE <modname>
711 Unloads and reloads a module on the local server.">
713 <helpop key="gloadmodule" value="/GLOADMODULE <modname>
715 Loads the specified module on all linked servers.">
717 <helpop key="gunloadmodule" value="/GUNLOADMODULE <modname>
719 Unloads a module from all linked servers.">
721 <helpop key="greloadmodule" value="/GRELOADMODULE <modname>
723 Unloads and reloads a module on all linked servers.">
725 <helpop key="kline" value="/KLINE <user@host> [<duration> :<reason>]
727 Sets or removes a K-line (local host based ban) on a host and ident mask.
728 You must specify all three parameters to add a ban, and one parameter
729 to remove a ban (just the user@host section).
731 The duration may be specified in seconds, or in the format
732 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
733 5 minutes and 6 seconds. All fields in this format are optional.">
735 <helpop key="zline" value="/ZLINE <ipmask> [<duration> :<reason>]
737 Sets or removes a Z-line (ip based ban) on an ip range mask.
738 You must specify all three parameters to add a ban, and one parameter
739 to remove a ban (just the ipmask).
741 The duration may be specified in seconds, or in the format
742 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
743 5 minutes and 6 seconds. All fields in this format are optional.">
745 <helpop key="qline" value="/QLINE <nickmask> [<duration> :<reason>]
747 Sets or removes a Q-line (nick based ban) on a nick mask.
748 You must specify all three parameters to add a ban, and one parameter
749 to remove a ban (just the nickmask).
751 The duration may be specified in seconds, or in the format
752 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
753 5 minutes and 6 seconds. All fields in this format are optional.">
755 <helpop key="gline" value="/GLINE <user@host> [<duration> :<reason>]
757 Sets or removes a G-line (host based ban) on host mask.
758 You must specify all three parameters to add a ban, and one
759 parameter to remove a ban (just the user@host section).
761 The duration may be specified in seconds, or in the format
762 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
763 5 minutes and 6 seconds. All fields in this format are optional.">
765 <helpop key="eline" value="/ELINE <user@host> [<duration> :<reason>]
767 Sets or removes a E-line (global ban exception) on host mask.
768 You must specify at least 3 parameters to add an exception, and one
769 parameter to remove an exception (just the user@host section).
771 The duration may be specified in seconds, or in the format
772 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
773 5 minutes and 6 seconds. All fields in this format are optional.
775 This command has a few important limitations. Bans on *@<ip> can only
776 be negated by an E-line on *@<ip>, bans on *@<host> can be negated by
777 E-lines on *@<ip>, or *@<host>, and bans on <ident>@* or <ident>@<host>
778 can be negated by any E-line that matches.">
780 <helpop key="wallops" value="/WALLOPS <message>
782 Sends a message to all +w users.">
784 <helpop key="rline" value="/RLINE <regex> [<duration> :<reason>]
786 Sets or removes an R-line (regex line) on a n!u@h\srealname mask. You
787 must specify all three parameters to add an R-line, and one parameter
788 to remove an R-line (just the regex).
790 The duration may be specified in seconds, or in the format
791 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
792 5 minutes and 6 seconds. All fields in this format are optional.">
794 <helpop key="close" value="/CLOSE
796 Closes all unregistered connections to the local server.">
798 <helpop key="clearchan" value="/CLEARCHAN <channel> [<KILL|KICK|G|Z>] [<reason>]
800 Quits or kicks all non-opers from a channel, optionally G/Z-lines them.
801 Useful for quickly nuking bot channels.
803 The default method, KILL, simply disconnects the victims from the server,
804 while methods G and Z also add G/Z-lines for all the targets.
806 When used, the victims won't see each other getting kicked or quitting.">
808 <helpop key="modenotice" value="/MODENOTICE <modeletters> <message>
810 Sends a notice to all users who have the given mode(s) set.
811 If multiple mode letters are given, the notice is only sent to users
812 who have all of them set.">
814 <helpop key="cloak" value="/CLOAK <host>
816 Generate the cloak of a host or IP. This is useful for example when
817 trying to get the cloak of a user from /WHOWAS and they were not
818 using their cloak when they quit.">
820 <helpop key="umodes" value="User Modes
823 c Blocks private messages and notices from users who do
824 not share a common channel with you (requires the
826 d Deaf mode. User will not receive any messages or notices
827 from channels they are in (requires the deaf module).
828 g In combination with /ACCEPT, provides for server side
829 ignore (requires the callerid module).
830 h Marks as 'available for help' in WHOIS (IRCop only,
831 requires the helpop module).
832 i Makes invisible to /WHO if the user using /WHO is not in
834 k Prevents the user from being kicked from channels, or
835 having op modes removed from them (services only,
836 requires the servprotect module).
837 o Marks as a IRC operator.
838 s <mask> Receives server notices specified by <mask>
840 r Marks as a having a registered nickname
841 (requires the services account module).
842 w Receives wallops messages.
843 x Gives a cloaked hostname (requires the cloaking module).
844 z Only allow private messages from SSL users (requires the
846 B Marks as a bot (requires the botmode module).
847 G Censors messages sent to the user based on filters
848 configured for the network (requires the censor module).
849 H Hides an oper's oper status from WHOIS (requires the
851 I Hides a user's entire channel list in WHOIS from
852 non-IRCops (requires the hidechans module).
853 L Stops redirections done by m_redirect (mode must be
854 enabled in the config).
855 R Blocks private messages from unregistered users
856 (requires the services account module).
857 S Strips formatting codes out of private messages
858 to the user (requires the stripcolor module).
859 W Receives notification when a user uses WHOIS on them
860 (IRCop only, requires the showwhois module).">
862 <helpop key="chmodes" value="Channel Modes
865 v <nickname> Gives voice to <nickname>, allowing them to speak
866 while the channel is +m.
867 h <nickname> Gives halfop status to <nickname> (requires the
868 customprefix module).
869 o <nickname> Gives op status to <nickname>.
870 a <nickname> Gives protected status to <nickname>, preventing
871 them from being kicked (+q only, requires the
872 customprefix module).
873 q <nickname> Gives owner status to <nickname>, preventing them
874 from being kicked (Services or +q only, requires
875 the customprefix module).
877 b <hostmask> Bans <hostmask> from the channel.
878 e <hostmask> Excepts <hostmask> from bans (requires the
879 banexception module).
880 I <hostmask> Excepts <hostmask> from +i, allowing matching
881 users to join while the channel is invite-only
882 (requires the inviteexception module).
884 c Blocks messages that contain formatting codes
885 (requires the blockcolor module).
886 d <time> Blocks messages to a channel from new users
887 until they have been in the channel for <time>
888 seconds (requires the delaymsg module).
889 f [*]<lines>:<sec> Kicks on text flood equal to or above the
890 specified rate. With *, the user is banned
891 (requires the messageflood module).
892 g <mask> Blocks messages matching the given glob mask
893 (requires the chanfilter module).
894 i Makes the channel invite-only.
895 Users can only join if an operator
896 uses /INVITE to invite them.
897 j <joins>:<sec> Limits joins to the specified rate (requires
898 the joinflood module).
899 k <key> Set the channel key (password) to <key>.
900 l <limit> Set the maximum allowed users to <limit>.
901 m Enable moderation. Only users with +v, +h, or +o
903 n Blocks users who are not members of the channel
905 p Make channel private, hiding it in users' whoises
906 and replacing it with * in /LIST.
907 r Marks the channel as registered with Services
908 (requires the services account module).
909 s Make channel secret, hiding it in users' whoises
911 t Prevents users without +h or +o from changing the
913 u Makes the channel an auditorium; normal users only
914 see themselves or themselves and the operators,
915 while operators see all the users (requires the
917 w <flag>:<banmask> Adds basic channel access controls of <flag> to
918 <banmask>, via the +w listmode.
919 For example, +w o:R:Brain will op anyone identified
920 to the account 'Brain' on join.
921 (requires the autoop module)
922 z Blocks non-SSL clients from joining the channel.
924 A Allows anyone to invite users to the channel
925 (normally only chanops can invite, requires
926 the allowinvite module).
927 B Blocks messages with too many capital letters,
928 as determined by the network configuration
929 (requires the blockcaps module).
930 C Blocks any CTCPs to the channel (requires the
932 D Delays join messages from users until they message
933 the channel (requires the delayjoin module).
934 E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similar messages.
935 Kicks as default, blocks with ~ and bans with *
936 The last two parameters are optional.
937 F <changes>:<sec> Blocks nick changes when they equal or exceed the
938 specified rate (requires the nickflood module).
939 G Censors messages to the channel based on the
940 network configuration (requires the censor module).
941 H <num>:<duration> Displays the last <num> lines of chat to joining
942 users. <duration> is the maximum time to keep
943 lines in the history buffer (requires the
945 J <seconds> Prevents rejoin after kick for the specified
946 number of seconds. This prevents auto-rejoin
947 (requires the kicknorejoin module).
948 K Blocks /KNOCK on the channel.
949 L <channel> If the channel reaches its limit set by +l,
950 redirect users to <channel> (requires the
952 M Blocks unregistered users from speaking (requires
953 the services account module).
954 N Prevents users on the channel from changing nick
955 (requires the nonicks module).
956 O Channel is IRCops only (can only be set by IRCops,
957 requires the operchans module).
958 P Makes the channel permanent; Bans, invites, the
959 topic, modes, and such will not be lost when it
960 empties (can only be set by IRCops, requires
961 the permchannels module).
962 Q Only ulined servers and their users can kick
963 (requires the nokicks module)
964 R Blocks unregistered users from joining (requires
965 the services account module).
966 S Strips formatting codes from messages to the
967 channel (requires the stripcolor module).
968 T Blocks /NOTICEs to the channel from users who are
969 not at least halfop (requires the nonotice module).
970 X <type>:<status> Makes users of <status> or higher exempt to the
971 specified restriction <type>. For example: flood:h
972 (requires the exemptchanops module).
973 Possible restriction types to exempt with +X are:
975 auditorium-see Permission required to see the full user list of
976 a +u channel (requires the auditorium module).
977 auditorium-vis Permission required to be visible in a +u channel
978 (requires the auditorium module).
979 blockcaps Channel mode +B
980 blockcolor Channel mode +c
981 censor Channel mode +G
982 filter Channel mode +g
983 flood Channel mode +f
984 nickflood Channel mode +F
985 noctcp Channel mode +C
986 nonick Channel mode +N
987 nonotice Channel mode +T
988 regmoderated Channel mode +M
989 stripcolor Channel mode +S
990 topiclock Channel mode +t
993 NOTE: A large number of these modes are dependent upon server-side modules
994 being loaded by a server/network administrator. The actual modes available
995 on your network may be very different to this list. Please consult your
996 help channel if you have any questions.">
998 <helpop key="stats" value="/STATS <symbol>
1000 Shows various server statistics. Depending on configuration, some
1001 symbols may be only available to opers.
1005 e Show E-lines (local ban exemptions)
1006 g Show G-lines (host bans)
1007 k Show K-lines (local host bans)
1008 q Show Q-lines (nick mask bans)
1009 R Show R-lines (regular expression bans)
1010 Z Show Z-lines (IP mask bans)
1017 d Show configured DNSBLs and related statistics
1018 m Show command statistics, number of times commands have been used
1019 o Show a list of all valid oper usernames and hostmasks
1020 p Show open client ports, and the port type (ssl, plaintext, etc)
1021 u Show server uptime
1022 z Show memory usage statistics
1023 i Show connect class permissions
1024 l Show all client connections with information (sendq, commands, bytes, time connected)
1025 L Show all client connections with information and IP address
1026 P Show online opers and their idle times
1027 T Show bandwidth/socket statistics
1028 U Show U-lined servers
1029 Y Show connection classes
1030 O Show opertypes and the allowed user and channel modes it can set
1031 E Show socket engine events
1032 S Show currently held registered nicknames
1033 G Show how many local users are connected from each country according to GeoIP
1035 Note that all /STATS use is broadcast to online IRC operators.">
1037 <helpop key="snomasks" value="Server Notice Masks
1039 a Allows receipt of local announcement messages.
1040 A Allows receipt of remote announcement messages.
1041 c Allows receipt of local connect messages.
1042 C Allows receipt of remote connect messages.
1043 d Allows receipt of local DNSBL messages (requires the dnsbl module).
1044 D Allows receipt of remote DNSBL messages (requires the dnsbl module).
1045 f Allows receipt of local filter messages (requires the filter module).
1046 F Allows receipt of remote filter messages (requires the filter module).
1047 g Allows receipt of globops (requires the globops module).
1048 j Allows receipt of channel creation notices (requires the chancreate module).
1049 J Allows receipt of remote channel creation notices (requires the chancreate module).
1050 k Allows receipt of local kill messages.
1051 K Allows receipt of remote kill messages.
1052 l Allows receipt of local linking related messages.
1053 L Allows receipt of remote linking related messages.
1054 n See local nickname changes (requires the seenicks module).
1055 N See remote nickname changes (requires the seenicks modules).
1056 o Allows receipt of oper-up, oper-down, and oper-failure messages.
1057 O Allows receipt of remote oper-up, oper-down, and oper-failure messages.
1058 q Allows receipt of local quit messages.
1059 Q Allows receipt of remote quit messages.
1060 r Allows receipt of local oper commands (requires the operlog module).
1061 R Allows receipt of remote oper commands (requires the operlog module).
1062 t Allows receipt of attempts to use /STATS (local and remote).
1063 v Allows receipt of oper-override notices (requires the override module).
1064 x Allows receipt of local X-line notices (G/Z/Q/K/E/R/SHUN/CBan).
1065 X Allows receipt of remote X-line notices (G/Z/Q/K/E/R/SHUN/CBan).">
1067 <helpop key="extbans" value="Extended Bans
1070 Extbans are split into two types; matching extbans, which match on
1071 users in additional ways, and acting extbans, which restrict users
1072 in different ways to a standard ban.
1074 To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
1075 instead of a normal nick!user@host mask, to ban or exempt matching
1076 users. Ban exceptions on acting extbans exempt that user from matching
1077 an extban of that type, and from any channel mode corresponding to the
1078 restriction. Matching extbans may also be used for invite exceptions by
1079 setting +I <extban>.
1083 a:<mask> Matches user with both a matching banmask and realname,
1084 where <mask> is in the format nick!user@host+realname
1085 (requires gecosban module).
1086 j:<channel> Matches anyone in the given channel. Does not support
1087 wildcards (requires the channelban module).
1088 n:<class> Matches users in a matching connect class (requires
1089 the classban module).
1090 r:<realname> Matches users with a matching real name (requires the
1092 s:<server> Matches users on a matching server (requires the
1094 z:<certfp> Matches users having the given SSL certificate
1095 fingerprint (requires the sslmodes module).
1096 O:<opertype> Matches IRCops of a matching type, mostly useful as an
1097 an invite exception (requires the operchans module).
1098 R:<account> Matches users logged into a matching account (requires
1099 the services account module).
1100 U:<banmask> Matches unregistered users matching the given banmask.
1101 (requires the services account module).
1105 c:<banmask> Blocks any messages that contain formatting codes from
1106 matching users (requires the blockcolor module).
1107 m:<banmask> Blocks messages from matching users (requires the muteban
1108 module). Users with +v or above are not affected.
1109 p:<banmask> Blocks part messages from matching users (requires
1110 the nopartmsg module).
1111 A:<banmask> Blocks invites by matching users even when +A is set
1112 (requires the allowinvite module).
1113 B:<banmask> Blocks all capital or nearly all capital messages from
1114 matching users (requires the blockcaps module).
1115 C:<banmask> Blocks CTCPs from matching users (requires the noctcp
1117 N:<banmask> Blocks nick changes from matching users (requires
1118 the nonicks module).
1119 Q:<banmask> Blocks kicks by matching users (requires the nokicks
1121 S:<banmask> Strips formatting codes from messages from matching
1122 users (requires the stripcolor module).
1123 T:<banmask> Blocks notices from matching users (requires the
1126 A ban given to an Acting extban may either be a nick!user@host mask
1127 (unless stated otherwise), matched against users as for a normal ban,
1128 or a Matching extban.
1130 There is an additional special type of extended ban, a redirect ban:
1132 Redirect n!u@h#channel will redirect the banned user to #channel
1133 when they try to join (requires the banredirect module).">