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 HEXIP INFO INVITE ISON JOIN
36 KICK KNOCK LINKS LIST LUSERS MAP
37 MKPASSWD MODE MODULES MONITOR MOTD NAMES
38 NICK NOTICE OPER PART PASS PING
39 PONG PRIVMSG QUIT REMOVE SERVLIST SETNAME
40 SILENCE SQUERY SSLINFO STATS TBAN TIME
41 TITLE TOPIC UNINVITE USER USERHOST VERSION
42 VHOST 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="hexip" title="/HEXIP <hex-ip|raw-ip>" value="
156 If the specified argument is a raw IP address then respond with the
157 hex encoded equivalent as if sent by an ident gateway. Otherwise, if
158 the specified argument is a hex encoded IP address then respond with
159 the equivalent raw IP address.
162 <helpop key="silence" title="/SILENCE [(+|-)<mask> [CcdiNnPpTtx]]" value="
163 A server-side ignore of the given n!u@h mask. If the optional flags field is
164 specified then it must contain one or more flags which specify what kind of
165 messages should be blocked and how they should be blocked.
167 /SILENCE - Shows a list of silenced masks
168 /SILENCE +<mask> [<flags>] - Add a mask
169 /SILENCE -<mask> - Remove a mask
173 C Matches a CTCP targeted at a user.
174 c Matches a CTCP targeted at a channel.
175 d Default behaviour; equivalent to CciNnPpTt.
176 i Matches an invite to a channel.
177 N Matches a NOTICE targeted at a user.
178 n Matches a NOTICE targeted at a channel.
179 P Matches a PRIVMSG targeted at a user.
180 p Matches a PRIVMSG targeted at a channel.
181 T Matches a TAGMSG targeted at a user.
182 t Matches a TAGMSG targeted at a channel.
183 x Exempt the mask from silence rules.
185 Any combination of flags is valid.
188 <helpop key="knock" title="/KNOCK <channel> :<reason>" value="
189 Sends a notice to a channel indicating you wish to join.
192 <helpop key="user" title="/USER <username> <unused> <unused> :<realname>" value="
193 This command is used by your client to register your
194 IRC session, providing your ident and real name to the
197 You should not use it during an established connection.
200 <helpop key="nick" title="/NICK <newnick>" value="
201 Change your nickname to <newnick>.
204 <helpop key="quit" title="/QUIT [:<message>]" value="
205 Quit from IRC and end your current session.
208 <helpop key="version" title="/VERSION [<servername>]" value="
209 Returns the server's version information.
212 <helpop key="ping" title="/PING <cookie> [<servername>]" value="
213 Ping a server. The server will answer with a PONG.
216 <helpop key="pong" title="/PONG <cookie> [<servername>]" value="
217 Your client should send this to answer server PINGs. You
218 should not issue this command manually.
221 <helpop key="admin" title="/ADMIN [<servername>]" value="
222 Shows the administrative information for the given server.
225 <helpop key="privmsg" title="/PRIVMSG <target>[,<target>]+ :<message>" value="
226 Sends a message to a user or channel specified in <target>.
229 <helpop key="notice" title="/NOTICE <target>[,<target>]+ :<message>" value="
230 Sends a notice to a user or channel specified in <target>.
233 <helpop key="join" title="/JOIN <channel>[,<channel>]+ [<key>[,<key>]+]" value="
234 Joins one or more channels you provide the names for.
237 <helpop key="names" title="/NAMES [<channel>[,<channel>]+]" value="
238 Return a list of users on the channel(s) you provide.
241 <helpop key="part" title="/PART <channel>[,<channel>]+ [:<reason>]" value="
242 Leaves one or more channels you specify.
245 <helpop key="kick" title="/KICK <channel> <nick>[,<nick>]+ [:<reason>]" value="
246 Kicks a user from a channel you specify. You must be
247 at least a channel halfoperator to kick a user.
250 <helpop key="mode" title="/MODE <target> [[(+|-)]<modes> [<mode-parameters>]]" value="
251 Change or view modes of <target>.
253 /MODE <target> - Show modes of <target>.
255 /MODE <channel> <list mode char> - List bans, exceptions, etc. set on <channel>.
257 Sets the mode for a channel or a nickname specified in <target>.
258 A user may only set modes upon themselves, and may not set the
259 +o user mode, and a user may only change channel modes of
260 channels where they are at least a halfoperator.
262 For a list of all user and channel modes, enter /HELPOP UMODES or
266 <helpop key="topic" title="/TOPIC <channel> [:<topic>]" value="
267 Sets or retrieves the channel topic. If a channel topic is
268 given in the command and either the channel is not +t, or
269 you are at least a halfoperator, the channel topic will be
270 changed to the new one you provide.
273 <helpop key="who" title="/WHO <pattern> [<flags>][%[<fields>[,<querytype>]]] <pattern>" value="
274 Looks up information about users matching the provided pattern. You can specify
275 a flag specific pattern, a channel name, user hostname, a user server name, a
276 user real name, or a user nickname. Matching users will only be included in the
279 1) The specified pattern is an exact channel name that does not have the
280 private or secret channel modes set and the user does not have the invisible
282 2) The specified pattern is an exact nickname.
283 3) You share one or more common channels with the user.
284 4) The user does not have the invisible user mode set.
285 5) You are a server operator with the users/auspex privilege.
287 If you specify any fields the response returned will be a WHOX response rather
288 than a RFC 1459 WHO response.
293 The following flags use <pattern> to match against the specified user data:
295 A Show users who have an away message matching <pattern>.
296 a Show users who have an account name matching <pattern>.
297 h Show users who have a hostname matching <pattern>. If the 'x' modifier
298 is specified then this will match against the real hostname instead of
299 the display hostname.
300 i Show users who have an IP address matching <pattern>.
301 m Show users who have the modes listed in <pattern>. The pattern
302 should be in the same format as a mode change e.g. +ow-i (server
304 n Show users who have a nickname matching <pattern>.
305 p Show users who are connected to a port in the <pattern> range (server
307 r Show users who have a real name matching <pattern>.
308 s Show users who are on a server with a name matching <pattern>. If the 'x'
309 modifier is specified then this will match against the real server name
310 instead of the masked server name.
311 t Show users who have connected in the last <pattern> seconds.
312 u Show users who have an ident (username) matching <pattern>.
314 The following flags filter users by their status:
316 f Only show users on remote (far) servers.
317 l Only show users on the local server.
318 o Only show server operators.
320 The following flags modify the command output:
322 x Show sensitive data like real user hostnames and, when hideserver is
323 enabled, real server hostnames.
325 You may combine one flag from the first group and multiple from the others in
331 a Include the user's account name in the response.
332 c Include the first common channel name in the response.
333 d Include the user's server distance from you in the response.
334 f Include the user's away status, oper status, and highest channel prefix
336 h Include the user's hostname in the response. If the 'x' flag was
337 specified then this is the real host rather than the display host.
338 i Include the user's IP address in the response.
339 l Include the user's idle time in the response.
340 n Include the user's nickname in the response.
341 o Include the user's channel operator rank level in the response.
342 r Include the user's real name in the response.
343 s Include the user's server name in the response. If the 'x' flag was
344 specified then this is the real server name rather than the masked server
346 t Include the query type in the response.
347 u Include the user's ident in the response.
352 <helpop key="motd" title="/MOTD [<servername>]" value="
353 Show the message of the day for <server>. Messages of the day often
354 contain important server rules and notices and should be read prior
358 <helpop key="oper" title="/OPER <username> <password>" value="
359 Attempts to authenticate as a server operator.
361 Both successful and unsuccessful oper attempts are
362 logged, and sent to online server operators.
365 <helpop key="list" title="/LIST [<pattern>]" value="
366 Creates a list of all existing channels matching the glob pattern
367 <pattern>, e.g. *chat* or bot*.
370 <helpop key="lusers" title="/LUSERS" value="
371 Shows a count of local and remote users, servers and channels.
374 <helpop key="userhost" title="/USERHOST <nick> [<nick>]+" value="
375 Returns the hostname and nickname of a user, and some other
376 miscellaneous information.
379 <helpop key="away" title="/AWAY [:<message>]" value="
380 If a message is given, marks you as being away, otherwise
381 removes your away status and previous message.
384 <helpop key="ison" title="/ISON <nick> [<nick>]+" value="
385 Returns a subset of the nicks you give, showing only those
386 that are currently online.
389 <helpop key="invite" title="/INVITE [<nick> <channel> [<time>]]" value="
390 Invites a user to a channel. If the channel is NOT +A, only
391 channel halfoperators or above can invite people. If +A is set,
392 anyone can invite people to the channel, as long as the person
393 doing the invite is a member of the channel they wish to invite
396 Invited users may override bans, +k, and similar in addition to
397 +i, depending on configuration.
399 If a time is provided, the invite expires after that time and the user
400 can no longer use it to enter the channel. The time can be specified
401 in the form of 1y2w3d4h5m6s - meaning one year, two weeks, three days,
402 four hours, five minutes and six seconds. All fields in this format
403 are optional. Alternatively, the time may just be specified as a number
406 /INVITE without a parameter will list pending invitations for channels
407 you have been invited to.
410 <helpop key="pass" title="/PASS <password>" value="
411 This command is used by your client when setting up
412 your IRC session to submit a server password to the
415 You should not use it during an established connection.
418 <helpop key="whowas" title="/WHOWAS <nick>" value="
419 Returns a list of times the user was seen recently on IRC along with
420 the time they were last seen and their server.
423 <helpop key="links" title="/LINKS" value="
424 Shows all linked servers.
427 <helpop key="map" title="/MAP" value="
428 Shows a graphical representation of all users and servers on the
429 network, and the links between them, as a tree from the perspective
433 <helpop key="whois" title="/WHOIS [<servername>] <nick>[,<nick>]+" value="
434 Returns the WHOIS information of a user, their channels, hostname,
435 etc. If a servername is provided, then a whois is performed from
436 the server where the user is actually located rather than locally,
437 showing idle and signon times.
440 <helpop key="time" title="/TIME [<servername>]" value="
441 Returns the local time of the server, or remote time of another
445 <helpop key="info" title="/INFO [<servername>]" value="
446 Returns information on the developers and supporters who made this
450 <helpop key="setname" title="/SETNAME :<realname>" value="
451 Sets your real name to the specified real name.
455 <helpop key="coper" title="Oper Commands" value="
456 ALLTIME CBAN CHECK CHGHOST CHGIDENT
457 CHGNAME CLEARCHAN CLOAK CLONES CONNECT
458 DIE ELINE FILTER GLINE GLOADMODULE
459 GLOBOPS GRELOADMODULE GUNLOADMODULE KILL KLINE
460 LOADMODULE LOCKSERV MODENOTICE NICKLOCK NICKUNLOCK
461 OJOIN OPERMOTD QLINE RCONNECT REHASH
462 RELOADMODULE RESTART RLINE RSQUIT SAJOIN
463 SAKICK SAMODE SANICK SAPART SAQUIT
464 SATOPIC SETHOST SETIDENT SETIDLE SHUN
465 SQUIT SWHOIS TLINE UNLOADMODULE UNLOCKSERV
469 <helpop key="userip" title="/USERIP <nick> [<nick>]+" value="
470 Returns the IP address and nickname of the given user(s).
473 <helpop key="tline" title="/TLINE <mask>" value="
474 This command returns the number of local and global clients matched,
475 and the percentage of clients matched, plus how they were matched
476 (by IP address or by hostname). Mask should be given as either
477 nick!user@host or user@IP (wildcards and CIDR blocks are accepted).
480 <helpop key="lockserv" title="/LOCKSERV [:<message>]" value="
481 Locks out all new connections notifying connecting users that the
482 service is temporarily closed and to try again later.
485 <helpop key="unlockserv" title="/UNLOCKSERV" value="
486 Opens the server up again for new connections.
489 <helpop key="filter" title="/FILTER <pattern> [<action> <flags> [<duration>] :<reason>]" value="
490 This command will add a global filter when more than one parameter is
491 given, for messages of the types specified by the flags, with the given
492 filter pattern, action, duration (when the action is 'gline', 'zline'
493 or 'shun'), and reason.
495 The filter will take effect when a message of any type specified by
496 the flags and matching the pattern is sent to the server, and
497 perform the specified action.
503 Warn Lets the message through and informs +s server operators
504 of the message and all relevant info
505 Block Blocks message and informs +s server operators of the blocked
506 message and all relevant info
507 Silent Blocks message, but does not notify server operators
509 Gline G-lines the user for the specified duration
510 Zline Z-lines the user for the specified duration
511 Shun Shuns the user for the specified duration (requires the shun module)
516 p Block private and channel messages
517 n Block private and channel notices
518 P Block part messages
519 q Block quit messages
520 o Don't match against opers
521 r Don't match against registered users
522 c Strip all formatting codes from the message before matching
523 * Represents all of the above flags except r
524 - Does nothing, a non-op for when you do not want to specify any
527 The reason for the filter will be used as the reason for the action,
528 unless the action is 'none', and is sent to the user when their text is
529 blocked by 'block' and 'silent' actions.
531 A G-line, Z-line or shun duration may be specified in seconds, or in the
532 format 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5
533 minutes and 6 seconds. All fields in this format are optional.
535 When only one parameter is provided (the filter pattern) the provided
536 filter will be removed. Note that if you remove a
537 configuration-defined filter, it will reappear at next rehash unless
538 it is also removed from the config file.
541 <helpop key="ojoin" title="/OJOIN <channel>" value="
542 Force joins you to the specified channel, and gives you +Y and any other
543 configuration-defined modes on it, preventing you from being kicked.
544 Depending on configuration, may announce that you have joined the
545 channel on official network business.
548 <helpop key="clones" title="/CLONES <limit>" value="
549 Retrieves a list of users with more clones than the specified
553 <helpop key="check" title="/CHECK <nick>|<ipmask>|<hostmask>|<channel> [<servername>]" value="
554 Allows opers to look up advanced information on nicknames, IP addresses,
555 hostmasks or channels, in a similar way to WHO but in more detail,
556 displaying most information the server has stored on the target,
557 including all metadata.
559 With the second parameter given, runs the command remotely on the
560 specified server, useful especially if used on a nickname that is
561 online on a remote server.
564 <helpop key="alltime" title="/ALLTIME" value="
565 Shows the date and time of all servers on the network.
568 <helpop key="rconnect" title="/RCONNECT <remote-server-mask> <target-server-mask>" value="
569 The server matching <remote-server-mask> will try to connect to the first
570 server in the config file matching <target-server-mask>.
573 <helpop key="rsquit" title="/RSQUIT <target-server-mask> [:<reason>]" value="
574 Causes a remote server matching <target-server-mask> to be disconnected from
578 <helpop key="globops" title="/GLOBOPS :<message>" value="
579 Sends a message to all users with the +g snomask.
582 <helpop key="cban" title="/CBAN <channelmask> [<duration> [:<reason>]]" value="
583 Sets or removes a global channel based ban. You must specify all three parameters
584 to add a ban, and one parameter to remove a ban (just the channelmask).
586 The duration may be specified in seconds, or in the format
587 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
588 five minutes and six seconds. All fields in this format are optional.
591 <helpop key="sajoin" title="/SAJOIN [<nick>] <channel>[,<channel>]+" value="
592 Forces the user to join the channel(s).
593 If no nick is given, it joins the oper doing the /SAJOIN.
596 <helpop key="sapart" title="/SAPART <nick> <channel>[,<channel>]+ [:<reason>]" value="
597 Forces the user to part the channel(s), with an optional reason.
600 <helpop key="samode" title="/SAMODE <target> (+|-)<modes> [<mode-parameters>]" value="
601 Applies the given mode change to the channel or nick specified.
604 <helpop key="sanick" title="/SANICK <nick> <newnick>" value="
605 Changes the user's nick to the new nick.
608 <helpop key="sakick" title="/SAKICK <channel> <nick> [:<reason>]" value="
609 Kicks the given user from the specified channel, with an optional reason.
612 <helpop key="satopic" title="/SATOPIC <channel> :<topic>" value="
613 Applies the given topic to the specified channel.
616 <helpop key="saquit" title="/SAQUIT <nick> :<reason>" value="
617 Forces user to quit with the specified reason.
620 <helpop key="setidle" title="/SETIDLE <duration>" value="
621 Sets your idle time to the specified value.
623 The time can be specified in the form of 1y2w3d4h5m6s - meaning one year,
624 two weeks, three days, four hours, five minutes and six seconds.
625 All fields in this format are optional. Alternatively, the time may
626 just be specified as a number of seconds.
629 <helpop key="sethost" title="/SETHOST <host>" value="
630 Sets your host to the specified host.
633 <helpop key="setident" title="/SETIDENT <ident>" value="
634 Sets your ident to the specified ident.
637 <helpop key="swhois" title="/SWHOIS <nick> :<swhois>" value="
638 Sets the user's swhois field to the given swhois message.
639 This will be visible in their /WHOIS.
641 To remove this message again, use:
645 <helpop key="mkpasswd" title="/MKPASSWD <hashtype> <plaintext>" value="
646 Encodes the plaintext to a hash of the given type and displays
650 <helpop key="opermotd" title="/OPERMOTD [<servername>]" value="
651 Displays the Oper MOTD.
654 <helpop key="nicklock" title="/NICKLOCK <nick> <newnick>" value="
655 Changes the user's nick to the new nick, and forces
656 it to remain as such for the remainder of the session.
659 <helpop key="nickunlock" title="/NICKUNLOCK <nick>" value="
660 Allows a previously locked user to change nicks again.
663 <helpop key="chghost" title="/CHGHOST <nick> <host>" value="
664 Changes the host of the user to the specified host.
667 <helpop key="chgname" title="/CHGNAME <nick> :<realname>" value="
668 Changes the real name of the user to the specified real name.
671 <helpop key="chgident" title="/CHGIDENT <nick> <ident>" value="
672 Changes the ident of the user to the specified ident.
675 <helpop key="shun" title="/SHUN <nick!user@host> [<duration> :<reason>]" value="
676 Sets or removes a shun (global server-side ignore) on a nick!user@host mask.
677 You must specify all three parameters to add a shun, and one parameter
678 to remove a shun (just the nick!user@host).
680 The duration may be specified in seconds, or in the format
681 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
682 five minutes and six seconds. All fields in this format are optional.
685 <helpop key="die" title="/DIE <servername>" value="
686 This command shuts down the local server. A single parameter is
687 required, which must match the name of the local server.
690 <helpop key="restart" title="/RESTART <servername>" value="
691 This command restarts the local server. A single parameter is
692 required, which must match the name of the local server.
695 <helpop key="commands" title="/COMMANDS" value="
696 Shows all currently available commands.
699 <helpop key="kill" title="/KILL <nick>[,<nick>]+ :<reason>" value="
700 This command will disconnect a user from IRC with the given reason.
703 <helpop key="rehash" title="/REHASH [<servermask>]" value="
704 This command will cause the server configuration file to be reread and
705 values reinitialized for all servers matching the server mask, or the
706 local server if one is not specified.
709 <helpop key="connect" title="/CONNECT <servermask>" value="
710 Add a connection to the server matching the given server mask. You must
711 have configured the server for linking in your configuration file
712 before trying to link them.
715 <helpop key="squit" title="/SQUIT <servermask>" value="
716 Disconnects the server matching the given server mask from this server.
719 <helpop key="modules" title="/MODULES [<servername>]" value="
720 Lists currently loaded modules, their memory offsets, version numbers,
721 and flags. If you are not an operator, you will see reduced detail.
724 <helpop key="loadmodule" title="/LOADMODULE <modulename>" value="
725 Loads the specified module into the local server.
728 <helpop key="unloadmodule" title="/UNLOADMODULE <modulename>" value="
729 Unloads a module from the local server.
732 <helpop key="reloadmodule" title="/RELOADMODULE <modulename>" value="
733 Unloads and reloads a module on the local server.
736 <helpop key="gloadmodule" title="/GLOADMODULE <modulename> [<servermask>]" value="
737 Loads the specified module on all linked servers.
740 <helpop key="gunloadmodule" title="/GUNLOADMODULE <modulename> [<servermask>]" value="
741 Unloads a module from all linked servers.
744 <helpop key="greloadmodule" title="/GRELOADMODULE <modulename> [<servermask>]" value="
745 Unloads and reloads a module on all linked servers.
748 <helpop key="kline" title="/KLINE <user@host> [<duration> :<reason>]" value="
749 Sets or removes a K-line (local user@host based ban) on a user@host mask.
750 You must specify all three parameters to add a ban, and one parameter
751 to remove a ban (just the user@host).
753 The duration may be specified in seconds, or in the format
754 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
755 five minutes and six seconds. All fields in this format are optional.
758 <helpop key="zline" title="/ZLINE <ipmask> [<duration> :<reason>]" value="
759 Sets or removes a Z-line (global IP based ban) on an IP mask.
760 You must specify all three parameters to add a ban, and one parameter
761 to remove a ban (just the ipmask).
763 The duration may be specified in seconds, or in the format
764 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
765 five minutes and six seconds. All fields in this format are optional.
768 <helpop key="qline" title="/QLINE <nickmask> [<duration> :<reason>]" value="
769 Sets or removes a Q-line (global nick based ban) on a nick mask.
770 You must specify all three parameters to add a ban, and one parameter
771 to remove a ban (just the nickmask).
773 The duration may be specified in seconds, or in the format
774 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
775 five minutes and six seconds. All fields in this format are optional.
778 <helpop key="gline" title="/GLINE <user@host> [<duration> :<reason>]" value="
779 Sets or removes a G-line (global user@host based ban) on a user@host mask.
780 You must specify all three parameters to add a ban, and one
781 parameter to remove a ban (just the user@host).
783 The duration may be specified in seconds, or in the format
784 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
785 five minutes and six seconds. All fields in this format are optional.
788 <helpop key="eline" title="/ELINE <user@host> [<duration> :<reason>]" value="
789 Sets or removes a E-line (global user@host ban exception) on a user@host mask.
790 You must specify at least 3 parameters to add an exception, and one
791 parameter to remove an exception (just the user@host).
793 The duration may be specified in seconds, or in the format
794 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
795 five minutes and six seconds. All fields in this format are optional.
797 This command has a few important limitations. Bans on *@<ip> can only
798 be negated by an E-line on *@<ip>, bans on *@<host> can be negated by
799 E-lines on *@<ip>, or *@<host>, and bans on <ident>@* or <ident>@<host>
800 can be negated by any E-line that matches.
803 <helpop key="wallops" title="/WALLOPS :<message>" value="
804 Sends a message to all +w users.
807 <helpop key="rline" title="/RLINE <regex> [<duration> :<reason>]" value="
808 Sets or removes an R-line (global regex ban) on a n!u@h\srealname mask. You
809 must specify all three parameters to add an R-line, and one parameter
810 to remove an R-line (just the regex).
812 The duration may be specified in seconds, or in the format
813 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
814 five minutes and six seconds. All fields in this format are optional.
817 <helpop key="clearchan" title="/CLEARCHAN <channel> [KILL|KICK|G|Z] [:<reason>]" value="
818 Quits or kicks all non-opers from a channel, optionally G/Z-lines them.
819 Useful for quickly nuking bot channels.
821 The default method, KILL, simply disconnects the victims from the server,
822 while methods G and Z also add G/Z-lines for all the targets.
824 When used, the victims won't see each other getting kicked or quitting.
827 <helpop key="modenotice" title="/MODENOTICE <modeletters> :<message>" value="
828 Sends a notice to all users who have the given mode(s) set.
829 If multiple mode letters are given, the notice is only sent to users
830 who have all of them set.
833 <helpop key="cloak" title="/CLOAK <host>" value="
834 Generate the cloak of a host or IP. This is useful for example when
835 trying to get the cloak of a user from /WHOWAS and they were not
836 using their cloak when they quit.
839 <helpop key="umodes" title="User Modes" value="
840 c Blocks private messages and notices from users who do
841 not share a common channel with you (requires the
843 d Deaf mode. User will not receive any messages or notices
844 from channels they are in (requires the deaf module).
845 g In combination with /ACCEPT, provides for server-side
846 ignore (requires the callerid module).
847 h Marks as 'available for help' in WHOIS (server operators
848 only, requires the helpop module).
849 i Makes invisible to /WHO if the user using /WHO is not in
851 k Prevents the user from being kicked from channels, or
852 having op modes removed from them (services only,
853 requires the servprotect module).
854 o Marks as a server operator.
855 s <mask> Receives server notices specified by <mask>
856 (server operators only).
857 r Marks as a having a registered nickname
858 (requires the services account module).
859 w Receives wallops messages.
860 x Gives a cloaked hostname (requires the cloaking module).
861 z Only allow private messages from TLS (SSL) users (requires
862 the sslmodes module).
863 B Marks as a bot (requires the botmode module).
864 D Privdeaf mode. User will not receive any private messages
865 or notices from users (requires the deaf module).
866 G Censors messages sent to the user based on filters
867 configured for the network (requires the censor module).
868 H Hides an oper's oper status from WHOIS (requires the
870 I Hides a user's entire channel list in WHOIS from
871 non-server operators (requires the hidechans module).
872 L Stops redirections done by the redirect module (requires
873 the redirect module).
874 O Allows server operators to opt-in to overriding
875 restrictions (requires the override module).
876 R Blocks private messages from unregistered users
877 (requires the services account module).
878 S Strips formatting codes out of private messages
879 to the user (requires the stripcolor module).
880 W Receives notifications when a user uses WHOIS on them
881 (server operators only, requires the showwhois module).
884 <helpop key="chmodes" title="Channel Modes" value="
885 v <nickname> Gives voice to <nickname>, allowing them to speak
886 while the channel is +m.
887 h <nickname> Gives halfop status to <nickname> (requires the
888 customprefix module).
889 o <nickname> Gives op status to <nickname>.
890 a <nickname> Gives protected status to <nickname>, preventing
891 them from being kicked (+q only, requires the
892 customprefix module).
893 q <nickname> Gives owner status to <nickname>, preventing them
894 from being kicked (Services or +q only, requires
895 the customprefix module).
897 b <hostmask> Bans <hostmask> from the channel.
898 e <hostmask> Excepts <hostmask> from bans (requires the
899 banexception module).
900 I <hostmask> Excepts <hostmask> from +i, allowing matching
901 users to join while the channel is invite-only
902 (requires the inviteexception module).
904 c Blocks messages that contain formatting codes
905 (requires the blockcolor module).
906 d <time> Blocks messages to a channel from new users
907 until they have been in the channel for <time>
908 seconds (requires the delaymsg module).
909 f [*]<lines>:<sec> Kicks on text flood equal to or above the
910 specified rate. With *, the user is banned
911 (requires the messageflood module).
912 g <mask> Blocks messages matching the given glob mask
913 (requires the chanfilter module).
914 i Makes the channel invite-only.
915 Users can only join if an operator
916 uses /INVITE to invite them.
917 j <joins>:<sec> Limits joins to the specified rate (requires
918 the joinflood module).
919 k <key> Set the channel key (password) to <key>.
920 l <limit> Set the maximum allowed users to <limit>.
921 m Enable moderation. Only users with +v, +h, or +o
923 n Blocks users who are not members of the channel
925 p Hides the channel in /WHOIS from people who are not a member.
926 You probably want the s (secret) channel mode rather than this.
927 r Marks the channel as registered with Services
928 (requires the services account module).
929 s Hides the channel in /WHOIS and /LIST from people who are not a member.
930 t Prevents users without +h or +o from changing the
932 u Makes the channel an auditorium; normal users only
933 see themselves or themselves and the operators,
934 while operators see all the users (requires the
936 w <flag>:<banmask> Adds basic channel access controls of <flag> to
937 <banmask>, via the +w listmode.
938 For example, +w o:R:Brain will op anyone identified
939 to the account 'Brain' on join.
940 (requires the autoop module)
941 z Blocks non-TLS (SSL) clients from joining the channel
942 (requires the sslmodes module).
944 A Allows anyone to invite users to the channel
945 (normally only chanops can invite, requires
946 the allowinvite module).
947 B Blocks messages with too many capital letters,
948 as determined by the network configuration
949 (requires the blockcaps module).
950 C Blocks any CTCPs to the channel (requires the
952 D Delays join messages from users until they message
953 the channel (requires the delayjoin module).
954 E [~|*]<lines>:<sec>[:<difference>][:<backlog>] Allows blocking of
955 similar messages (requires the repeat module).
956 Kicks as default, blocks with ~ and bans with *
957 The last two parameters are optional.
958 F <changes>:<sec> Blocks nick changes when they equal or exceed the
959 specified rate (requires the nickflood module).
960 G Censors messages to the channel based on the
961 network configuration (requires the censor module).
962 H <num>:<duration> Displays the last <num> lines of chat to joining
963 users. <duration> is the maximum time to keep
964 lines in the history buffer (requires the
966 J <seconds> Prevents rejoin after kick for the specified
967 number of seconds. This prevents auto-rejoin
968 (requires the kicknorejoin module).
969 K Blocks /KNOCK on the channel (requires the
971 L <channel> If the channel reaches its limit set by +l,
972 redirect users to <channel> (requires the
974 M Blocks unregistered users from speaking (requires
975 the services account module).
976 N Prevents users on the channel from changing nick
977 (requires the nonicks module).
978 O Channel is server operators only (can only be set
979 by server operators, requires the operchans module).
980 P Makes the channel permanent; Bans, invites, the
981 topic, modes, and such will not be lost when it
982 empties (can only be set by server operators,
983 requires the permchannels module).
984 Q Only U-lined servers and their users can kick
985 (requires the nokicks module).
986 R Blocks unregistered users from joining (requires
987 the services account module).
988 S Strips formatting codes from messages to the
989 channel (requires the stripcolor module).
990 T Blocks /NOTICEs to the channel from users who are
991 not at least halfop (requires the nonotice module).
992 X <type>:<status> Makes users of <status> or higher exempt to the
993 specified restriction <type>. For example: flood:h
994 (requires the exemptchanops module).
995 Possible restriction types to exempt with +X are:
997 anticaps Channel mode +B
998 auditorium-see Permission required to see the full user list of
999 a +u channel (requires the auditorium module).
1000 auditorium-vis Permission required to be visible in a +u channel
1001 (requires the auditorium module).
1002 blockcaps Channel mode +B
1003 blockcolor Channel mode +c
1004 censor Channel mode +G
1005 filter Channel mode +g
1006 flood Channel mode +f
1007 nickflood Channel mode +F
1008 noctcp Channel mode +C
1009 nonick Channel mode +N
1010 nonotice Channel mode +T
1011 regmoderated Channel mode +M
1012 repeat Channel mode +E
1013 stripcolor Channel mode +S
1014 topiclock Channel mode +t
1016 NOTE: A large number of these modes are dependent upon server-side modules
1017 being loaded by a server/network administrator. The actual modes available
1018 on your network may be very different to this list. Please consult your
1019 help channel if you have any questions.
1022 <helpop key="stats" title="/STATS <symbol> [<servername>]" value="
1023 Shows various server statistics. Depending on configuration, some
1024 symbols may be only available to opers.
1028 e Show E-lines (global user@host ban exceptions)
1029 g Show G-lines (global user@host bans)
1030 k Show K-lines (local user@host bans)
1031 q Show Q-lines (global nick bans)
1032 R Show R-lines (global regular expression bans)
1033 Z Show Z-lines (global IP mask bans)
1035 s Show filters (global)
1036 C Show channel bans (global)
1037 H Show shuns (global)
1040 d Show configured DNSBLs and related statistics
1041 m Show command statistics, number of times commands have been used
1042 o Show a list of all valid oper usernames and hostmasks
1043 p Show open client ports, and the port type (ssl, plaintext, etc)
1044 u Show server uptime
1045 z Show memory usage statistics
1046 i Show connect class permissions
1047 l Show all client connections with information (sendq, commands, bytes, time connected)
1048 L Show all client connections with information and IP address
1049 P Show online opers and their idle times
1050 T Show bandwidth/socket statistics
1051 U Show U-lined servers
1052 Y Show connection classes
1053 O Show opertypes and the allowed user and channel modes it can set
1054 E Show socket engine events
1055 S Show currently held registered nicknames
1056 G Show how many local users are connected from each country
1058 Note that all /STATS use is broadcast to online server operators.
1061 <helpop key="snomasks" title="Server Notice Masks" value="
1062 a Allows receipt of local announcement messages.
1063 A Allows receipt of remote announcement messages.
1064 c Allows receipt of local connect messages.
1065 C Allows receipt of remote connect messages.
1066 d Allows receipt of local DNSBL messages (requires the dnsbl module).
1067 D Allows receipt of remote DNSBL messages (requires the dnsbl module).
1068 f Allows receipt of local filter messages (requires the filter module).
1069 F Allows receipt of remote filter messages (requires the filter module).
1070 g Allows receipt of globops (requires the globops module).
1071 j Allows receipt of channel creation notices (requires the chancreate module).
1072 J Allows receipt of remote channel creation notices (requires the chancreate module).
1073 k Allows receipt of local kill messages.
1074 K Allows receipt of remote kill messages.
1075 l Allows receipt of local linking related messages.
1076 L Allows receipt of remote linking related messages.
1077 n Allows receipt of local nickname changes (requires the seenicks module).
1078 N Allows receipt of remote nickname changes (requires the seenicks modules).
1079 o Allows receipt of oper-up, oper-down, and oper-failure messages.
1080 O Allows receipt of remote oper-up, oper-down, and oper-failure messages.
1081 q Allows receipt of local quit messages.
1082 Q Allows receipt of remote quit messages.
1083 r Allows receipt of local oper commands (requires the operlog module).
1084 R Allows receipt of remote oper commands (requires the operlog module).
1085 t Allows receipt of attempts to use /STATS (local and remote).
1086 v Allows receipt of oper override notices (requires the override module).
1087 x Allows receipt of local X-line notices (G/Z/Q/K/E/R/SHUN/CBan).
1088 X Allows receipt of remote X-line notices (G/Z/Q/K/E/R/SHUN/CBan).
1091 <helpop key="extbans" title="Extended Bans" value="
1092 Extbans are split into two types; matching extbans, which match on
1093 users in additional ways, and acting extbans, which restrict users
1094 in different ways to a standard ban.
1096 To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
1097 instead of a normal nick!user@host mask, to ban or exempt matching
1098 users. Ban exceptions on acting extbans exempt that user from matching
1099 an extban of that type, and from any channel mode corresponding to the
1100 restriction. Matching extbans may also be used for invite exceptions by
1101 setting +I <extban>.
1105 a:<mask> Matches user with both a matching banmask and real name,
1106 where <mask> is in the format nick!user@host+realname
1107 (requires gecosban module).
1108 j:<channel> Matches anyone in the given channel. Does not support
1109 wildcards (requires the channelban module).
1110 n:<class> Matches users in a matching connect class (requires
1111 the classban module).
1112 r:<realname> Matches users with a matching real name (requires the
1114 s:<server> Matches users on a matching server (requires the
1116 z:<certfp> Matches users having the given TLS (SSL) certificate
1117 fingerprint (requires the sslmodes module).
1118 O:<opertype> Matches server operators of a matching type, mostly
1119 useful as an invite exception (requires the
1121 R:<account> Matches users logged into a matching account (requires
1122 the services account module).
1123 U:<banmask> Matches unregistered users matching the given banmask.
1124 (requires the services account module).
1128 c:<banmask> Blocks any messages that contain formatting codes from
1129 matching users (requires the blockcolor module).
1130 m:<banmask> Blocks messages from matching users (requires the muteban
1131 module). Users with +v or above are not affected.
1132 p:<banmask> Blocks part messages from matching users (requires
1133 the nopartmsg module).
1134 A:<banmask> Blocks invites by matching users even when +A is set
1135 (requires the allowinvite module).
1136 B:<banmask> Blocks all capital or nearly all capital messages from
1137 matching users (requires the blockcaps module).
1138 C:<banmask> Blocks CTCPs from matching users (requires the noctcp
1140 N:<banmask> Blocks nick changes from matching users (requires
1141 the nonicks module).
1142 Q:<banmask> Blocks kicks by matching users (requires the nokicks
1144 S:<banmask> Strips formatting codes from messages from matching
1145 users (requires the stripcolor module).
1146 T:<banmask> Blocks notices from matching users (requires the
1149 A ban given to an Acting extban may either be a nick!user@host mask
1150 (unless stated otherwise), matched against users as for a normal ban,
1151 or a Matching extban.
1153 There is an additional special type of extended ban, a redirect ban:
1155 Redirect n!u@h#channel will redirect the banned user to #channel
1156 when they try to join (requires the banredirect module).