1 # Sample configuration file for the helpop module.
2 # You can either copy this into your conf folder and set up the module to use it,
3 # or you can customize the responses for your network and/or add more.
5 # The way the new helpop system works is simple. You use one or more helpop tags.
6 # <helpop key="moo" value="something here">
7 # key is what the user is looking for (i.e. /helpop moo), and value is what they get back
8 # (note that it can span multiple lines!).
14 <alias text="HELP" replace="HELPOP $2-">
16 <helpmsg nohelp="There is no help for the topic you searched for. Please try again.">
18 <helpop key="start" value="InspIRCd Help System
20 This system provides help for commands and modes.
21 Specify your question or a command name as the
22 parameter for this command.
24 /HELPOP CUSER - To see a list of user commands
25 /HELPOP COPER - To see a list of oper commands
26 /HELPOP UMODES - To see a list of user modes
27 /HELPOP CHMODES - To see a list of channel modes
28 /HELPOP SNOMASKS - To see a list of oper snotice masks
29 /HELPOP EXTBANS - To see a list of extended bans">
31 <helpop key="cuser" value="User Commands
34 ACCEPT ADMIN AWAY COMMANDS CYCLE DCCALLOW
35 FPART INFO INVITE ISON JOIN KICK
36 KNOCK LINKS LIST LUSERS MAP MKPASSWD
37 MODE MODULES 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
44 <helpop key="squery" value="/SQUERY <target> :<message>
46 Sends a message to the network service specified in <target>.">
48 <helpop key="sslinfo" value="/SSLINFO <nick>
50 Displays information on the SSL connection and certificate of the
53 <helpop key="uninvite" value="/UNINVITE <nick> <channel>
55 Uninvite a user from a channel, same syntax as INVITE.">
57 <helpop key="tban" value="/TBAN <channel> <duration> <banmask>
59 Sets a timed ban. The duration of the ban can be specified in the
60 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.">
66 <helpop key="dccallow" value="/DCCALLOW [(+|-)<nick> [<time>]]|[LIST|HELP]
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
77 format are optional.">
79 <helpop key="accept" value="/ACCEPT *|(+|-)<nick>[,(+|-)<nick>]+
81 Manages your accept list. This list is used to determine who can
82 private message you when you have usermode +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>">
91 <helpop key="cycle" value="/CYCLE <channel> [:<reason>]
93 Cycles a channel (leaving and rejoining), overrides restrictions that
94 would stop a new user joining, such as user limits and channel keys.">
96 <helpop key="title" value="/TITLE <username> <password>
98 Authenticate for a WHOIS title line and optionally a vhost using the
99 specified username and password.">
101 <helpop key="watch" value="/WATCH C|L|l|S|(+|-)<nick> [(+|-)<nick>]+
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>">
114 <helpop key="monitor" value="/MONITOR C|L|S|(+|-) <nick>[,<nick>]+
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>">
128 <helpop key="vhost" value="/VHOST <username> <password>
130 Authenticate for a vhost using the specified username and password.">
132 <helpop key="remove" value="/REMOVE <channel> <nick> [:<reason>]
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.">
138 <helpop key="rmode" value="/RMODE <channel> <mode> [<pattern>]
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.">
143 <helpop key="fpart" value="/FPART <channel> <nick> [:<reason>]
145 This behaves identically to /REMOVE. /REMOVE is a built-in mIRC command
146 which caused trouble for some users.">
148 <helpop key="silence" value="/SILENCE [(+|-)<mask> [p|c|i|n|t|a|x]]
150 A server-side ignore of the given n!u@h mask. The flags at the end
151 are optional, and specify what is to be ignored from this mask.
153 /SILENCE - Shows a list of silenced masks
154 /SILENCE +<mask> [<flags>] - Add a mask
155 /SILENCE -<mask> - Remove a mask
160 p Block private messages
161 c Block channel messages
163 n Block private notices
164 t Block channel notices
165 a Block all of the above
168 Multiple flags may be specified. For an exception, you must pair x
169 with what you want excepted. For example, if you wanted to except
170 everything from people with a host matching *.foo.net, you would do
171 /SILENCE +*!*@*.foo.net xa
173 If no flags are specified, it will default to blocking private messages
174 and private notices (pn).
176 /SILENCE without a parameter will list the masks that you have silenced.">
178 <helpop key="knock" value="/KNOCK <channel> :<reason>
180 Sends a notice to a channel indicating you wish to join.">
182 <helpop key="user" value="/USER <username> <unused> <unused> :<realname>
184 This command is used by your client to register your
185 IRC session, providing your ident and real name to the
188 You should not use it during an established connection.">
190 <helpop key="nick" value="/NICK <newnick>
192 Change your nickname to <newnick>.">
194 <helpop key="quit" value="/QUIT [:<message>]
196 Quit from IRC and end your current session.">
198 <helpop key="version" value="/VERSION [<servername>]
200 Returns the server's version information.">
202 <helpop key="ping" value="/PING <servername> [:<servername>]
204 Ping a server. The server will answer with a PONG.">
206 <helpop key="pong" value="/PONG <servername>
208 Your client should send this to answer server PINGs. You
209 should not issue this command manually.">
211 <helpop key="admin" value="/ADMIN [<servername>]
213 Shows the administrative information for the given server.">
215 <helpop key="privmsg" value="/PRIVMSG <target>[,<target>]+ :<message>
217 Sends a message to a user or channel specified in <target>.">
219 <helpop key="notice" value="/NOTICE <target>[,<target>]+ :<message>
221 Sends a notice to a user or channel specified in <target>.">
223 <helpop key="join" value="/JOIN <channel>[,<channel>]+ [<key>[,<key>]+]
225 Joins one or more channels you provide the names for.">
227 <helpop key="names" value="/NAMES <channel>[,<channel>]+
229 Return a list of users on the channel(s) you provide.">
231 <helpop key="part" value="/PART <channel>[,<channel>]+ [:<reason>]
233 Leaves one or more channels you specify.">
235 <helpop key="kick" value="/KICK <channel> <nick>[,<nick>]+ [:<reason>]
237 Kicks a user from a channel you specify. You must be
238 at least a channel halfoperator to kick a user.">
240 <helpop key="mode" value="/MODE <target> [[(+|-)]<modes> [<mode-parameters>]]
242 Change or view modes of <target>.
244 /MODE <target> - Show modes of <target>.
246 /MODE <channel> <list mode char> - List bans, exceptions, etc. set on <channel>.
248 Sets the mode for a channel or a nickname specified in <target>.
249 A user may only set modes upon themselves, and may not set the
250 +o usermode, and a user may only change channel modes of
251 channels where they are at least a halfoperator.
253 For a list of all user and channel modes, enter /HELPOP UMODES or
256 <helpop key="topic" value="/TOPIC <channel> [:<topic>]
258 Sets or retrieves the channel topic. If a channel topic is
259 given in the command and either the channel is not +t, or
260 you are at least a halfoperator, the channel topic will be
261 changed to the new one you provide.">
263 <helpop key="who" value="/WHO <pattern> [<flags>][%[<fields>[,<querytype>]]] <pattern>
265 Looks up information about users matching the provided pattern. You can specify
266 a flag specific pattern, a channel name, user hostname, a user server name, a
267 user real name, or a user nickname. Matching users will only be included in the
270 1) The specified pattern is an exact channel name that does not have the
271 private or secret channel modes set and the user does not have the invisible
273 2) The specified pattern is an exact nickname.
274 3) You share one or more common channels with the user.
275 4) The user does not have the invisible user mode set.
276 5) You are a server operator with the users/auspex privilege.
278 If you specify any fields the response returned will be a WHOX response rather
279 than a RFC 1459 WHO response.
284 The following flags use <pattern> to match against the specified user data:
286 A Show users who have an away message matching <pattern>.
287 a Show users who have an account name matching <pattern>.
288 h Show users who have a hostname matching <pattern>. If the 'x' modifier
289 is specified then this will match against the real hostname instead of
290 the display hostname.
291 i Show users who have an IP address matching <pattern>.
292 m Show users who have the modes listed in <pattern>. The pattern
293 should be in the same format as a mode change e.g. +ow-i (server
295 n Show users who have a nickname matching <pattern>.
296 p Show users who are connected to a port in the <pattern> range (server
298 r Show users who have a real name matching <pattern>.
299 s Show users who are on a server with a name matching <pattern>. If the 'x'
300 modifier is specified then this will match against the real server name
301 instead of the masked server name.
302 t Show users who have connected in the last <pattern> seconds.
303 u Show users who have an ident (username) matching <pattern>.
305 The following flags filter users by their status:
307 f Only show users on remote (far) servers.
308 l Only show users on the local server.
309 o Only show server operators.
311 The following flags modify the command output:
313 x Show sensitive data like real user hostnames and, when hideserver is
314 enabled, real server hostnames.
316 You may combine one flag from the first group and multiple from the others in
322 a Include the user's account name in the response.
323 c Include the first common channel name in the response.
324 d Include the user's server distance from you in the response.
325 f Include the user's away status, oper status, and highest channel prefix
327 h Include the user's hostname in the response. If the 'x' flag was
328 specified then this is the real host rather than the display host.
329 i Include the user's IP address in the response.
330 l Include the user's idle time in the response.
331 n Include the user's nickname in the response.
332 o Include the user's channel operator rank level in the response.
333 r Include the user's real name in the response.
334 s Include the user's server name in the response. If the 'x' flag was
335 specified then this is the real server name rather than the masked server
337 t Include the query type in the response.
338 u Include the user's ident in the response.
342 <helpop key="motd" value="/MOTD [<servername>]
344 Show the message of the day for <server>. Messages of the day often
345 contain important server rules and notices and should be read prior
348 <helpop key="oper" value="/OPER <username> <password>
350 Attempts to authenticate a user as an IRC operator.
352 Both successful and unsuccessful oper attempts are
353 logged, and sent to online IRC operators.">
355 <helpop key="list" value="/LIST [<pattern>]
357 Creates a list of all existing channels matching the glob pattern
358 <pattern>, e.g. *chat* or bot*.">
360 <helpop key="lusers" value="/LUSERS
362 Shows a count of local and remote users, servers and channels.">
364 <helpop key="userhost" value="/USERHOST <nick> [<nick>]+
366 Returns the hostname and nickname of a user, and some other
367 miscellaneous information.">
369 <helpop key="away" value="/AWAY [:<message>]
371 If a message is given, marks you as being away, otherwise
372 removes your away status and previous message.">
374 <helpop key="ison" value="/ISON <nick> [<nick>]+
376 Returns a subset of the nicks you give, showing only those
377 that are currently online.">
379 <helpop key="invite" value="/INVITE [<nick> <channel> [<time>]]
381 Invites a user to a channel. If the channel is NOT +A, only
382 channel halfoperators or above can invite people. If +A is set,
383 anyone can invite people to the channel, as long as the person
384 doing the invite is a member of the channel they wish to invite
387 Invited users may override bans, +k, and similar in addition to
388 +i, depending on configuration.
390 If a time is provided, the invite expires after that time and the user
391 can no longer use it to enter the channel. The time can be specified
392 in the form of 1y2w3d4h5m6s - meaning one year, two weeks, three days,
393 four hours, five minutes and six seconds. All fields in this format
394 are optional. Alternatively, the time may just be specified as a number
397 /INVITE without a parameter will list pending invitations for channels
398 you have been invited to.">
400 <helpop key="pass" value="/PASS <password>
402 This command is used by your client when setting up
403 your IRC session to submit a server password to the
406 You should not use it during an established connection.">
408 <helpop key="whowas" value="/WHOWAS <nick>
410 Returns a list of times the user was seen recently on IRC along with
411 the time they were last seen and their server.">
413 <helpop key="links" value="/LINKS
415 Shows all linked servers.">
417 <helpop key="map" value="/MAP
419 Shows a graphical representation of all users and servers on the
420 network, and the links between them, as a tree from the perspective
423 <helpop key="whois" value="/WHOIS [<servername>] <nick>[,<nick>]+
425 Returns the WHOIS information of a user, their channels, hostname,
426 etc. If a servername is provided, then a whois is performed from
427 the server where the user is actually located rather than locally,
428 showing idle and signon times.">
430 <helpop key="time" value="/TIME [<servername>]
432 Returns the local time of the server, or remote time of another
435 <helpop key="info" value="/INFO [<servername>]
437 Returns information on the developers and supporters who made this
438 IRC server possible.">
440 <helpop key="setname" value="/SETNAME :<realname>
442 Sets your real name to the specified real name.">
445 <helpop key="coper" value="Oper Commands
448 ALLTIME CBAN CHECK CHGHOST CHGIDENT
449 CHGNAME CLEARCHAN CLOAK CLONES CONNECT
450 DIE ELINE FILTER GLINE GLOADMODULE
451 GLOBOPS GRELOADMODULE GUNLOADMODULE KILL KLINE
452 LOADMODULE LOCKSERV MODENOTICE NICKLOCK NICKUNLOCK
453 OJOIN OPERMOTD QLINE RCONNECT REHASH
454 RELOADMODULE RESTART RLINE RSQUIT SAJOIN
455 SAKICK SAMODE SANICK SAPART SAQUIT
456 SATOPIC SETHOST SETIDENT SETIDLE SHUN
457 SQUIT SWHOIS TLINE UNLOADMODULE UNLOCKSERV
458 USERIP WALLOPS ZLINE">
460 <helpop key="userip" value="/USERIP <nick> [<nick>]+
462 Returns the IP address and nickname of the given user(s).">
464 <helpop key="tline" value="/TLINE <mask>
466 This command returns the number of local and global clients matched,
467 and the percentage of clients matched, plus how they were matched
468 (by IP address or by hostname). Mask should be given as either a
469 nick!user@host or user@IP (wildcards accepted).">
471 <helpop key="lockserv" value="/LOCKSERV [:<message>]
473 Locks out all new connections notifying connecting users that the
474 service is temporarily closed and to try again later.">
476 <helpop key="unlockserv" value="/UNLOCKSERV
478 Opens the server up again for new connections.">
480 <helpop key="filter" value="/FILTER <pattern> [<action> <flags> [<duration>] :<reason>]
482 This command will add a global filter when more than one parameter is
483 given, for messages of the types specified by the flags, with the given
484 filter pattern, action, duration (when the action is 'gline', 'zline'
485 or 'shun'), and reason.
487 The filter will take effect when a message of any type specified by
488 the flags and matching the pattern is sent to the server, and
489 perform the specified action.
495 Warn Lets the message through and informs +s IRCops of the message
496 and all relevant info
497 Block Blocks message and informs +s IRCops of the blocked message
498 and all relevant info
499 Silent Blocks message, but does not notify IRCops
501 Gline G-lines the user for the specified duration
502 Zline Z-lines the user for the specified duration
503 Shun Shuns the user for the specified duration (requires the shun module)
508 p Block private and channel messages
509 n Block private and channel notices
510 P Block part messages
511 q Block quit messages
512 o Don't match against opers
513 c Strip all formatting codes from the message before matching
514 * Represents all of the above flags
515 - Does nothing, a non-op for when you do not want to specify any
518 The reason for the filter will be used as the reason for the action,
519 unless the action is 'none', and is sent to the user when their text is
520 blocked by 'block' and 'silent' actions.
522 A G-line, Z-line or shun duration may be specified in seconds, or in the
523 format 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5
524 minutes and 6 seconds. All fields in this format are optional.
526 When only one parameter is provided (the filter pattern) the provided
527 filter will be removed. Note that if you remove a
528 configuration-defined filter, it will reappear at next rehash unless
529 it is also removed from the config file.">
531 <helpop key="ojoin" value="/OJOIN <channel>
533 Force joins you to the specified channel, and gives you +Y and any other
534 configuration-defined modes on it, preventing you from being kicked.
535 Depending on configuration, may announce that you have joined the
536 channel on official network business.">
538 <helpop key="clones" value="/CLONES <limit>
540 Retrieves a list of users with more clones than the specified
543 <helpop key="check" value="/CHECK <nick>|<ipmask>|<hostmask>|<channel> [<servername>]
545 Allows opers to look up advanced information on nicknames, IP addresses,
546 hostmasks or channels, in a similar way to WHO but in more detail,
547 displaying most information the server has stored on the target,
548 including all metadata.
550 With the second parameter given, runs the command remotely on the
551 specified server, useful especially if used on a nickname that is
552 online on a remote server.">
554 <helpop key="alltime" value="/ALLTIME
556 Shows the date and time of all servers on the network.">
558 <helpop key="rconnect" value="/RCONNECT <remote-server-mask> <target-server-mask>
560 The server matching <remote-server-mask> will try to connect to the first
561 server in the config file matching <target-server-mask>.">
563 <helpop key="rsquit" value="/RSQUIT <target-server-mask> [:<reason>]
565 Causes a remote server matching <target-server-mask> to be disconnected from
568 <helpop key="globops" value="/GLOBOPS :<message>
570 Sends a message to all users with the +g snomask.">
572 <helpop key="cban" value="/CBAN <channel> [<duration> [:<reason>]]
574 Sets or removes a global channel ban. You must specify all three parameters
575 to add a ban, and one parameter to remove a ban (just the channel).
577 The duration may be specified in seconds, or in the format
578 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
579 five minutes and six seconds. All fields in this format are optional.">
581 <helpop key="sajoin" value="/SAJOIN [<nick>] <channel>[,<channel>]+
583 Forces the user to join the channel(s).
584 If no nick is given, it joins the oper doing the /SAJOIN.">
586 <helpop key="sapart" value="/SAPART <nick> <channel>[,<channel>]+ [:<reason>]
588 Forces the user to part the channel(s), with an optional reason.">
590 <helpop key="samode" value="/SAMODE <target> (+|-)<modes> [<mode-parameters>]
592 Applies the given mode change to the channel or nick specified.">
594 <helpop key="sanick" value="/SANICK <nick> <newnick>
596 Changes the user's nick to the new nick.">
598 <helpop key="sakick" value="/SAKICK <channel> <nick> [:<reason>]
600 Kicks the given user from the specified channel, with an optional reason.">
602 <helpop key="satopic" value="/SATOPIC <channel> :<topic>
604 Applies the given topic to the specified channel.">
606 <helpop key="saquit" value="/SAQUIT <nick> :<reason>
608 Forces user to quit with the specified reason.">
610 <helpop key="setidle" value="/SETIDLE <duration>
612 Sets your idle time to the specified value.
614 The time can be specified in the form of 1y2w3d4h5m6s - meaning one year,
615 two weeks, three days, four hours, five minutes and six seconds.
616 All fields in this format are optional. Alternatively, the time may
617 just be specified as a number of seconds.">
619 <helpop key="sethost" value="/SETHOST <host>
621 Sets your host to the specified host.">
623 <helpop key="setident" value="/SETIDENT <ident>
625 Sets your ident to the specified ident.">
627 <helpop key="swhois" line="/SWHOIS <nick> :<swhois>
629 Sets the user's swhois field to the given swhois message.
630 This will be visible in their /WHOIS.
632 To remove this message again, use:
635 <helpop key="mkpasswd" value="/MKPASSWD <hashtype> <plaintext>
637 Encodes the plaintext to a hash of the given type and displays
640 <helpop key="opermotd" value="/OPERMOTD [<servername>]
642 Displays the Oper MOTD.">
644 <helpop key="nicklock" value="/NICKLOCK <nick> <newnick>
646 Changes the user's nick to the new nick, and forces
647 it to remain as such for the remainder of the session.">
649 <helpop key="nickunlock" value="/NICKUNLOCK <nick>
651 Allows a previously locked user to change nicks again.">
653 <helpop key="chghost" value="/CHGHOST <nick> <host>
655 Changes the host of the user to the specified host.">
657 <helpop key="chgname" value="/CHGNAME <nick> :<realname>
659 Changes the real name of the user to the specified real name.">
661 <helpop key="chgident" value="/CHGIDENT <nick> <ident>
663 Changes the ident of the user to the specified ident.">
665 <helpop key="shun" value="/SHUN <nick!user@host> [<duration> :<reason>]
667 Sets or removes a shun (global server-side ignore) on a nick!user@host mask.
668 You must specify all three parameters to add a shun, and one parameter
669 to remove a shun (just the nick!user@host).
671 The duration may be specified in seconds, or in the format
672 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
673 five minutes and six seconds. All fields in this format are optional.">
675 <helpop key="die" value="/DIE <servername>
677 This command shuts down the local server. A single parameter is
678 required, which must match the name of the local server.">
680 <helpop key="restart" value="/RESTART <servername>
682 This command restarts the local server. A single parameter is
683 required, which must match the name of the local server.">
685 <helpop key="commands" value="/COMMANDS
687 Shows all currently available commands.">
689 <helpop key="kill" value="/KILL <nick>[,<nick>]+ :<reason>
691 This command will disconnect a user from IRC with the given reason.">
693 <helpop key="rehash" value="/REHASH [<servermask>]
695 This command will cause the server configuration file to be reread and
696 values reinitialized for all servers matching the server mask, or the
697 local server if one is not specified.">
699 <helpop key="connect" value="/CONNECT <servermask>
701 Add a connection to the server matching the given server mask. You must
702 have configured the server for linking in your configuration file
703 before trying to link them.">
705 <helpop key="squit" value="/SQUIT <servermask>
707 Disconnects the server matching the given server mask from this server.">
709 <helpop key="modules" value="/MODULES [<servername>]
711 Lists currently loaded modules, their memory offsets, version numbers,
712 and flags. If you are not an operator, you will see reduced detail.">
714 <helpop key="loadmodule" value="/LOADMODULE <modulename>
716 Loads the specified module into the local server.">
718 <helpop key="unloadmodule" value="/UNLOADMODULE <modulename>
720 Unloads a module from the local server.">
722 <helpop key="reloadmodule" value="/RELOADMODULE <modulename>
724 Unloads and reloads a module on the local server.">
726 <helpop key="gloadmodule" value="/GLOADMODULE <modulename> [<servermask>]
728 Loads the specified module on all linked servers.">
730 <helpop key="gunloadmodule" value="/GUNLOADMODULE <modulename> [<servermask>]
732 Unloads a module from all linked servers.">
734 <helpop key="greloadmodule" value="/GRELOADMODULE <modulename> [<servermask>]
736 Unloads and reloads a module on all linked servers.">
738 <helpop key="kline" value="/KLINE <user@host> [<duration> :<reason>]
740 Sets or removes a K-line (local user@host based ban) on a user@host mask.
741 You must specify all three parameters to add a ban, and one parameter
742 to remove a ban (just the user@host).
744 The duration may be specified in seconds, or in the format
745 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
746 five minutes and six seconds. All fields in this format are optional.">
748 <helpop key="zline" value="/ZLINE <ipmask> [<duration> :<reason>]
750 Sets or removes a Z-line (global IP based ban) on an IP mask.
751 You must specify all three parameters to add a ban, and one parameter
752 to remove a ban (just the ipmask).
754 The duration may be specified in seconds, or in the format
755 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
756 five minutes and six seconds. All fields in this format are optional.">
758 <helpop key="qline" value="/QLINE <nickmask> [<duration> :<reason>]
760 Sets or removes a Q-line (global nick based ban) on a nick mask.
761 You must specify all three parameters to add a ban, and one parameter
762 to remove a ban (just the nickmask).
764 The duration may be specified in seconds, or in the format
765 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
766 five minutes and six seconds. All fields in this format are optional.">
768 <helpop key="gline" value="/GLINE <user@host> [<duration> :<reason>]
770 Sets or removes a G-line (global user@host based ban) on a user@host mask.
771 You must specify all three parameters to add a ban, and one
772 parameter to remove a ban (just the user@host).
774 The duration may be specified in seconds, or in the format
775 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
776 five minutes and six seconds. All fields in this format are optional.">
778 <helpop key="eline" value="/ELINE <user@host> [<duration> :<reason>]
780 Sets or removes a E-line (global user@host ban exception) on a user@host mask.
781 You must specify at least 3 parameters to add an exception, and one
782 parameter to remove an exception (just the user@host).
784 The duration may be specified in seconds, or in the format
785 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
786 five minutes and six seconds. All fields in this format are optional.
788 This command has a few important limitations. Bans on *@<ip> can only
789 be negated by an E-line on *@<ip>, bans on *@<host> can be negated by
790 E-lines on *@<ip>, or *@<host>, and bans on <ident>@* or <ident>@<host>
791 can be negated by any E-line that matches.">
793 <helpop key="wallops" value="/WALLOPS :<message>
795 Sends a message to all +w users.">
797 <helpop key="rline" value="/RLINE <regex> [<duration> :<reason>]
799 Sets or removes an R-line (global regex ban) on a n!u@h\srealname mask. You
800 must specify all three parameters to add an R-line, and one parameter
801 to remove an R-line (just the regex).
803 The duration may be specified in seconds, or in the format
804 1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
805 five minutes and six seconds. All fields in this format are optional.">
807 <helpop key="clearchan" value="/CLEARCHAN <channel> [KILL|KICK|G|Z] [:<reason>]
809 Quits or kicks all non-opers from a channel, optionally G/Z-lines them.
810 Useful for quickly nuking bot channels.
812 The default method, KILL, simply disconnects the victims from the server,
813 while methods G and Z also add G/Z-lines for all the targets.
815 When used, the victims won't see each other getting kicked or quitting.">
817 <helpop key="modenotice" value="/MODENOTICE <modeletters> :<message>
819 Sends a notice to all users who have the given mode(s) set.
820 If multiple mode letters are given, the notice is only sent to users
821 who have all of them set.">
823 <helpop key="cloak" value="/CLOAK <host>
825 Generate the cloak of a host or IP. This is useful for example when
826 trying to get the cloak of a user from /WHOWAS and they were not
827 using their cloak when they quit.">
829 <helpop key="umodes" value="User Modes
832 c Blocks private messages and notices from users who do
833 not share a common channel with you (requires the
835 d Deaf mode. User will not receive any messages or notices
836 from channels they are in (requires the deaf module).
837 g In combination with /ACCEPT, provides for server-side
838 ignore (requires the callerid module).
839 h Marks as 'available for help' in WHOIS (IRCop only,
840 requires the helpop module).
841 i Makes invisible to /WHO if the user using /WHO is not in
843 k Prevents the user from being kicked from channels, or
844 having op modes removed from them (services only,
845 requires the servprotect module).
846 o Marks as a IRC operator.
847 s <mask> Receives server notices specified by <mask>
849 r Marks as a having a registered nickname
850 (requires the services account module).
851 w Receives wallops messages.
852 x Gives a cloaked hostname (requires the cloaking module).
853 z Only allow private messages from SSL users (requires the
855 B Marks as a bot (requires the botmode module).
856 D Privdeaf mode. User will not receive any private messages
857 or notices from users (requires the deaf module).
858 G Censors messages sent to the user based on filters
859 configured for the network (requires the censor module).
860 H Hides an oper's oper status from WHOIS (requires the
862 I Hides a user's entire channel list in WHOIS from
863 non-IRCops (requires the hidechans module).
864 L Stops redirections done by the redirect module (requires
865 the redirect module).
866 R Blocks private messages from unregistered users
867 (requires the services account module).
868 S Strips formatting codes out of private messages
869 to the user (requires the stripcolor module).
870 W Receives notification when a user uses WHOIS on them
871 (IRCop only, requires the showwhois module).">
873 <helpop key="chmodes" value="Channel Modes
876 v <nickname> Gives voice to <nickname>, allowing them to speak
877 while the channel is +m.
878 h <nickname> Gives halfop status to <nickname> (requires the
879 customprefix module).
880 o <nickname> Gives op status to <nickname>.
881 a <nickname> Gives protected status to <nickname>, preventing
882 them from being kicked (+q only, requires the
883 customprefix module).
884 q <nickname> Gives owner status to <nickname>, preventing them
885 from being kicked (Services or +q only, requires
886 the customprefix module).
888 b <hostmask> Bans <hostmask> from the channel.
889 e <hostmask> Excepts <hostmask> from bans (requires the
890 banexception module).
891 I <hostmask> Excepts <hostmask> from +i, allowing matching
892 users to join while the channel is invite-only
893 (requires the inviteexception module).
895 c Blocks messages that contain formatting codes
896 (requires the blockcolor module).
897 d <time> Blocks messages to a channel from new users
898 until they have been in the channel for <time>
899 seconds (requires the delaymsg module).
900 f [*]<lines>:<sec> Kicks on text flood equal to or above the
901 specified rate. With *, the user is banned
902 (requires the messageflood module).
903 g <mask> Blocks messages matching the given glob mask
904 (requires the chanfilter module).
905 i Makes the channel invite-only.
906 Users can only join if an operator
907 uses /INVITE to invite them.
908 j <joins>:<sec> Limits joins to the specified rate (requires
909 the joinflood module).
910 k <key> Set the channel key (password) to <key>.
911 l <limit> Set the maximum allowed users to <limit>.
912 m Enable moderation. Only users with +v, +h, or +o
914 n Blocks users who are not members of the channel
916 p Make channel private, hiding it in users' whoises
917 and replacing it with * in /LIST.
918 r Marks the channel as registered with Services
919 (requires the services account module).
920 s Make channel secret, hiding it in users' whoises
922 t Prevents users without +h or +o from changing the
924 u Makes the channel an auditorium; normal users only
925 see themselves or themselves and the operators,
926 while operators see all the users (requires the
928 w <flag>:<banmask> Adds basic channel access controls of <flag> to
929 <banmask>, via the +w listmode.
930 For example, +w o:R:Brain will op anyone identified
931 to the account 'Brain' on join.
932 (requires the autoop module)
933 z Blocks non-SSL clients from joining the channel
934 (requires the sslmodes module).
936 A Allows anyone to invite users to the channel
937 (normally only chanops can invite, requires
938 the allowinvite module).
939 B Blocks messages with too many capital letters,
940 as determined by the network configuration
941 (requires the blockcaps module).
942 C Blocks any CTCPs to the channel (requires the
944 D Delays join messages from users until they message
945 the channel (requires the delayjoin module).
946 E [~|*]<lines>:<sec>[:<difference>][:<backlog>] Allows blocking of
947 similar messages (requires the repeat module).
948 Kicks as default, blocks with ~ and bans with *
949 The last two parameters are optional.
950 F <changes>:<sec> Blocks nick changes when they equal or exceed the
951 specified rate (requires the nickflood module).
952 G Censors messages to the channel based on the
953 network configuration (requires the censor module).
954 H <num>:<duration> Displays the last <num> lines of chat to joining
955 users. <duration> is the maximum time to keep
956 lines in the history buffer (requires the
958 J <seconds> Prevents rejoin after kick for the specified
959 number of seconds. This prevents auto-rejoin
960 (requires the kicknorejoin module).
961 K Blocks /KNOCK on the channel (requires the
963 L <channel> If the channel reaches its limit set by +l,
964 redirect users to <channel> (requires the
966 M Blocks unregistered users from speaking (requires
967 the services account module).
968 N Prevents users on the channel from changing nick
969 (requires the nonicks module).
970 O Channel is IRCops only (can only be set by IRCops,
971 requires the operchans module).
972 P Makes the channel permanent; Bans, invites, the
973 topic, modes, and such will not be lost when it
974 empties (can only be set by IRCops, requires
975 the permchannels module).
976 Q Only U-lined servers and their users can kick
977 (requires the nokicks module).
978 R Blocks unregistered users from joining (requires
979 the services account module).
980 S Strips formatting codes from messages to the
981 channel (requires the stripcolor module).
982 T Blocks /NOTICEs to the channel from users who are
983 not at least halfop (requires the nonotice module).
984 X <type>:<status> Makes users of <status> or higher exempt to the
985 specified restriction <type>. For example: flood:h
986 (requires the exemptchanops module).
987 Possible restriction types to exempt with +X are:
989 auditorium-see Permission required to see the full user list of
990 a +u channel (requires the auditorium module).
991 auditorium-vis Permission required to be visible in a +u channel
992 (requires the auditorium module).
993 blockcaps Channel mode +B
994 blockcolor Channel mode +c
995 censor Channel mode +G
996 filter Channel mode +g
997 flood Channel mode +f
998 nickflood Channel mode +F
999 noctcp Channel mode +C
1000 nonick Channel mode +N
1001 nonotice Channel mode +T
1002 regmoderated Channel mode +M
1003 stripcolor Channel mode +S
1004 topiclock Channel mode +t
1007 NOTE: A large number of these modes are dependent upon server-side modules
1008 being loaded by a server/network administrator. The actual modes available
1009 on your network may be very different to this list. Please consult your
1010 help channel if you have any questions.">
1012 <helpop key="stats" value="/STATS <symbol> [<servername>]
1014 Shows various server statistics. Depending on configuration, some
1015 symbols may be only available to opers.
1019 e Show E-lines (global user@host ban exceptions)
1020 g Show G-lines (global user@host bans)
1021 k Show K-lines (local user@host bans)
1022 q Show Q-lines (global nick bans)
1023 R Show R-lines (global regular expression bans)
1024 Z Show Z-lines (global IP mask bans)
1026 s Show filters (global)
1027 C Show channel bans (global)
1028 H Show shuns (global)
1031 d Show configured DNSBLs and related statistics
1032 m Show command statistics, number of times commands have been used
1033 o Show a list of all valid oper usernames and hostmasks
1034 p Show open client ports, and the port type (ssl, plaintext, etc)
1035 u Show server uptime
1036 z Show memory usage statistics
1037 i Show connect class permissions
1038 l Show all client connections with information (sendq, commands, bytes, time connected)
1039 L Show all client connections with information and IP address
1040 P Show online opers and their idle times
1041 T Show bandwidth/socket statistics
1042 U Show U-lined servers
1043 Y Show connection classes
1044 O Show opertypes and the allowed user and channel modes it can set
1045 E Show socket engine events
1046 S Show currently held registered nicknames
1047 G Show how many local users are connected from each country according to GeoIP
1049 Note that all /STATS use is broadcast to online IRC operators.">
1051 <helpop key="snomasks" value="Server Notice Masks
1053 a Allows receipt of local announcement messages.
1054 A Allows receipt of remote announcement messages.
1055 c Allows receipt of local connect messages.
1056 C Allows receipt of remote connect messages.
1057 d Allows receipt of local DNSBL messages (requires the dnsbl module).
1058 D Allows receipt of remote DNSBL messages (requires the dnsbl module).
1059 f Allows receipt of local filter messages (requires the filter module).
1060 F Allows receipt of remote filter messages (requires the filter module).
1061 g Allows receipt of globops (requires the globops module).
1062 j Allows receipt of channel creation notices (requires the chancreate module).
1063 J Allows receipt of remote channel creation notices (requires the chancreate module).
1064 k Allows receipt of local kill messages.
1065 K Allows receipt of remote kill messages.
1066 l Allows receipt of local linking related messages.
1067 L Allows receipt of remote linking related messages.
1068 n Allows receipt of local nickname changes (requires the seenicks module).
1069 N Allows receipt of remote nickname changes (requires the seenicks modules).
1070 o Allows receipt of oper-up, oper-down, and oper-failure messages.
1071 O Allows receipt of remote oper-up, oper-down, and oper-failure messages.
1072 q Allows receipt of local quit messages.
1073 Q Allows receipt of remote quit messages.
1074 r Allows receipt of local oper commands (requires the operlog module).
1075 R Allows receipt of remote oper commands (requires the operlog module).
1076 t Allows receipt of attempts to use /STATS (local and remote).
1077 v Allows receipt of oper-override notices (requires the override module).
1078 x Allows receipt of local X-line notices (G/Z/Q/K/E/R/SHUN/CBan).
1079 X Allows receipt of remote X-line notices (G/Z/Q/K/E/R/SHUN/CBan).">
1081 <helpop key="extbans" value="Extended Bans
1084 Extbans are split into two types; matching extbans, which match on
1085 users in additional ways, and acting extbans, which restrict users
1086 in different ways to a standard ban.
1088 To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
1089 instead of a normal nick!user@host mask, to ban or exempt matching
1090 users. Ban exceptions on acting extbans exempt that user from matching
1091 an extban of that type, and from any channel mode corresponding to the
1092 restriction. Matching extbans may also be used for invite exceptions by
1093 setting +I <extban>.
1097 a:<mask> Matches user with both a matching banmask and realname,
1098 where <mask> is in the format nick!user@host+realname
1099 (requires gecosban module).
1100 j:<channel> Matches anyone in the given channel. Does not support
1101 wildcards (requires the channelban module).
1102 n:<class> Matches users in a matching connect class (requires
1103 the classban module).
1104 r:<realname> Matches users with a matching real name (requires the
1106 s:<server> Matches users on a matching server (requires the
1108 z:<certfp> Matches users having the given SSL certificate
1109 fingerprint (requires the sslmodes module).
1110 O:<opertype> Matches IRCops of a matching type, mostly useful as an
1111 an invite exception (requires the operchans module).
1112 R:<account> Matches users logged into a matching account (requires
1113 the services account module).
1114 U:<banmask> Matches unregistered users matching the given banmask.
1115 (requires the services account module).
1119 c:<banmask> Blocks any messages that contain formatting codes from
1120 matching users (requires the blockcolor module).
1121 m:<banmask> Blocks messages from matching users (requires the muteban
1122 module). Users with +v or above are not affected.
1123 p:<banmask> Blocks part messages from matching users (requires
1124 the nopartmsg module).
1125 A:<banmask> Blocks invites by matching users even when +A is set
1126 (requires the allowinvite module).
1127 B:<banmask> Blocks all capital or nearly all capital messages from
1128 matching users (requires the blockcaps module).
1129 C:<banmask> Blocks CTCPs from matching users (requires the noctcp
1131 N:<banmask> Blocks nick changes from matching users (requires
1132 the nonicks module).
1133 Q:<banmask> Blocks kicks by matching users (requires the nokicks
1135 S:<banmask> Strips formatting codes from messages from matching
1136 users (requires the stripcolor module).
1137 T:<banmask> Blocks notices from matching users (requires the
1140 A ban given to an Acting extban may either be a nick!user@host mask
1141 (unless stated otherwise), matched against users as for a normal ban,
1142 or a Matching extban.
1144 There is an additional special type of extended ban, a redirect ban:
1146 Redirect n!u@h#channel will redirect the banned user to #channel
1147 when they try to join (requires the banredirect module).">