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 SERVLIST SETNAME SILENCE
40 SQUERY SSLINFO STATS TBAN TIME TITLE
41 TOPIC UNINVITE USER USERHOST VERSION VHOST
42 WATCH WHO WHOIS WHOWAS
45 <helpop key="squery" title="/SQUERY <target> :<message>" value="
46 Sends a message to the network service specified in <target>.
49 <helpop key="servlist" title="/SERVLIST [<mask>]" value="
50 List network services that are currently connected to the network
51 and visible to you. The optional glob-based mask parameter matches
52 against the network service nickname.
55 <helpop key="sslinfo" title="/SSLINFO <nick>" value="
56 Displays information on the TLS (SSL) connection and certificate of the
60 <helpop key="uninvite" title="/UNINVITE <nick> <channel>" value="
61 Uninvite a user from a channel, same syntax as INVITE.
64 <helpop key="tban" title="/TBAN <channel> <duration> <banmask>" value="
65 Sets a timed ban. The duration of the ban can be specified in the
66 form of 1y2w3d4h5m6s - meaning one year, two weeks, three days,
67 four hours, five minutes and six seconds. All fields in this
68 format are optional. Alternatively, the ban may just be specified
69 as a number of seconds. All timed bans appear in the banlist as
70 normal bans and may be safely removed before their time is up.
73 <helpop key="dccallow" title="/DCCALLOW [(+|-)<nick> [<time>]]|[LIST|HELP]" value="
74 /DCCALLOW - List allowed nicks
75 /DCCALLOW LIST - This also lists allowed nicks
76 /DCCALLOW +<nick> [<duration>] - Add a nick
77 /DCCALLOW -<nick> - Remove a nick
78 /DCCALLOW HELP - Display help
80 Duration is optional, and may be specified in seconds or in the
81 form of 1y2w3d4h5m6s - meaning one year, two weeks, three days,
82 four hours, five minutes and six seconds. All fields in this
86 <helpop key="accept" title="/ACCEPT *|(+|-)<nick>[,(+|-)<nick>]+" value="
87 Manages your accept list. This list is used to determine who can
88 private message you when you have user mode +g set.
90 /ACCEPT * - List accepted nicks
91 /ACCEPT +<nick> - Add a nick
92 /ACCEPT -<nick> - Remove a nick
94 This command accepts multiple nicks like so:
95 /ACCEPT +<nick>,-<nick>,+<nick>
98 <helpop key="cycle" title="/CYCLE <channel> [:<reason>]" value="
99 Cycles a channel (leaving and rejoining), overrides restrictions that
100 would stop a new user joining, such as user limits and channel keys.
103 <helpop key="title" title="/TITLE <username> <password>" value="
104 Authenticate for a WHOIS title line and optionally a vhost using the
105 specified username and password.
108 <helpop key="watch" title="/WATCH C|L|l|S|(+|-)<nick> [(+|-)<nick>]+" value="
109 /WATCH - List watched nicks that are online
110 /WATCH l - List watched nicks that are online
111 /WATCH L - List watched nicks, online and offline
112 /WATCH C - Clear all watched nicks
113 /WATCH S - Show statistics
114 /WATCH +<nick> - Add a nick
115 /WATCH -<nick> - Remove a nick
117 This command accepts multiple nicks like so:
118 /WATCH +<nick> -<nick> +<nick>
121 <helpop key="monitor" title="/MONITOR C|L|S|(+|-) <nick>[,<nick>]+" value="
122 /MONITOR L - List all monitored nicks, not differentiating between
123 online and offline nicks
124 /MONITOR C - Clear all monitored nicks
125 /MONITOR S - List all monitored nicks, indicating which are online
126 and which are offline
127 /MONITOR + <nick> - Add a nick
128 /MONITOR - <nick> - Remove a nick
130 This command accepts multiple nicks like so:
131 /MONITOR + <nick>,<nick>,<nick>
132 /MONITOR - <nick>,<nick>,<nick>
135 <helpop key="vhost" title="/VHOST <username> <password>" value="
136 Authenticate for a vhost using the specified username and password.
139 <helpop key="remove" title="/REMOVE <channel> <nick> [:<reason>]" value="
140 Removes a user from a channel you specify. You must be at least a
141 channel halfoperator to remove a user. A removed user will part with
142 a message stating they were removed from the channel and by whom.
145 <helpop key="rmode" title="/RMODE <channel> <mode> [<pattern>]" value="
146 Removes listmodes from a channel, optionally matching a glob-based pattern.
147 E.g. '/RMODE #channel b m:*' will remove all mute extbans on the channel.
150 <helpop key="fpart" title="/FPART <channel> <nick> [:<reason>]" value="
151 This behaves identically to /REMOVE. /REMOVE is a built-in mIRC command
152 which caused trouble for some users.
155 <helpop key="silence" title="/SILENCE [(+|-)<mask> [CcdiNnPpTtx]]" value="
156 A server-side ignore of the given n!u@h mask. If the optional flags field is
157 specified then it must contain one or more flags which specify what kind of
158 messages should be blocked and how they should be blocked.
160 /SILENCE - Shows a list of silenced masks
161 /SILENCE +<mask> [<flags>] - Add a mask
162 /SILENCE -<mask> - Remove a mask
166 C Matches a CTCP targeted at a user.
167 c Matches a CTCP targeted at a channel.
168 d Default behaviour; equivalent to CciNnPpTt.
169 i Matches an invite to a channel.
170 N Matches a NOTICE targeted at a user.
171 n Matches a NOTICE targeted at a channel.
172 P Matches a PRIVMSG targeted at a user.
173 p Matches a PRIVMSG targeted at a channel.
174 T Matches a TAGMSG targeted at a user.
175 t Matches a TAGMSG targeted at a channel.
176 x Exempt the mask from silence rules.
178 Any combination of flags is valid.
181 <helpop key="knock" title="/KNOCK <channel> :<reason>" value="
182 Sends a notice to a channel indicating you wish to join.
185 <helpop key="user" title="/USER <username> <unused> <unused> :<realname>" value="
186 This command is used by your client to register your
187 IRC session, providing your ident and real name to the
190 You should not use it during an established connection.
193 <helpop key="nick" title="/NICK <newnick>" value="
194 Change your nickname to <newnick>.
197 <helpop key="quit" title="/QUIT [:<message>]" value="
198 Quit from IRC and end your current session.
201 <helpop key="version" title="/VERSION [<servername>]" value="
202 Returns the server's version information.
205 <helpop key="ping" title="/PING <servername> [:<servername>]" value="
206 Ping a server. The server will answer with a PONG.
209 <helpop key="pong" title="/PONG <servername>" value="
210 Your client should send this to answer server PINGs. You
211 should not issue this command manually.
214 <helpop key="admin" title="/ADMIN [<servername>]" value="
215 Shows the administrative information for the given server.
218 <helpop key="privmsg" title="/PRIVMSG <target>[,<target>]+ :<message>" value="
219 Sends a message to a user or channel specified in <target>.
222 <helpop key="notice" title="/NOTICE <target>[,<target>]+ :<message>" value="
223 Sends a notice to a user or channel specified in <target>.
226 <helpop key="join" title="/JOIN <channel>[,<channel>]+ [<key>[,<key>]+]" value="
227 Joins one or more channels you provide the names for.
230 <helpop key="names" title="/NAMES [<channel>[,<channel>]+]" value="
231 Return a list of users on the channel(s) you provide.
234 <helpop key="part" title="/PART <channel>[,<channel>]+ [:<reason>]" value="
235 Leaves one or more channels you specify.
238 <helpop key="kick" title="/KICK <channel> <nick>[,<nick>]+ [:<reason>]" value="
239 Kicks a user from a channel you specify. You must be
240 at least a channel halfoperator to kick a user.
243 <helpop key="mode" title="/MODE <target> [[(+|-)]<modes> [<mode-parameters>]]" value="
244 Change or view modes of <target>.
246 /MODE <target> - Show modes of <target>.
248 /MODE <channel> <list mode char> - List bans, exceptions, etc. set on <channel>.
250 Sets the mode for a channel or a nickname specified in <target>.
251 A user may only set modes upon themselves, and may not set the
252 +o user mode, and a user may only change channel modes of
253 channels where they are at least a halfoperator.
255 For a list of all user and channel modes, enter /HELPOP UMODES or
259 <helpop key="topic" title="/TOPIC <channel> [:<topic>]" value="
260 Sets or retrieves the channel topic. If a channel topic is
261 given in the command and either the channel is not +t, or
262 you are at least a halfoperator, the channel topic will be
263 changed to the new one you provide.
266 <helpop key="who" title="/WHO <pattern> [<flags>][%[<fields>[,<querytype>]]] <pattern>" value="
267 Looks up information about users matching the provided pattern. You can specify
268 a flag specific pattern, a channel name, user hostname, a user server name, a
269 user real name, or a user nickname. Matching users will only be included in the
272 1) The specified pattern is an exact channel name that does not have the
273 private or secret channel modes set and the user does not have the invisible
275 2) The specified pattern is an exact nickname.
276 3) You share one or more common channels with the user.
277 4) The user does not have the invisible user mode set.
278 5) You are a server operator with the users/auspex privilege.
280 If you specify any fields the response returned will be a WHOX response rather
281 than a RFC 1459 WHO response.
286 The following flags use <pattern> to match against the specified user data:
288 A Show users who have an away message matching <pattern>.
289 a Show users who have an account name matching <pattern>.
290 h Show users who have a hostname matching <pattern>. If the 'x' modifier
291 is specified then this will match against the real hostname instead of
292 the display hostname.
293 i Show users who have an IP address matching <pattern>.
294 m Show users who have the modes listed in <pattern>. The pattern
295 should be in the same format as a mode change e.g. +ow-i (server
297 n Show users who have a nickname matching <pattern>.
298 p Show users who are connected to a port in the <pattern> range (server
300 r Show users who have a real name matching <pattern>.
301 s Show users who are on a server with a name matching <pattern>. If the 'x'
302 modifier is specified then this will match against the real server name
303 instead of the masked server name.
304 t Show users who have connected in the last <pattern> seconds.
305 u Show users who have an ident (username) matching <pattern>.
307 The following flags filter users by their status:
309 f Only show users on remote (far) servers.
310 l Only show users on the local server.
311 o Only show server operators.
313 The following flags modify the command output:
315 x Show sensitive data like real user hostnames and, when hideserver is
316 enabled, real server hostnames.
318 You may combine one flag from the first group and multiple from the others in
324 a Include the user's account name in the response.
325 c Include the first common channel name in the response.
326 d Include the user's server distance from you in the response.
327 f Include the user's away status, oper status, and highest channel prefix
329 h Include the user's hostname in the response. If the 'x' flag was
330 specified then this is the real host rather than the display host.
331 i Include the user's IP address in the response.
332 l Include the user's idle time in the response.
333 n Include the user's nickname in the response.
334 o Include the user's channel operator rank level in the response.
335 r Include the user's real name in the response.
336 s Include the user's server name in the response. If the 'x' flag was
337 specified then this is the real server name rather than the masked server
339 t Include the query type in the response.
340 u Include the user's ident in the response.
345 <helpop key="motd" title="/MOTD [<servername>]" value="
346 Show the message of the day for <server>. Messages of the day often
347 contain important server rules and notices and should be read prior
351 <helpop key="oper" title="/OPER <username> <password>" value="
352 Attempts to authenticate as a server operator.
354 Both successful and unsuccessful oper attempts are
355 logged, and sent to online server operators.
358 <helpop key="list" title="/LIST [<pattern>]" value="
359 Creates a list of all existing channels matching the glob pattern
360 <pattern>, e.g. *chat* or bot*.
363 <helpop key="lusers" title="/LUSERS" value="
364 Shows a count of local and remote users, servers and channels.
367 <helpop key="userhost" title="/USERHOST <nick> [<nick>]+" value="
368 Returns the hostname and nickname of a user, and some other
369 miscellaneous information.
372 <helpop key="away" title="/AWAY [:<message>]" value="
373 If a message is given, marks you as being away, otherwise
374 removes your away status and previous message.
377 <helpop key="ison" title="/ISON <nick> [<nick>]+" value="
378 Returns a subset of the nicks you give, showing only those
379 that are currently online.
382 <helpop key="invite" title="/INVITE [<nick> <channel> [<time>]]" value="
383 Invites a user to a channel. If the channel is NOT +A, only
384 channel halfoperators or above can invite people. If +A is set,
385 anyone can invite people to the channel, as long as the person
386 doing the invite is a member of the channel they wish to invite
389 Invited users may override bans, +k, and similar in addition to
390 +i, depending on configuration.
392 If a time is provided, the invite expires after that time and the user
393 can no longer use it to enter the channel. The time can be specified
394 in the form of 1y2w3d4h5m6s - meaning one year, two weeks, three days,
395 four hours, five minutes and six seconds. All fields in this format
396 are optional. Alternatively, the time may just be specified as a number
399 /INVITE without a parameter will list pending invitations for channels
400 you have been invited to.
403 <helpop key="pass" title="/PASS <password>" value="
404 This command is used by your client when setting up
405 your IRC session to submit a server password to the
408 You should not use it during an established connection.
411 <helpop key="whowas" title="/WHOWAS <nick>" value="
412 Returns a list of times the user was seen recently on IRC along with
413 the time they were last seen and their server.
416 <helpop key="links" title="/LINKS" value="
417 Shows all linked servers.
420 <helpop key="map" title="/MAP" value="
421 Shows a graphical representation of all users and servers on the
422 network, and the links between them, as a tree from the perspective
426 <helpop key="whois" title="/WHOIS [<servername>] <nick>[,<nick>]+" value="
427 Returns the WHOIS information of a user, their channels, hostname,
428 etc. If a servername is provided, then a whois is performed from
429 the server where the user is actually located rather than locally,
430 showing idle and signon times.
433 <helpop key="time" title="/TIME [<servername>]" value="
434 Returns the local time of the server, or remote time of another
438 <helpop key="info" title="/INFO [<servername>]" value="
439 Returns information on the developers and supporters who made this
443 <helpop key="setname" title="/SETNAME :<realname>" value="
444 Sets your real name to the specified real name.
448 <helpop key="coper" title="Oper Commands" value="
449 ALLTIME CBAN CHECK CHGHOST CHGIDENT
450 CHGNAME CLEARCHAN CLOAK CLONES CONNECT
451 DIE ELINE FILTER GLINE GLOADMODULE
452 GLOBOPS GRELOADMODULE GUNLOADMODULE KILL KLINE
453 LOADMODULE LOCKSERV MODENOTICE NICKLOCK NICKUNLOCK
454 OJOIN OPERMOTD QLINE RCONNECT REHASH
455 RELOADMODULE RESTART RLINE RSQUIT SAJOIN
456 SAKICK SAMODE SANICK SAPART SAQUIT
457 SATOPIC SETHOST SETIDENT SETIDLE SHUN
458 SQUIT SWHOIS TLINE UNLOADMODULE UNLOCKSERV
462 <helpop key="userip" title="/USERIP <nick> [<nick>]+" value="
463 Returns the IP address and nickname of the given user(s).
466 <helpop key="tline" title="/TLINE <mask>" value="
467 This command returns the number of local and global clients matched,
468 and the percentage of clients matched, plus how they were matched
469 (by IP address or by hostname). Mask should be given as either
470 nick!user@host or user@IP (wildcards and CIDR blocks are accepted).
473 <helpop key="lockserv" title="/LOCKSERV [:<message>]" value="
474 Locks out all new connections notifying connecting users that the
475 service is temporarily closed and to try again later.
478 <helpop key="unlockserv" title="/UNLOCKSERV" value="
479 Opens the server up again for new connections.
482 <helpop key="filter" title="/FILTER <pattern> [<action> <flags> [<duration>] :<reason>]" value="
483 This command will add a global filter when more than one parameter is
484 given, for messages of the types specified by the flags, with the given
485 filter pattern, action, duration (when the action is 'gline', 'zline'
486 or 'shun'), and reason.
488 The filter will take effect when a message of any type specified by
489 the flags and matching the pattern is sent to the server, and
490 perform the specified action.
496 Warn Lets the message through and informs +s server operators
497 of the message and all relevant info
498 Block Blocks message and informs +s server operators of the blocked
499 message and all relevant info
500 Silent Blocks message, but does not notify server operators
502 Gline G-lines the user for the specified duration
503 Zline Z-lines the user for the specified duration
504 Shun Shuns the user for the specified duration (requires the shun module)
509 p Block private and channel messages
510 n Block private and channel notices
511 P Block part messages
512 q Block quit messages
513 o Don't match against opers
514 r Don't match against registered users
515 c Strip all formatting codes from the message before matching
516 * Represents all of the above flags except r
517 - Does nothing, a non-op for when you do not want to specify any
520 The reason for the filter will be used as the reason for the action,
521 unless the action is 'none', and is sent to the user when their text is
522 blocked by 'block' and 'silent' actions.
524 A G-line, Z-line or shun duration may be specified in seconds, or in the
525 format 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5
526 minutes and 6 seconds. All fields in this format are optional.
528 When only one parameter is provided (the filter pattern) the provided
529 filter will be removed. Note that if you remove a
530 configuration-defined filter, it will reappear at next rehash unless
531 it is also removed from the config file.
534 <helpop key="ojoin" title="/OJOIN <channel>" value="
535 Force joins you to the specified channel, and gives you +Y and any other
536 configuration-defined modes on it, preventing you from being kicked.
537 Depending on configuration, may announce that you have joined the
538 channel on official network business.
541 <helpop key="clones" title="/CLONES <limit>" value="
542 Retrieves a list of users with more clones than the specified
546 <helpop key="check" title="/CHECK <nick>|<ipmask>|<hostmask>|<channel> [<servername>]" value="
547 Allows opers to look up advanced information on nicknames, IP addresses,
548 hostmasks or channels, in a similar way to WHO but in more detail,
549 displaying most information the server has stored on the target,
550 including all metadata.
552 With the second parameter given, runs the command remotely on the
553 specified server, useful especially if used on a nickname that is
554 online on a remote server.
557 <helpop key="alltime" title="/ALLTIME" value="
558 Shows the date and time of all servers on the network.
561 <helpop key="rconnect" title="/RCONNECT <remote-server-mask> <target-server-mask>" value="
562 The server matching <remote-server-mask> will try to connect to the first
563 server in the config file matching <target-server-mask>.
566 <helpop key="rsquit" title="/RSQUIT <target-server-mask> [:<reason>]" value="
567 Causes a remote server matching <target-server-mask> to be disconnected from
571 <helpop key="globops" title="/GLOBOPS :<message>" value="
572 Sends a message to all users with the +g snomask.
575 <helpop key="cban" title="/CBAN <channel> [<duration> [:<reason>]]" value="
576 Sets or removes a global channel ban. You must specify all three parameters
577 to add a ban, and one parameter to remove a ban (just the channel).
579 The duration may be specified in seconds, or in the format
580 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
581 five minutes and six seconds. All fields in this format are optional.
584 <helpop key="sajoin" title="/SAJOIN [<nick>] <channel>[,<channel>]+" value="
585 Forces the user to join the channel(s).
586 If no nick is given, it joins the oper doing the /SAJOIN.
589 <helpop key="sapart" title="/SAPART <nick> <channel>[,<channel>]+ [:<reason>]" value="
590 Forces the user to part the channel(s), with an optional reason.
593 <helpop key="samode" title="/SAMODE <target> (+|-)<modes> [<mode-parameters>]" value="
594 Applies the given mode change to the channel or nick specified.
597 <helpop key="sanick" title="/SANICK <nick> <newnick>" value="
598 Changes the user's nick to the new nick.
601 <helpop key="sakick" title="/SAKICK <channel> <nick> [:<reason>]" value="
602 Kicks the given user from the specified channel, with an optional reason.
605 <helpop key="satopic" title="/SATOPIC <channel> :<topic>" value="
606 Applies the given topic to the specified channel.
609 <helpop key="saquit" title="/SAQUIT <nick> :<reason>" value="
610 Forces user to quit with the specified reason.
613 <helpop key="setidle" title="/SETIDLE <duration>" value="
614 Sets your idle time to the specified value.
616 The time can be specified in the form of 1y2w3d4h5m6s - meaning one year,
617 two weeks, three days, four hours, five minutes and six seconds.
618 All fields in this format are optional. Alternatively, the time may
619 just be specified as a number of seconds.
622 <helpop key="sethost" title="/SETHOST <host>" value="
623 Sets your host to the specified host.
626 <helpop key="setident" title="/SETIDENT <ident>" value="
627 Sets your ident to the specified ident.
630 <helpop key="swhois" title="/SWHOIS <nick> :<swhois>" value="
631 Sets the user's swhois field to the given swhois message.
632 This will be visible in their /WHOIS.
634 To remove this message again, use:
638 <helpop key="mkpasswd" title="/MKPASSWD <hashtype> <plaintext>" value="
639 Encodes the plaintext to a hash of the given type and displays
643 <helpop key="opermotd" title="/OPERMOTD [<servername>]" value="
644 Displays the Oper MOTD.
647 <helpop key="nicklock" title="/NICKLOCK <nick> <newnick>" value="
648 Changes the user's nick to the new nick, and forces
649 it to remain as such for the remainder of the session.
652 <helpop key="nickunlock" title="/NICKUNLOCK <nick>" value="
653 Allows a previously locked user to change nicks again.
656 <helpop key="chghost" title="/CHGHOST <nick> <host>" value="
657 Changes the host of the user to the specified host.
660 <helpop key="chgname" title="/CHGNAME <nick> :<realname>" value="
661 Changes the real name of the user to the specified real name.
664 <helpop key="chgident" title="/CHGIDENT <nick> <ident>" value="
665 Changes the ident of the user to the specified ident.
668 <helpop key="shun" title="/SHUN <nick!user@host> [<duration> :<reason>]" value="
669 Sets or removes a shun (global server-side ignore) on a nick!user@host mask.
670 You must specify all three parameters to add a shun, and one parameter
671 to remove a shun (just the nick!user@host).
673 The duration may be specified in seconds, or in the format
674 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
675 five minutes and six seconds. All fields in this format are optional.
678 <helpop key="die" title="/DIE <servername>" value="
679 This command shuts down the local server. A single parameter is
680 required, which must match the name of the local server.
683 <helpop key="restart" title="/RESTART <servername>" value="
684 This command restarts the local server. A single parameter is
685 required, which must match the name of the local server.
688 <helpop key="commands" title="/COMMANDS" value="
689 Shows all currently available commands.
692 <helpop key="kill" title="/KILL <nick>[,<nick>]+ :<reason>" value="
693 This command will disconnect a user from IRC with the given reason.
696 <helpop key="rehash" title="/REHASH [<servermask>]" value="
697 This command will cause the server configuration file to be reread and
698 values reinitialized for all servers matching the server mask, or the
699 local server if one is not specified.
702 <helpop key="connect" title="/CONNECT <servermask>" value="
703 Add a connection to the server matching the given server mask. You must
704 have configured the server for linking in your configuration file
705 before trying to link them.
708 <helpop key="squit" title="/SQUIT <servermask>" value="
709 Disconnects the server matching the given server mask from this server.
712 <helpop key="modules" title="/MODULES [<servername>]" value="
713 Lists currently loaded modules, their memory offsets, version numbers,
714 and flags. If you are not an operator, you will see reduced detail.
717 <helpop key="loadmodule" title="/LOADMODULE <modulename>" value="
718 Loads the specified module into the local server.
721 <helpop key="unloadmodule" title="/UNLOADMODULE <modulename>" value="
722 Unloads a module from the local server.
725 <helpop key="reloadmodule" title="/RELOADMODULE <modulename>" value="
726 Unloads and reloads a module on the local server.
729 <helpop key="gloadmodule" title="/GLOADMODULE <modulename> [<servermask>]" value="
730 Loads the specified module on all linked servers.
733 <helpop key="gunloadmodule" title="/GUNLOADMODULE <modulename> [<servermask>]" value="
734 Unloads a module from all linked servers.
737 <helpop key="greloadmodule" title="/GRELOADMODULE <modulename> [<servermask>]" value="
738 Unloads and reloads a module on all linked servers.
741 <helpop key="kline" title="/KLINE <user@host> [<duration> :<reason>]" value="
742 Sets or removes a K-line (local user@host based ban) on a user@host mask.
743 You must specify all three parameters to add a ban, and one parameter
744 to remove a ban (just the user@host).
746 The duration may be specified in seconds, or in the format
747 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
748 five minutes and six seconds. All fields in this format are optional.
751 <helpop key="zline" title="/ZLINE <ipmask> [<duration> :<reason>]" value="
752 Sets or removes a Z-line (global IP based ban) on an IP mask.
753 You must specify all three parameters to add a ban, and one parameter
754 to remove a ban (just the ipmask).
756 The duration may be specified in seconds, or in the format
757 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
758 five minutes and six seconds. All fields in this format are optional.
761 <helpop key="qline" title="/QLINE <nickmask> [<duration> :<reason>]" value="
762 Sets or removes a Q-line (global nick based ban) on a nick mask.
763 You must specify all three parameters to add a ban, and one parameter
764 to remove a ban (just the nickmask).
766 The duration may be specified in seconds, or in the format
767 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
768 five minutes and six seconds. All fields in this format are optional.
771 <helpop key="gline" title="/GLINE <user@host> [<duration> :<reason>]" value="
772 Sets or removes a G-line (global user@host based ban) on a user@host mask.
773 You must specify all three parameters to add a ban, and one
774 parameter to remove a ban (just the user@host).
776 The duration may be specified in seconds, or in the format
777 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
778 five minutes and six seconds. All fields in this format are optional.
781 <helpop key="eline" title="/ELINE <user@host> [<duration> :<reason>]" value="
782 Sets or removes a E-line (global user@host ban exception) on a user@host mask.
783 You must specify at least 3 parameters to add an exception, and one
784 parameter to remove an exception (just the user@host).
786 The duration may be specified in seconds, or in the format
787 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
788 five minutes and six seconds. All fields in this format are optional.
790 This command has a few important limitations. Bans on *@<ip> can only
791 be negated by an E-line on *@<ip>, bans on *@<host> can be negated by
792 E-lines on *@<ip>, or *@<host>, and bans on <ident>@* or <ident>@<host>
793 can be negated by any E-line that matches.
796 <helpop key="wallops" title="/WALLOPS :<message>" value="
797 Sends a message to all +w users.
800 <helpop key="rline" title="/RLINE <regex> [<duration> :<reason>]" value="
801 Sets or removes an R-line (global regex ban) on a n!u@h\srealname mask. You
802 must specify all three parameters to add an R-line, and one parameter
803 to remove an R-line (just the regex).
805 The duration may be specified in seconds, or in the format
806 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
807 five minutes and six seconds. All fields in this format are optional.
810 <helpop key="clearchan" title="/CLEARCHAN <channel> [KILL|KICK|G|Z] [:<reason>]" value="
811 Quits or kicks all non-opers from a channel, optionally G/Z-lines them.
812 Useful for quickly nuking bot channels.
814 The default method, KILL, simply disconnects the victims from the server,
815 while methods G and Z also add G/Z-lines for all the targets.
817 When used, the victims won't see each other getting kicked or quitting.
820 <helpop key="modenotice" title="/MODENOTICE <modeletters> :<message>" value="
821 Sends a notice to all users who have the given mode(s) set.
822 If multiple mode letters are given, the notice is only sent to users
823 who have all of them set.
826 <helpop key="cloak" title="/CLOAK <host>" value="
827 Generate the cloak of a host or IP. This is useful for example when
828 trying to get the cloak of a user from /WHOWAS and they were not
829 using their cloak when they quit.
832 <helpop key="umodes" title="User Modes" value="
833 c Blocks private messages and notices from users who do
834 not share a common channel with you (requires the
836 d Deaf mode. User will not receive any messages or notices
837 from channels they are in (requires the deaf module).
838 g In combination with /ACCEPT, provides for server-side
839 ignore (requires the callerid module).
840 h Marks as 'available for help' in WHOIS (server operators
841 only, requires the helpop module).
842 i Makes invisible to /WHO if the user using /WHO is not in
844 k Prevents the user from being kicked from channels, or
845 having op modes removed from them (services only,
846 requires the servprotect module).
847 o Marks as a server operator.
848 s <mask> Receives server notices specified by <mask>
849 (server operators only).
850 r Marks as a having a registered nickname
851 (requires the services account module).
852 w Receives wallops messages.
853 x Gives a cloaked hostname (requires the cloaking module).
854 z Only allow private messages from TLS (SSL) users (requires
855 the sslmodes module).
856 B Marks as a bot (requires the botmode module).
857 D Privdeaf mode. User will not receive any private messages
858 or notices from users (requires the deaf module).
859 G Censors messages sent to the user based on filters
860 configured for the network (requires the censor module).
861 H Hides an oper's oper status from WHOIS (requires the
863 I Hides a user's entire channel list in WHOIS from
864 non-server operators (requires the hidechans module).
865 L Stops redirections done by the redirect module (requires
866 the redirect module).
867 O Allows server operators to opt-in to overriding
868 restrictions (requires the override module).
869 R Blocks private messages from unregistered users
870 (requires the services account module).
871 S Strips formatting codes out of private messages
872 to the user (requires the stripcolor module).
873 W Receives notifications when a user uses WHOIS on them
874 (server operators only, requires the showwhois module).
877 <helpop key="chmodes" title="Channel Modes" value="
878 v <nickname> Gives voice to <nickname>, allowing them to speak
879 while the channel is +m.
880 h <nickname> Gives halfop status to <nickname> (requires the
881 customprefix module).
882 o <nickname> Gives op status to <nickname>.
883 a <nickname> Gives protected status to <nickname>, preventing
884 them from being kicked (+q only, requires the
885 customprefix module).
886 q <nickname> Gives owner status to <nickname>, preventing them
887 from being kicked (Services or +q only, requires
888 the customprefix module).
890 b <hostmask> Bans <hostmask> from the channel.
891 e <hostmask> Excepts <hostmask> from bans (requires the
892 banexception module).
893 I <hostmask> Excepts <hostmask> from +i, allowing matching
894 users to join while the channel is invite-only
895 (requires the inviteexception module).
897 c Blocks messages that contain formatting codes
898 (requires the blockcolor module).
899 d <time> Blocks messages to a channel from new users
900 until they have been in the channel for <time>
901 seconds (requires the delaymsg module).
902 f [*]<lines>:<sec> Kicks on text flood equal to or above the
903 specified rate. With *, the user is banned
904 (requires the messageflood module).
905 g <mask> Blocks messages matching the given glob mask
906 (requires the chanfilter module).
907 i Makes the channel invite-only.
908 Users can only join if an operator
909 uses /INVITE to invite them.
910 j <joins>:<sec> Limits joins to the specified rate (requires
911 the joinflood module).
912 k <key> Set the channel key (password) to <key>.
913 l <limit> Set the maximum allowed users to <limit>.
914 m Enable moderation. Only users with +v, +h, or +o
916 n Blocks users who are not members of the channel
918 p Make channel private, hiding it in users' whoises
919 and replacing it with * in /LIST.
920 r Marks the channel as registered with Services
921 (requires the services account module).
922 s Make channel secret, hiding it in users' whoises
924 t Prevents users without +h or +o from changing the
926 u Makes the channel an auditorium; normal users only
927 see themselves or themselves and the operators,
928 while operators see all the users (requires the
930 w <flag>:<banmask> Adds basic channel access controls of <flag> to
931 <banmask>, via the +w listmode.
932 For example, +w o:R:Brain will op anyone identified
933 to the account 'Brain' on join.
934 (requires the autoop module)
935 z Blocks non-TLS (SSL) clients from joining the channel
936 (requires the sslmodes module).
938 A Allows anyone to invite users to the channel
939 (normally only chanops can invite, requires
940 the allowinvite module).
941 B Blocks messages with too many capital letters,
942 as determined by the network configuration
943 (requires the blockcaps module).
944 C Blocks any CTCPs to the channel (requires the
946 D Delays join messages from users until they message
947 the channel (requires the delayjoin module).
948 E [~|*]<lines>:<sec>[:<difference>][:<backlog>] Allows blocking of
949 similar messages (requires the repeat module).
950 Kicks as default, blocks with ~ and bans with *
951 The last two parameters are optional.
952 F <changes>:<sec> Blocks nick changes when they equal or exceed the
953 specified rate (requires the nickflood module).
954 G Censors messages to the channel based on the
955 network configuration (requires the censor module).
956 H <num>:<duration> Displays the last <num> lines of chat to joining
957 users. <duration> is the maximum time to keep
958 lines in the history buffer (requires the
960 J <seconds> Prevents rejoin after kick for the specified
961 number of seconds. This prevents auto-rejoin
962 (requires the kicknorejoin module).
963 K Blocks /KNOCK on the channel (requires the
965 L <channel> If the channel reaches its limit set by +l,
966 redirect users to <channel> (requires the
968 M Blocks unregistered users from speaking (requires
969 the services account module).
970 N Prevents users on the channel from changing nick
971 (requires the nonicks module).
972 O Channel is server operators only (can only be set
973 by server operators, requires the operchans module).
974 P Makes the channel permanent; Bans, invites, the
975 topic, modes, and such will not be lost when it
976 empties (can only be set by server operators,
977 requires the permchannels module).
978 Q Only U-lined servers and their users can kick
979 (requires the nokicks module).
980 R Blocks unregistered users from joining (requires
981 the services account module).
982 S Strips formatting codes from messages to the
983 channel (requires the stripcolor module).
984 T Blocks /NOTICEs to the channel from users who are
985 not at least halfop (requires the nonotice module).
986 X <type>:<status> Makes users of <status> or higher exempt to the
987 specified restriction <type>. For example: flood:h
988 (requires the exemptchanops module).
989 Possible restriction types to exempt with +X are:
991 anticaps Channel mode +B
992 auditorium-see Permission required to see the full user list of
993 a +u channel (requires the auditorium module).
994 auditorium-vis Permission required to be visible in a +u channel
995 (requires the auditorium module).
996 blockcaps Channel mode +B
997 blockcolor Channel mode +c
998 censor Channel mode +G
999 filter Channel mode +g
1000 flood Channel mode +f
1001 nickflood Channel mode +F
1002 noctcp Channel mode +C
1003 nonick Channel mode +N
1004 nonotice Channel mode +T
1005 regmoderated Channel mode +M
1006 repeat Channel mode +E
1007 stripcolor Channel mode +S
1008 topiclock Channel mode +t
1010 NOTE: A large number of these modes are dependent upon server-side modules
1011 being loaded by a server/network administrator. The actual modes available
1012 on your network may be very different to this list. Please consult your
1013 help channel if you have any questions.
1016 <helpop key="stats" title="/STATS <symbol> [<servername>]" value="
1017 Shows various server statistics. Depending on configuration, some
1018 symbols may be only available to opers.
1022 e Show E-lines (global user@host ban exceptions)
1023 g Show G-lines (global user@host bans)
1024 k Show K-lines (local user@host bans)
1025 q Show Q-lines (global nick bans)
1026 R Show R-lines (global regular expression bans)
1027 Z Show Z-lines (global IP mask bans)
1029 s Show filters (global)
1030 C Show channel bans (global)
1031 H Show shuns (global)
1034 d Show configured DNSBLs and related statistics
1035 m Show command statistics, number of times commands have been used
1036 o Show a list of all valid oper usernames and hostmasks
1037 p Show open client ports, and the port type (ssl, plaintext, etc)
1038 u Show server uptime
1039 z Show memory usage statistics
1040 i Show connect class permissions
1041 l Show all client connections with information (sendq, commands, bytes, time connected)
1042 L Show all client connections with information and IP address
1043 P Show online opers and their idle times
1044 T Show bandwidth/socket statistics
1045 U Show U-lined servers
1046 Y Show connection classes
1047 O Show opertypes and the allowed user and channel modes it can set
1048 E Show socket engine events
1049 S Show currently held registered nicknames
1050 G Show how many local users are connected from each country
1052 Note that all /STATS use is broadcast to online server operators.
1055 <helpop key="snomasks" title="Server Notice Masks" value="
1056 a Allows receipt of local announcement messages.
1057 A Allows receipt of remote announcement messages.
1058 c Allows receipt of local connect messages.
1059 C Allows receipt of remote connect messages.
1060 d Allows receipt of local DNSBL messages (requires the dnsbl module).
1061 D Allows receipt of remote DNSBL messages (requires the dnsbl module).
1062 f Allows receipt of local filter messages (requires the filter module).
1063 F Allows receipt of remote filter messages (requires the filter module).
1064 g Allows receipt of globops (requires the globops module).
1065 j Allows receipt of channel creation notices (requires the chancreate module).
1066 J Allows receipt of remote channel creation notices (requires the chancreate module).
1067 k Allows receipt of local kill messages.
1068 K Allows receipt of remote kill messages.
1069 l Allows receipt of local linking related messages.
1070 L Allows receipt of remote linking related messages.
1071 n Allows receipt of local nickname changes (requires the seenicks module).
1072 N Allows receipt of remote nickname changes (requires the seenicks modules).
1073 o Allows receipt of oper-up, oper-down, and oper-failure messages.
1074 O Allows receipt of remote oper-up, oper-down, and oper-failure messages.
1075 q Allows receipt of local quit messages.
1076 Q Allows receipt of remote quit messages.
1077 r Allows receipt of local oper commands (requires the operlog module).
1078 R Allows receipt of remote oper commands (requires the operlog module).
1079 t Allows receipt of attempts to use /STATS (local and remote).
1080 v Allows receipt of oper override notices (requires the override module).
1081 x Allows receipt of local X-line notices (G/Z/Q/K/E/R/SHUN/CBan).
1082 X Allows receipt of remote X-line notices (G/Z/Q/K/E/R/SHUN/CBan).
1085 <helpop key="extbans" title="Extended Bans" value="
1086 Extbans are split into two types; matching extbans, which match on
1087 users in additional ways, and acting extbans, which restrict users
1088 in different ways to a standard ban.
1090 To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
1091 instead of a normal nick!user@host mask, to ban or exempt matching
1092 users. Ban exceptions on acting extbans exempt that user from matching
1093 an extban of that type, and from any channel mode corresponding to the
1094 restriction. Matching extbans may also be used for invite exceptions by
1095 setting +I <extban>.
1099 a:<mask> Matches user with both a matching banmask and real name,
1100 where <mask> is in the format nick!user@host+realname
1101 (requires gecosban module).
1102 j:<channel> Matches anyone in the given channel. Does not support
1103 wildcards (requires the channelban module).
1104 n:<class> Matches users in a matching connect class (requires
1105 the classban module).
1106 r:<realname> Matches users with a matching real name (requires the
1108 s:<server> Matches users on a matching server (requires the
1110 z:<certfp> Matches users having the given TLS (SSL) certificate
1111 fingerprint (requires the sslmodes module).
1112 O:<opertype> Matches server operators of a matching type, mostly
1113 useful as an invite exception (requires the
1115 R:<account> Matches users logged into a matching account (requires
1116 the services account module).
1117 U:<banmask> Matches unregistered users matching the given banmask.
1118 (requires the services account module).
1122 c:<banmask> Blocks any messages that contain formatting codes from
1123 matching users (requires the blockcolor module).
1124 m:<banmask> Blocks messages from matching users (requires the muteban
1125 module). Users with +v or above are not affected.
1126 p:<banmask> Blocks part messages from matching users (requires
1127 the nopartmsg module).
1128 A:<banmask> Blocks invites by matching users even when +A is set
1129 (requires the allowinvite module).
1130 B:<banmask> Blocks all capital or nearly all capital messages from
1131 matching users (requires the blockcaps module).
1132 C:<banmask> Blocks CTCPs from matching users (requires the noctcp
1134 N:<banmask> Blocks nick changes from matching users (requires
1135 the nonicks module).
1136 Q:<banmask> Blocks kicks by matching users (requires the nokicks
1138 S:<banmask> Strips formatting codes from messages from matching
1139 users (requires the stripcolor module).
1140 T:<banmask> Blocks notices from matching users (requires the
1143 A ban given to an Acting extban may either be a nick!user@host mask
1144 (unless stated otherwise), matched against users as for a normal ban,
1145 or a Matching extban.
1147 There is an additional special type of extended ban, a redirect ban:
1149 Redirect n!u@h#channel will redirect the banned user to #channel
1150 when they try to join (requires the banredirect module).