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" title="something here" value="something here">
7 # key is what the user is looking for (i.e. /helpop moo), title is the title, and
8 # value is what they get back
9 # (note that it can span multiple lines!).
15 <alias text="HELP" replace="HELPOP $2-">
17 <helpmsg nohelp="There is no help for the topic you searched for. Please try again.">
19 <helpop key="start" title="InspIRCd Help System" value="
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
30 /HELPOP INDEX - To see a list of help topics
33 <helpop key="cuser" title="User Commands" value="
34 ACCEPT ADMIN AWAY COMMANDS CYCLE DCCALLOW
35 FPART INFO INVITE ISON JOIN KICK
36 KNOCK LINKS LIST LUSERS MAP MKPASSWD
37 MODE MODULES MONITOR MOTD NAMES NICK
38 NOTICE OPER PART PASS PING PONG
39 PRIVMSG QUIT REMOVE SETNAME SILENCE SQUERY
40 SSLINFO STATS TBAN TIME TITLE TOPIC
41 UNINVITE USER USERHOST VERSION VHOST WATCH
45 <helpop key="squery" title="/SQUERY <target> :<message>" value="
46 Sends a message to the network service specified in <target>.
49 <helpop key="sslinfo" title="/SSLINFO <nick>" value="
50 Displays information on the TLS (SSL) connection and certificate of the
54 <helpop key="uninvite" title="/UNINVITE <nick> <channel>" value="
55 Uninvite a user from a channel, same syntax as INVITE.
58 <helpop key="tban" title="/TBAN <channel> <duration> <banmask>" value="
59 Sets a timed ban. The duration of the ban can be specified in the
60 form of 1y2w3d4h5m6s - meaning one year, two weeks, three days,
61 four hours, five minutes and six seconds. All fields in this
62 format are optional. Alternatively, the ban may just be specified
63 as a number of seconds. All timed bans appear in the banlist as
64 normal bans and may be safely removed before their time is up.
67 <helpop key="dccallow" title="/DCCALLOW [(+|-)<nick> [<time>]]|[LIST|HELP]" value="
68 /DCCALLOW - List allowed nicks
69 /DCCALLOW LIST - This also lists allowed nicks
70 /DCCALLOW +<nick> [<duration>] - Add a nick
71 /DCCALLOW -<nick> - Remove a nick
72 /DCCALLOW HELP - Display help
74 Duration is optional, and may be specified in seconds or in the
75 form of 1y2w3d4h5m6s - meaning one year, two weeks, three days,
76 four hours, five minutes and six seconds. All fields in this
80 <helpop key="accept" title="/ACCEPT *|(+|-)<nick>[,(+|-)<nick>]+" value="
81 Manages your accept list. This list is used to determine who can
82 private message you when you have user mode +g set.
84 /ACCEPT * - List accepted nicks
85 /ACCEPT +<nick> - Add a nick
86 /ACCEPT -<nick> - Remove a nick
88 This command accepts multiple nicks like so:
89 /ACCEPT +<nick>,-<nick>,+<nick>
92 <helpop key="cycle" title="/CYCLE <channel> [:<reason>]" value="
93 Cycles a channel (leaving and rejoining), overrides restrictions that
94 would stop a new user joining, such as user limits and channel keys.
97 <helpop key="title" title="/TITLE <username> <password>" value="
98 Authenticate for a WHOIS title line and optionally a vhost using the
99 specified username and password.
102 <helpop key="watch" title="/WATCH C|L|l|S|(+|-)<nick> [(+|-)<nick>]+" value="
103 /WATCH - List watched nicks that are online
104 /WATCH l - List watched nicks that are online
105 /WATCH L - List watched nicks, online and offline
106 /WATCH C - Clear all watched nicks
107 /WATCH S - Show statistics
108 /WATCH +<nick> - Add a nick
109 /WATCH -<nick> - Remove a nick
111 This command accepts multiple nicks like so:
112 /WATCH +<nick> -<nick> +<nick>
115 <helpop key="monitor" title="/MONITOR C|L|S|(+|-) <nick>[,<nick>]+" value="
116 /MONITOR L - List all monitored nicks, not differentiating between
117 online and offline nicks
118 /MONITOR C - Clear all monitored nicks
119 /MONITOR S - List all monitored nicks, indicating which are online
120 and which are offline
121 /MONITOR + <nick> - Add a nick
122 /MONITOR - <nick> - Remove a nick
124 This command accepts multiple nicks like so:
125 /MONITOR + <nick>,<nick>,<nick>
126 /MONITOR - <nick>,<nick>,<nick>
129 <helpop key="vhost" title="/VHOST <username> <password>" value="
130 Authenticate for a vhost using the specified username and password.
133 <helpop key="remove" title="/REMOVE <channel> <nick> [:<reason>]" value="
134 Removes a user from a channel you specify. You must be at least a
135 channel halfoperator to remove a user. A removed user will part with
136 a message stating they were removed from the channel and by whom.
139 <helpop key="rmode" title="/RMODE <channel> <mode> [<pattern>]" value="
140 Removes listmodes from a channel, optionally matching a glob-based pattern.
141 E.g. '/RMODE #channel b m:*' will remove all mute extbans on the channel.
144 <helpop key="fpart" title="/FPART <channel> <nick> [:<reason>]" value="
145 This behaves identically to /REMOVE. /REMOVE is a built-in mIRC command
146 which caused trouble for some users.
149 <helpop key="silence" title="/SILENCE [(+|-)<mask> [CcdiNnPpTtx]]" value="
150 A server-side ignore of the given n!u@h mask. If the optional flags field is
151 specified then it must contain one or more flags which specify what kind of
152 messages should be blocked and how they should be blocked.
154 /SILENCE - Shows a list of silenced masks
155 /SILENCE +<mask> [<flags>] - Add a mask
156 /SILENCE -<mask> - Remove a mask
160 C Matches a CTCP targeted at a user.
161 c Matches a CTCP targeted at a channel.
162 d Default behaviour; equivalent to CciNnPpTt.
163 i Matches an invite to a channel.
164 N Matches a NOTICE targeted at a user.
165 n Matches a NOTICE targeted at a channel.
166 P Matches a PRIVMSG targeted at a user.
167 p Matches a PRIVMSG targeted at a channel.
168 T Matches a TAGMSG targeted at a user.
169 t Matches a TAGMSG targeted at a channel.
170 x Exempt the mask from silence rules.
172 Any combination of flags is valid.
175 <helpop key="knock" title="/KNOCK <channel> :<reason>" value="
176 Sends a notice to a channel indicating you wish to join.
179 <helpop key="user" title="/USER <username> <unused> <unused> :<realname>" value="
180 This command is used by your client to register your
181 IRC session, providing your ident and real name to the
184 You should not use it during an established connection.
187 <helpop key="nick" title="/NICK <newnick>" value="
188 Change your nickname to <newnick>.
191 <helpop key="quit" title="/QUIT [:<message>]" value="
192 Quit from IRC and end your current session.
195 <helpop key="version" title="/VERSION [<servername>]" value="
196 Returns the server's version information.
199 <helpop key="ping" title="/PING <servername> [:<servername>]" value="
200 Ping a server. The server will answer with a PONG.
203 <helpop key="pong" title="/PONG <servername>" value="
204 Your client should send this to answer server PINGs. You
205 should not issue this command manually.
208 <helpop key="admin" title="/ADMIN [<servername>]" value="
209 Shows the administrative information for the given server.
212 <helpop key="privmsg" title="/PRIVMSG <target>[,<target>]+ :<message>" value="
213 Sends a message to a user or channel specified in <target>.
216 <helpop key="notice" title="/NOTICE <target>[,<target>]+ :<message>" value="
217 Sends a notice to a user or channel specified in <target>.
220 <helpop key="join" title="/JOIN <channel>[,<channel>]+ [<key>[,<key>]+]" value="
221 Joins one or more channels you provide the names for.
224 <helpop key="names" title="/NAMES [<channel>[,<channel>]+]" value="
225 Return a list of users on the channel(s) you provide.
228 <helpop key="part" title="/PART <channel>[,<channel>]+ [:<reason>]" value="
229 Leaves one or more channels you specify.
232 <helpop key="kick" title="/KICK <channel> <nick>[,<nick>]+ [:<reason>]" value="
233 Kicks a user from a channel you specify. You must be
234 at least a channel halfoperator to kick a user.
237 <helpop key="mode" title="/MODE <target> [[(+|-)]<modes> [<mode-parameters>]]" value="
238 Change or view modes of <target>.
240 /MODE <target> - Show modes of <target>.
242 /MODE <channel> <list mode char> - List bans, exceptions, etc. set on <channel>.
244 Sets the mode for a channel or a nickname specified in <target>.
245 A user may only set modes upon themselves, and may not set the
246 +o user mode, and a user may only change channel modes of
247 channels where they are at least a halfoperator.
249 For a list of all user and channel modes, enter /HELPOP UMODES or
253 <helpop key="topic" title="/TOPIC <channel> [:<topic>]" value="
254 Sets or retrieves the channel topic. If a channel topic is
255 given in the command and either the channel is not +t, or
256 you are at least a halfoperator, the channel topic will be
257 changed to the new one you provide.
260 <helpop key="who" title="/WHO <pattern> [<flags>][%[<fields>[,<querytype>]]] <pattern>" value="
261 Looks up information about users matching the provided pattern. You can specify
262 a flag specific pattern, a channel name, user hostname, a user server name, a
263 user real name, or a user nickname. Matching users will only be included in the
266 1) The specified pattern is an exact channel name that does not have the
267 private or secret channel modes set and the user does not have the invisible
269 2) The specified pattern is an exact nickname.
270 3) You share one or more common channels with the user.
271 4) The user does not have the invisible user mode set.
272 5) You are a server operator with the users/auspex privilege.
274 If you specify any fields the response returned will be a WHOX response rather
275 than a RFC 1459 WHO response.
280 The following flags use <pattern> to match against the specified user data:
282 A Show users who have an away message matching <pattern>.
283 a Show users who have an account name matching <pattern>.
284 h Show users who have a hostname matching <pattern>. If the 'x' modifier
285 is specified then this will match against the real hostname instead of
286 the display hostname.
287 i Show users who have an IP address matching <pattern>.
288 m Show users who have the modes listed in <pattern>. The pattern
289 should be in the same format as a mode change e.g. +ow-i (server
291 n Show users who have a nickname matching <pattern>.
292 p Show users who are connected to a port in the <pattern> range (server
294 r Show users who have a real name matching <pattern>.
295 s Show users who are on a server with a name matching <pattern>. If the 'x'
296 modifier is specified then this will match against the real server name
297 instead of the masked server name.
298 t Show users who have connected in the last <pattern> seconds.
299 u Show users who have an ident (username) matching <pattern>.
301 The following flags filter users by their status:
303 f Only show users on remote (far) servers.
304 l Only show users on the local server.
305 o Only show server operators.
307 The following flags modify the command output:
309 x Show sensitive data like real user hostnames and, when hideserver is
310 enabled, real server hostnames.
312 You may combine one flag from the first group and multiple from the others in
318 a Include the user's account name in the response.
319 c Include the first common channel name in the response.
320 d Include the user's server distance from you in the response.
321 f Include the user's away status, oper status, and highest channel prefix
323 h Include the user's hostname in the response. If the 'x' flag was
324 specified then this is the real host rather than the display host.
325 i Include the user's IP address in the response.
326 l Include the user's idle time in the response.
327 n Include the user's nickname in the response.
328 o Include the user's channel operator rank level in the response.
329 r Include the user's real name in the response.
330 s Include the user's server name in the response. If the 'x' flag was
331 specified then this is the real server name rather than the masked server
333 t Include the query type in the response.
334 u Include the user's ident in the response.
339 <helpop key="motd" title="/MOTD [<servername>]" value="
340 Show the message of the day for <server>. Messages of the day often
341 contain important server rules and notices and should be read prior
345 <helpop key="oper" title="/OPER <username> <password>" value="
346 Attempts to authenticate as a server operator.
348 Both successful and unsuccessful oper attempts are
349 logged, and sent to online server operators.
352 <helpop key="list" title="/LIST [<pattern>]" value="
353 Creates a list of all existing channels matching the glob pattern
354 <pattern>, e.g. *chat* or bot*.
357 <helpop key="lusers" title="/LUSERS" value="
358 Shows a count of local and remote users, servers and channels.
361 <helpop key="userhost" title="/USERHOST <nick> [<nick>]+" value="
362 Returns the hostname and nickname of a user, and some other
363 miscellaneous information.
366 <helpop key="away" title="/AWAY [:<message>]" value="
367 If a message is given, marks you as being away, otherwise
368 removes your away status and previous message.
371 <helpop key="ison" title="/ISON <nick> [<nick>]+" value="
372 Returns a subset of the nicks you give, showing only those
373 that are currently online.
376 <helpop key="invite" title="/INVITE [<nick> <channel> [<time>]]" value="
377 Invites a user to a channel. If the channel is NOT +A, only
378 channel halfoperators or above can invite people. If +A is set,
379 anyone can invite people to the channel, as long as the person
380 doing the invite is a member of the channel they wish to invite
383 Invited users may override bans, +k, and similar in addition to
384 +i, depending on configuration.
386 If a time is provided, the invite expires after that time and the user
387 can no longer use it to enter the channel. The time can be specified
388 in the form of 1y2w3d4h5m6s - meaning one year, two weeks, three days,
389 four hours, five minutes and six seconds. All fields in this format
390 are optional. Alternatively, the time may just be specified as a number
393 /INVITE without a parameter will list pending invitations for channels
394 you have been invited to.
397 <helpop key="pass" title="/PASS <password>" value="
398 This command is used by your client when setting up
399 your IRC session to submit a server password to the
402 You should not use it during an established connection.
405 <helpop key="whowas" title="/WHOWAS <nick>" value="
406 Returns a list of times the user was seen recently on IRC along with
407 the time they were last seen and their server.
410 <helpop key="links" title="/LINKS" value="
411 Shows all linked servers.
414 <helpop key="map" title="/MAP" value="
415 Shows a graphical representation of all users and servers on the
416 network, and the links between them, as a tree from the perspective
420 <helpop key="whois" title="/WHOIS [<servername>] <nick>[,<nick>]+" value="
421 Returns the WHOIS information of a user, their channels, hostname,
422 etc. If a servername is provided, then a whois is performed from
423 the server where the user is actually located rather than locally,
424 showing idle and signon times.
427 <helpop key="time" title="/TIME [<servername>]" value="
428 Returns the local time of the server, or remote time of another
432 <helpop key="info" title="/INFO [<servername>]" value="
433 Returns information on the developers and supporters who made this
437 <helpop key="setname" title="/SETNAME :<realname>" value="
438 Sets your real name to the specified real name.
442 <helpop key="coper" title="Oper Commands" value="
443 ALLTIME CBAN CHECK CHGHOST CHGIDENT
444 CHGNAME CLEARCHAN CLOAK CLONES CONNECT
445 DIE ELINE FILTER GLINE GLOADMODULE
446 GLOBOPS GRELOADMODULE GUNLOADMODULE KILL KLINE
447 LOADMODULE LOCKSERV MODENOTICE NICKLOCK NICKUNLOCK
448 OJOIN OPERMOTD QLINE RCONNECT REHASH
449 RELOADMODULE RESTART RLINE RSQUIT SAJOIN
450 SAKICK SAMODE SANICK SAPART SAQUIT
451 SATOPIC SETHOST SETIDENT SETIDLE SHUN
452 SQUIT SWHOIS TLINE UNLOADMODULE UNLOCKSERV
456 <helpop key="userip" title="/USERIP <nick> [<nick>]+" value="
457 Returns the IP address and nickname of the given user(s).
460 <helpop key="tline" title="/TLINE <mask>" value="
461 This command returns the number of local and global clients matched,
462 and the percentage of clients matched, plus how they were matched
463 (by IP address or by hostname). Mask should be given as either
464 nick!user@host or user@IP (wildcards and CIDR blocks are accepted).
467 <helpop key="lockserv" title="/LOCKSERV [:<message>]" value="
468 Locks out all new connections notifying connecting users that the
469 service is temporarily closed and to try again later.
472 <helpop key="unlockserv" title="/UNLOCKSERV" value="
473 Opens the server up again for new connections.
476 <helpop key="filter" title="/FILTER <pattern> [<action> <flags> [<duration>] :<reason>]" value="
477 This command will add a global filter when more than one parameter is
478 given, for messages of the types specified by the flags, with the given
479 filter pattern, action, duration (when the action is 'gline', 'zline'
480 or 'shun'), and reason.
482 The filter will take effect when a message of any type specified by
483 the flags and matching the pattern is sent to the server, and
484 perform the specified action.
490 Warn Lets the message through and informs +s server operators
491 of the message and all relevant info
492 Block Blocks message and informs +s server operators of the blocked
493 message and all relevant info
494 Silent Blocks message, but does not notify server operators
496 Gline G-lines the user for the specified duration
497 Zline Z-lines the user for the specified duration
498 Shun Shuns the user for the specified duration (requires the shun module)
503 p Block private and channel messages
504 n Block private and channel notices
505 P Block part messages
506 q Block quit messages
507 o Don't match against opers
508 r Don't match against registered users
509 c Strip all formatting codes from the message before matching
510 * Represents all of the above flags except r
511 - Does nothing, a non-op for when you do not want to specify any
514 The reason for the filter will be used as the reason for the action,
515 unless the action is 'none', and is sent to the user when their text is
516 blocked by 'block' and 'silent' actions.
518 A G-line, Z-line or shun duration may be specified in seconds, or in the
519 format 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5
520 minutes and 6 seconds. All fields in this format are optional.
522 When only one parameter is provided (the filter pattern) the provided
523 filter will be removed. Note that if you remove a
524 configuration-defined filter, it will reappear at next rehash unless
525 it is also removed from the config file.
528 <helpop key="ojoin" title="/OJOIN <channel>" value="
529 Force joins you to the specified channel, and gives you +Y and any other
530 configuration-defined modes on it, preventing you from being kicked.
531 Depending on configuration, may announce that you have joined the
532 channel on official network business.
535 <helpop key="clones" title="/CLONES <limit>" value="
536 Retrieves a list of users with more clones than the specified
540 <helpop key="check" title="/CHECK <nick>|<ipmask>|<hostmask>|<channel> [<servername>]" value="
541 Allows opers to look up advanced information on nicknames, IP addresses,
542 hostmasks or channels, in a similar way to WHO but in more detail,
543 displaying most information the server has stored on the target,
544 including all metadata.
546 With the second parameter given, runs the command remotely on the
547 specified server, useful especially if used on a nickname that is
548 online on a remote server.
551 <helpop key="alltime" title="/ALLTIME" value="
552 Shows the date and time of all servers on the network.
555 <helpop key="rconnect" title="/RCONNECT <remote-server-mask> <target-server-mask>" value="
556 The server matching <remote-server-mask> will try to connect to the first
557 server in the config file matching <target-server-mask>.
560 <helpop key="rsquit" title="/RSQUIT <target-server-mask> [:<reason>]" value="
561 Causes a remote server matching <target-server-mask> to be disconnected from
565 <helpop key="globops" title="/GLOBOPS :<message>" value="
566 Sends a message to all users with the +g snomask.
569 <helpop key="cban" title="/CBAN <channel> [<duration> [:<reason>]]" value="
570 Sets or removes a global 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, four hours,
575 five minutes and six seconds. All fields in this format are optional.
578 <helpop key="sajoin" title="/SAJOIN [<nick>] <channel>[,<channel>]+" value="
579 Forces the user to join the channel(s).
580 If no nick is given, it joins the oper doing the /SAJOIN.
583 <helpop key="sapart" title="/SAPART <nick> <channel>[,<channel>]+ [:<reason>]" value="
584 Forces the user to part the channel(s), with an optional reason.
587 <helpop key="samode" title="/SAMODE <target> (+|-)<modes> [<mode-parameters>]" value="
588 Applies the given mode change to the channel or nick specified.
591 <helpop key="sanick" title="/SANICK <nick> <newnick>" value="
592 Changes the user's nick to the new nick.
595 <helpop key="sakick" title="/SAKICK <channel> <nick> [:<reason>]" value="
596 Kicks the given user from the specified channel, with an optional reason.
599 <helpop key="satopic" title="/SATOPIC <channel> :<topic>" value="
600 Applies the given topic to the specified channel.
603 <helpop key="saquit" title="/SAQUIT <nick> :<reason>" value="
604 Forces user to quit with the specified reason.
607 <helpop key="setidle" title="/SETIDLE <duration>" value="
608 Sets your idle time to the specified value.
610 The time can be specified in the form of 1y2w3d4h5m6s - meaning one year,
611 two weeks, three days, four hours, five minutes and six seconds.
612 All fields in this format are optional. Alternatively, the time may
613 just be specified as a number of seconds.
616 <helpop key="sethost" title="/SETHOST <host>" value="
617 Sets your host to the specified host.
620 <helpop key="setident" title="/SETIDENT <ident>" value="
621 Sets your ident to the specified ident.
624 <helpop key="swhois" title="/SWHOIS <nick> :<swhois>" value="
625 Sets the user's swhois field to the given swhois message.
626 This will be visible in their /WHOIS.
628 To remove this message again, use:
632 <helpop key="mkpasswd" title="/MKPASSWD <hashtype> <plaintext>" value="
633 Encodes the plaintext to a hash of the given type and displays
637 <helpop key="opermotd" title="/OPERMOTD [<servername>]" value="
638 Displays the Oper MOTD.
641 <helpop key="nicklock" title="/NICKLOCK <nick> <newnick>" value="
642 Changes the user's nick to the new nick, and forces
643 it to remain as such for the remainder of the session.
646 <helpop key="nickunlock" title="/NICKUNLOCK <nick>" value="
647 Allows a previously locked user to change nicks again.
650 <helpop key="chghost" title="/CHGHOST <nick> <host>" value="
651 Changes the host of the user to the specified host.
654 <helpop key="chgname" title="/CHGNAME <nick> :<realname>" value="
655 Changes the real name of the user to the specified real name.
658 <helpop key="chgident" title="/CHGIDENT <nick> <ident>" value="
659 Changes the ident of the user to the specified ident.
662 <helpop key="shun" title="/SHUN <nick!user@host> [<duration> :<reason>]" value="
663 Sets or removes a shun (global server-side ignore) on a nick!user@host mask.
664 You must specify all three parameters to add a shun, and one parameter
665 to remove a shun (just the nick!user@host).
667 The duration may be specified in seconds, or in the format
668 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
669 five minutes and six seconds. All fields in this format are optional.
672 <helpop key="die" title="/DIE <servername>" value="
673 This command shuts down the local server. A single parameter is
674 required, which must match the name of the local server.
677 <helpop key="restart" title="/RESTART <servername>" value="
678 This command restarts the local server. A single parameter is
679 required, which must match the name of the local server.
682 <helpop key="commands" title="/COMMANDS" value="
683 Shows all currently available commands.
686 <helpop key="kill" title="/KILL <nick>[,<nick>]+ :<reason>" value="
687 This command will disconnect a user from IRC with the given reason.
690 <helpop key="rehash" title="/REHASH [<servermask>]" value="
691 This command will cause the server configuration file to be reread and
692 values reinitialized for all servers matching the server mask, or the
693 local server if one is not specified.
696 <helpop key="connect" title="/CONNECT <servermask>" value="
697 Add a connection to the server matching the given server mask. You must
698 have configured the server for linking in your configuration file
699 before trying to link them.
702 <helpop key="squit" title="/SQUIT <servermask>" value="
703 Disconnects the server matching the given server mask from this server.
706 <helpop key="modules" title="/MODULES [<servername>]" value="
707 Lists currently loaded modules, their memory offsets, version numbers,
708 and flags. If you are not an operator, you will see reduced detail.
711 <helpop key="loadmodule" title="/LOADMODULE <modulename>" value="
712 Loads the specified module into the local server.
715 <helpop key="unloadmodule" title="/UNLOADMODULE <modulename>" value="
716 Unloads a module from the local server.
719 <helpop key="reloadmodule" title="/RELOADMODULE <modulename>" value="
720 Unloads and reloads a module on the local server.
723 <helpop key="gloadmodule" title="/GLOADMODULE <modulename> [<servermask>]" value="
724 Loads the specified module on all linked servers.
727 <helpop key="gunloadmodule" title="/GUNLOADMODULE <modulename> [<servermask>]" value="
728 Unloads a module from all linked servers.
731 <helpop key="greloadmodule" title="/GRELOADMODULE <modulename> [<servermask>]" value="
732 Unloads and reloads a module on all linked servers.
735 <helpop key="kline" title="/KLINE <user@host> [<duration> :<reason>]" value="
736 Sets or removes a K-line (local user@host based ban) on a user@host mask.
737 You must specify all three parameters to add a ban, and one parameter
738 to remove a ban (just the user@host).
740 The duration may be specified in seconds, or in the format
741 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
742 five minutes and six seconds. All fields in this format are optional.
745 <helpop key="zline" title="/ZLINE <ipmask> [<duration> :<reason>]" value="
746 Sets or removes a Z-line (global IP based ban) on an IP mask.
747 You must specify all three parameters to add a ban, and one parameter
748 to remove a ban (just the ipmask).
750 The duration may be specified in seconds, or in the format
751 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
752 five minutes and six seconds. All fields in this format are optional.
755 <helpop key="qline" title="/QLINE <nickmask> [<duration> :<reason>]" value="
756 Sets or removes a Q-line (global nick based ban) on a nick mask.
757 You must specify all three parameters to add a ban, and one parameter
758 to remove a ban (just the nickmask).
760 The duration may be specified in seconds, or in the format
761 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
762 five minutes and six seconds. All fields in this format are optional.
765 <helpop key="gline" title="/GLINE <user@host> [<duration> :<reason>]" value="
766 Sets or removes a G-line (global user@host based ban) on a user@host mask.
767 You must specify all three parameters to add a ban, and one
768 parameter to remove a ban (just the user@host).
770 The duration may be specified in seconds, or in the format
771 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
772 five minutes and six seconds. All fields in this format are optional.
775 <helpop key="eline" title="/ELINE <user@host> [<duration> :<reason>]" value="
776 Sets or removes a E-line (global user@host ban exception) on a user@host mask.
777 You must specify at least 3 parameters to add an exception, and one
778 parameter to remove an exception (just the user@host).
780 The duration may be specified in seconds, or in the format
781 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
782 five minutes and six seconds. All fields in this format are optional.
784 This command has a few important limitations. Bans on *@<ip> can only
785 be negated by an E-line on *@<ip>, bans on *@<host> can be negated by
786 E-lines on *@<ip>, or *@<host>, and bans on <ident>@* or <ident>@<host>
787 can be negated by any E-line that matches.
790 <helpop key="wallops" title="/WALLOPS :<message>" value="
791 Sends a message to all +w users.
794 <helpop key="rline" title="/RLINE <regex> [<duration> :<reason>]" value="
795 Sets or removes an R-line (global regex ban) on a n!u@h\srealname mask. You
796 must specify all three parameters to add an R-line, and one parameter
797 to remove an R-line (just the regex).
799 The duration may be specified in seconds, or in the format
800 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
801 five minutes and six seconds. All fields in this format are optional.
804 <helpop key="clearchan" title="/CLEARCHAN <channel> [KILL|KICK|G|Z] [:<reason>]" value="
805 Quits or kicks all non-opers from a channel, optionally G/Z-lines them.
806 Useful for quickly nuking bot channels.
808 The default method, KILL, simply disconnects the victims from the server,
809 while methods G and Z also add G/Z-lines for all the targets.
811 When used, the victims won't see each other getting kicked or quitting.
814 <helpop key="modenotice" title="/MODENOTICE <modeletters> :<message>" value="
815 Sends a notice to all users who have the given mode(s) set.
816 If multiple mode letters are given, the notice is only sent to users
817 who have all of them set.
820 <helpop key="cloak" title="/CLOAK <host>" value="
821 Generate the cloak of a host or IP. This is useful for example when
822 trying to get the cloak of a user from /WHOWAS and they were not
823 using their cloak when they quit.
826 <helpop key="umodes" title="User Modes" value="
827 c Blocks private messages and notices from users who do
828 not share a common channel with you (requires the
830 d Deaf mode. User will not receive any messages or notices
831 from channels they are in (requires the deaf module).
832 g In combination with /ACCEPT, provides for server-side
833 ignore (requires the callerid module).
834 h Marks as 'available for help' in WHOIS (server operators
835 only, requires the helpop module).
836 i Makes invisible to /WHO if the user using /WHO is not in
838 k Prevents the user from being kicked from channels, or
839 having op modes removed from them (services only,
840 requires the servprotect module).
841 o Marks as a server operator.
842 s <mask> Receives server notices specified by <mask>
843 (server operators only).
844 r Marks as a having a registered nickname
845 (requires the services account module).
846 w Receives wallops messages.
847 x Gives a cloaked hostname (requires the cloaking module).
848 z Only allow private messages from TLS (SSL) users (requires
849 the sslmodes module).
850 B Marks as a bot (requires the botmode module).
851 D Privdeaf mode. User will not receive any private messages
852 or notices from users (requires the deaf module).
853 G Censors messages sent to the user based on filters
854 configured for the network (requires the censor module).
855 H Hides an oper's oper status from WHOIS (requires the
857 I Hides a user's entire channel list in WHOIS from
858 non-server operators (requires the hidechans module).
859 L Stops redirections done by the redirect module (requires
860 the redirect module).
861 O Allows server operators to opt-in to overriding
862 restrictions (requires the override module).
863 R Blocks private messages from unregistered users
864 (requires the services account module).
865 S Strips formatting codes out of private messages
866 to the user (requires the stripcolor module).
867 W Receives notifications when a user uses WHOIS on them
868 (server operators only, requires the showwhois module).
871 <helpop key="chmodes" title="Channel Modes" value="
872 v <nickname> Gives voice to <nickname>, allowing them to speak
873 while the channel is +m.
874 h <nickname> Gives halfop status to <nickname> (requires the
875 customprefix module).
876 o <nickname> Gives op status to <nickname>.
877 a <nickname> Gives protected status to <nickname>, preventing
878 them from being kicked (+q only, requires the
879 customprefix module).
880 q <nickname> Gives owner status to <nickname>, preventing them
881 from being kicked (Services or +q only, requires
882 the customprefix module).
884 b <hostmask> Bans <hostmask> from the channel.
885 e <hostmask> Excepts <hostmask> from bans (requires the
886 banexception module).
887 I <hostmask> Excepts <hostmask> from +i, allowing matching
888 users to join while the channel is invite-only
889 (requires the inviteexception module).
891 c Blocks messages that contain formatting codes
892 (requires the blockcolor module).
893 d <time> Blocks messages to a channel from new users
894 until they have been in the channel for <time>
895 seconds (requires the delaymsg module).
896 f [*]<lines>:<sec> Kicks on text flood equal to or above the
897 specified rate. With *, the user is banned
898 (requires the messageflood module).
899 g <mask> Blocks messages matching the given glob mask
900 (requires the chanfilter module).
901 i Makes the channel invite-only.
902 Users can only join if an operator
903 uses /INVITE to invite them.
904 j <joins>:<sec> Limits joins to the specified rate (requires
905 the joinflood module).
906 k <key> Set the channel key (password) to <key>.
907 l <limit> Set the maximum allowed users to <limit>.
908 m Enable moderation. Only users with +v, +h, or +o
910 n Blocks users who are not members of the channel
912 p Make channel private, hiding it in users' whoises
913 and replacing it with * in /LIST.
914 r Marks the channel as registered with Services
915 (requires the services account module).
916 s Make channel secret, hiding it in users' whoises
918 t Prevents users without +h or +o from changing the
920 u Makes the channel an auditorium; normal users only
921 see themselves or themselves and the operators,
922 while operators see all the users (requires the
924 w <flag>:<banmask> Adds basic channel access controls of <flag> to
925 <banmask>, via the +w listmode.
926 For example, +w o:R:Brain will op anyone identified
927 to the account 'Brain' on join.
928 (requires the autoop module)
929 z Blocks non-TLS (SSL) clients from joining the channel
930 (requires the sslmodes module).
932 A Allows anyone to invite users to the channel
933 (normally only chanops can invite, requires
934 the allowinvite module).
935 B Blocks messages with too many capital letters,
936 as determined by the network configuration
937 (requires the blockcaps module).
938 C Blocks any CTCPs to the channel (requires the
940 D Delays join messages from users until they message
941 the channel (requires the delayjoin module).
942 E [~|*]<lines>:<sec>[:<difference>][:<backlog>] Allows blocking of
943 similar messages (requires the repeat module).
944 Kicks as default, blocks with ~ and bans with *
945 The last two parameters are optional.
946 F <changes>:<sec> Blocks nick changes when they equal or exceed the
947 specified rate (requires the nickflood module).
948 G Censors messages to the channel based on the
949 network configuration (requires the censor module).
950 H <num>:<duration> Displays the last <num> lines of chat to joining
951 users. <duration> is the maximum time to keep
952 lines in the history buffer (requires the
954 J <seconds> Prevents rejoin after kick for the specified
955 number of seconds. This prevents auto-rejoin
956 (requires the kicknorejoin module).
957 K Blocks /KNOCK on the channel (requires the
959 L <channel> If the channel reaches its limit set by +l,
960 redirect users to <channel> (requires the
962 M Blocks unregistered users from speaking (requires
963 the services account module).
964 N Prevents users on the channel from changing nick
965 (requires the nonicks module).
966 O Channel is server operators only (can only be set
967 by server operators, requires the operchans module).
968 P Makes the channel permanent; Bans, invites, the
969 topic, modes, and such will not be lost when it
970 empties (can only be set by server operators,
971 requires the permchannels module).
972 Q Only U-lined servers and their users can kick
973 (requires the nokicks module).
974 R Blocks unregistered users from joining (requires
975 the services account module).
976 S Strips formatting codes from messages to the
977 channel (requires the stripcolor module).
978 T Blocks /NOTICEs to the channel from users who are
979 not at least halfop (requires the nonotice module).
980 X <type>:<status> Makes users of <status> or higher exempt to the
981 specified restriction <type>. For example: flood:h
982 (requires the exemptchanops module).
983 Possible restriction types to exempt with +X are:
985 anticaps Channel mode +B
986 auditorium-see Permission required to see the full user list of
987 a +u channel (requires the auditorium module).
988 auditorium-vis Permission required to be visible in a +u channel
989 (requires the auditorium module).
990 blockcaps Channel mode +B
991 blockcolor Channel mode +c
992 censor Channel mode +G
993 filter Channel mode +g
994 flood Channel mode +f
995 nickflood Channel mode +F
996 noctcp Channel mode +C
997 nonick Channel mode +N
998 nonotice Channel mode +T
999 regmoderated Channel mode +M
1000 repeat Channel mode +E
1001 stripcolor Channel mode +S
1002 topiclock Channel mode +t
1004 NOTE: A large number of these modes are dependent upon server-side modules
1005 being loaded by a server/network administrator. The actual modes available
1006 on your network may be very different to this list. Please consult your
1007 help channel if you have any questions.
1010 <helpop key="stats" title="/STATS <symbol> [<servername>]" value="
1011 Shows various server statistics. Depending on configuration, some
1012 symbols may be only available to opers.
1016 e Show E-lines (global user@host ban exceptions)
1017 g Show G-lines (global user@host bans)
1018 k Show K-lines (local user@host bans)
1019 q Show Q-lines (global nick bans)
1020 R Show R-lines (global regular expression bans)
1021 Z Show Z-lines (global IP mask bans)
1023 s Show filters (global)
1024 C Show channel bans (global)
1025 H Show shuns (global)
1028 d Show configured DNSBLs and related statistics
1029 m Show command statistics, number of times commands have been used
1030 o Show a list of all valid oper usernames and hostmasks
1031 p Show open client ports, and the port type (ssl, plaintext, etc)
1032 u Show server uptime
1033 z Show memory usage statistics
1034 i Show connect class permissions
1035 l Show all client connections with information (sendq, commands, bytes, time connected)
1036 L Show all client connections with information and IP address
1037 P Show online opers and their idle times
1038 T Show bandwidth/socket statistics
1039 U Show U-lined servers
1040 Y Show connection classes
1041 O Show opertypes and the allowed user and channel modes it can set
1042 E Show socket engine events
1043 S Show currently held registered nicknames
1044 G Show how many local users are connected from each country
1046 Note that all /STATS use is broadcast to online server operators.
1049 <helpop key="snomasks" title="Server Notice Masks" value="
1050 a Allows receipt of local announcement messages.
1051 A Allows receipt of remote announcement messages.
1052 c Allows receipt of local connect messages.
1053 C Allows receipt of remote connect messages.
1054 d Allows receipt of local DNSBL messages (requires the dnsbl module).
1055 D Allows receipt of remote DNSBL messages (requires the dnsbl module).
1056 f Allows receipt of local filter messages (requires the filter module).
1057 F Allows receipt of remote filter messages (requires the filter module).
1058 g Allows receipt of globops (requires the globops module).
1059 j Allows receipt of channel creation notices (requires the chancreate module).
1060 J Allows receipt of remote channel creation notices (requires the chancreate module).
1061 k Allows receipt of local kill messages.
1062 K Allows receipt of remote kill messages.
1063 l Allows receipt of local linking related messages.
1064 L Allows receipt of remote linking related messages.
1065 n Allows receipt of local nickname changes (requires the seenicks module).
1066 N Allows receipt of remote nickname changes (requires the seenicks modules).
1067 o Allows receipt of oper-up, oper-down, and oper-failure messages.
1068 O Allows receipt of remote oper-up, oper-down, and oper-failure messages.
1069 q Allows receipt of local quit messages.
1070 Q Allows receipt of remote quit messages.
1071 r Allows receipt of local oper commands (requires the operlog module).
1072 R Allows receipt of remote oper commands (requires the operlog module).
1073 t Allows receipt of attempts to use /STATS (local and remote).
1074 v Allows receipt of oper override notices (requires the override module).
1075 x Allows receipt of local X-line notices (G/Z/Q/K/E/R/SHUN/CBan).
1076 X Allows receipt of remote X-line notices (G/Z/Q/K/E/R/SHUN/CBan).
1079 <helpop key="extbans" title="Extended Bans" value="
1080 Extbans are split into two types; matching extbans, which match on
1081 users in additional ways, and acting extbans, which restrict users
1082 in different ways to a standard ban.
1084 To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
1085 instead of a normal nick!user@host mask, to ban or exempt matching
1086 users. Ban exceptions on acting extbans exempt that user from matching
1087 an extban of that type, and from any channel mode corresponding to the
1088 restriction. Matching extbans may also be used for invite exceptions by
1089 setting +I <extban>.
1093 a:<mask> Matches user with both a matching banmask and real name,
1094 where <mask> is in the format nick!user@host+realname
1095 (requires gecosban module).
1096 j:<channel> Matches anyone in the given channel. Does not support
1097 wildcards (requires the channelban module).
1098 n:<class> Matches users in a matching connect class (requires
1099 the classban module).
1100 r:<realname> Matches users with a matching real name (requires the
1102 s:<server> Matches users on a matching server (requires the
1104 z:<certfp> Matches users having the given TLS (SSL) certificate
1105 fingerprint (requires the sslmodes module).
1106 O:<opertype> Matches server operators of a matching type, mostly
1107 useful as an invite exception (requires the
1109 R:<account> Matches users logged into a matching account (requires
1110 the services account module).
1111 U:<banmask> Matches unregistered users matching the given banmask.
1112 (requires the services account module).
1116 c:<banmask> Blocks any messages that contain formatting codes from
1117 matching users (requires the blockcolor module).
1118 m:<banmask> Blocks messages from matching users (requires the muteban
1119 module). Users with +v or above are not affected.
1120 p:<banmask> Blocks part messages from matching users (requires
1121 the nopartmsg module).
1122 A:<banmask> Blocks invites by matching users even when +A is set
1123 (requires the allowinvite module).
1124 B:<banmask> Blocks all capital or nearly all capital messages from
1125 matching users (requires the blockcaps module).
1126 C:<banmask> Blocks CTCPs from matching users (requires the noctcp
1128 N:<banmask> Blocks nick changes from matching users (requires
1129 the nonicks module).
1130 Q:<banmask> Blocks kicks by matching users (requires the nokicks
1132 S:<banmask> Strips formatting codes from messages from matching
1133 users (requires the stripcolor module).
1134 T:<banmask> Blocks notices from matching users (requires the
1137 A ban given to an Acting extban may either be a nick!user@host mask
1138 (unless stated otherwise), matched against users as for a normal ban,
1139 or a Matching extban.
1141 There is an additional special type of extended ban, a redirect ban:
1143 Redirect n!u@h#channel will redirect the banned user to #channel
1144 when they try to join (requires the banredirect module).