7 <alias text="HELP" replace="HELPOP $2-">
9 <helpop key="start" value="InspIRCd Help System
11 This system provides help for commands and modes.
12 Specify your question or a command name as the
13 parameter for this command.
15 /HELPOP CUSER - To see a list of user commands
16 /HELPOP COPER - To see a list of oper commands
17 /HELPOP UMODES - To see a list of user modes
18 /HELPOP CHMODES - To see a list of channel modes
19 /HELPOP SNOMASKS - To see a list of oper snotice masks
20 /HELPOP EXTBANS - To see a list of extended bans">
22 <helpop key="nohelp" value="There is no help for the topic
23 you searched for. Please try again.">
29 <helpop key="cuser" value="User Commands
32 PRIVMSG NOTICE NICK JOIN PART
33 CYCLE KNOCK MODE DEVOICE TOPIC
34 KICK FPART REMOVE TBAN INVITE
35 UNINVITE AWAY DCCALLOW SILENCE ACCEPT
36 MKPASSWD VHOST TITLE SETNAME
38 WHOIS WHOWAS ISON USERHOST WATCH
39 LIST NAMES WHO MOTD RULES
40 ADMIN MAP LINKS LUSERS TIME
41 STATS VERSION INFO MODULES COMMANDS
44 USER PASS PING PONG QUIT
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 following format: 1w2d3h4m6s which indicates a ban of one week, two
61 days, three hours, four minutes and six seconds. Alternatively the
62 ban may just be specified as a number of seconds. All timed bans
63 appear in the banlist as normal bans and may be safely removed
64 before their time is up.">
66 <helpop key="dccallow" value="/DCCALLOW - List allowed nicks
67 /DCCALLOW LIST - This also lists allowed nicks
68 /DCCALLOW +<nick> [<duration>] - Add a nick
69 /DCCALLOW -<nick> - Remove a nick
70 /DCCALLOW HELP - Display help
72 Duration is optional, and may be specified in seconds or in the
75 <helpop key="accept" value="/ACCEPT * - List accepted nicks
76 /ACCEPT +<nick> - Add a nick
77 /ACCEPT -<nick> - Remove a nick
78 This command accepts multiple nicks like so:
79 /ACCEPT +<nick1>,+<nick2>,-<nick3>
81 Manages your accept list. This list is used to determine who can
82 private message you when you have usermode +g set.">
84 <helpop key="cycle" value="/CYCLE <channel> :[<reason>]
86 Cycles a channel (leaving and rejoining), overrides restrictions that
87 would stop a new user joining, such as user limits and channel keys.">
89 <helpop key="title" value="/TITLE <name> <password>
91 Authenticate for a WHOIS title line and optionally a vhost using the
92 specified username and password.">
94 <helpop key="watch" value="/WATCH - List watched nicks that are online
95 /WATCH L - List watched nicks, online and offline
96 /WATCH C - Clear all watched nicks
97 /WATCH S - Show statistics
98 /WATCH +<nick> - Add a nick
99 /WATCH -<nick> - Remove a nick
100 This command accepts multiple nicks like so:
101 /WATCH +<nick1> +<nick2> -<nick3>">
103 <helpop key="vhost" value="/VHOST <username> <password>
105 Authenticate for a vhost using the specified username and password.">
107 <helpop key="remove" value="/REMOVE <nick> <channel> [<reason>]
109 Removes a user from a channel you specify. You must be at least a
110 channel halfoperator to remove a user. A removed user will part with
111 a message stating they were removed from the channel and by whom.">
113 <helpop key="fpart" value="/FPART <channel> <nick> [<reason>]
115 This behaves identically to /REMOVE, the only difference is that the
116 <channel> and <nick> parameters are switched around to match /KICK's
117 syntax. Also, /REMOVE is a built-in mIRC command which caused trouble
120 <helpop key="devoice" value="/DEVOICE <channel>
122 Devoices yourself on the specified channel.">
124 <helpop key="silence" value="/SILENCE - Shows a list of silenced masks
125 /SILENCE +<mask> [<flags>] - Add a mask
126 /SILENCE -<mask> - Remove a mask
128 A serverside ignore of the given n!u@h mask. The letter(s) at the end
129 specify what is to be ignored from this hostmask.
134 p Block private messages
135 c Block channel messages
137 n Block private notices
138 t Block channel notices
139 a Block all of the above
142 Multiple letters may be specified. For an exception, you must pair x
143 with what you want excepted. For example, if you wanted to except
144 everything from people with a host matching *.foo.net, you would do
145 /SILENCE +*!*@*.foo.net xa
147 /SILENCE without a parameter will list the masks that you have silenced.">
149 <helpop key="knock" value="/KNOCK <channel>
151 Sends a notice to a channel indicating you wish to join.">
153 <helpop key="user" value="/USER <ident> <local host> <remote host> :<GECOS>
155 This command is used by your client to register your
156 IRC session, providing your ident and GECOS to the
159 You should not use it during an established connection.">
161 <helpop key="nick" value="/NICK <new nick>
163 Change your nickname to <new nick>.">
165 <helpop key="quit" value="/QUIT [<reason>]
167 Quit from IRC and end your current session.">
169 <helpop key="version" value="/VERSION
171 Returns the server's version information.">
173 <helpop key="ping" value="/PING <server>
175 Ping a server. The server will answer with a PONG.">
177 <helpop key="pong" value="/PONG <server>
179 Your client should send this to answer server PINGs. You
180 should not issue this command manually.">
182 <helpop key="admin" value="/ADMIN [<server>]
184 Shows the administrative information for the given server.">
186 <helpop key="privmsg" value="/PRIVMSG <target> <text>
188 Sends a message to a user or channel specified in <target>.">
190 <helpop key="notice" value="/NOTICE <target> <text>
192 Sends a notice to a user or channel specified in <target>.">
194 <helpop key="join" value="/JOIN <channel>[,<channel>] [<key>][,<key>]
196 Joins one or more channels you provide the names for.">
198 <helpop key="names" value="/NAMES <channel>[,<channel>]
200 Return a list of users on the channels you provide.">
202 <helpop key="part" value="/PART <channel>[,<channel>] [<reason>]
204 Leaves one or more channels you specify.">
206 <helpop key="kick" value="/KICK <channel> <nick>[,<nick>] [<reason>]
208 Kicks a user from a channel you specify. You must be
209 at least a channel halfoperator to kick a user.">
211 <helpop key="mode" value="/MODE <target> (+|-)<modes> [<mode parameters>] - Change modes of <target>.
213 /MODE <target> - Show modes of <target>.
215 /MODE <channel> <list mode char> - List bans, exceptions, etc. set on <channel>.
217 Sets the mode for a channel or a nickname specified in <target>.
218 A user may only set modes upon themselves, and may not set the
219 +o usermode, and a user may only change channel modes of
220 channels where they are at least a halfoperator.
222 For a list of all user and channel modes, enter /HELPOP UMODES or
225 <helpop key="topic" value="/TOPIC <channel> [<topic>]
227 Sets or retrieves the channel topic. If a channel topic is
228 given in the command and either the channel is not +t, or
229 you are at least a halfoperator, the channel topic will be
230 changed to the new one you provide.">
232 <helpop key="who" value="/WHO <pattern> [afhilMmoprt]
234 Looks up the information of users matching the range you provide.
236 You may only /WHO nicknames in channels or on servers where you
237 share a common channel with them, or ones which are not +i (unless
238 you are a server operator). The search pattern may be a special
239 sequence of characters determined by the flags given below, or
240 it may be one of a nickname, a channel, a hostmask, an IP address
241 mask or a server mask.
246 The following flags use <pattern> to match against the specified user data:
248 a Show users who have an away message matching <pattern>.
249 i Show users who have an ident (username) matching <pattern>.
250 M Show users who have metadata attached to them with a key name matching
251 <pattern> (server operators only).
252 m Show users who have the modes listed in <pattern>. The pattern
253 should be in the same format as a mode change e.g. +ow-i (server
255 p Show users who are connected to a port in the <pattern> range (server
257 r Show users who have a real name matching <pattern>.
258 t Show users who have connected in the last <pattern> seconds.
260 The following flags filter users by their status:
262 f Only show users on remote (far) servers.
263 l Only show users on the local server.
264 o Only show server operators.
266 The following flags modify the command output:
268 h Show real hostnames rather than display hostnames (server operators
271 You may combine one flag from the first group and multiple from the others in
274 <helpop key="motd" value="/MOTD [<server>]
276 Show the message of the day for <server>. Messages of the day often
277 contain important server rules and notices and should be read prior
280 <helpop key="rules" value="/RULES
282 Show the rules file for the local server. This is similar in effect to
283 except that these are not sent automatically on connect.">
285 <helpop key="oper" value="/OPER <login> <password>
287 Attempts to authenticate a user as an IRC operator.
289 Both successful and unsuccessful oper attempts are
290 logged, and sent to online IRC operators.">
292 <helpop key="list" value="/LIST [<pattern>]
294 Creates a list of all existing channels matching the glob pattern
295 <pattern>, e.g. *chat* or bot*.">
297 <helpop key="lusers" value="/LUSERS
299 Shows a count of local and remote users, servers and channels.">
301 <helpop key="userhost" value="/USERHOST <nick> [<nick>]
303 Returns the hostname and nickname of a user, and some other
304 miscellaneous information.">
306 <helpop key="away" value="/AWAY [<message>]
308 If a message is given, marks you as being away, otherwise
309 removes your away status and previous message.">
311 <helpop key="ison" value="/ISON <nick> [<nick> ...]
313 Returns a subset of the nicks you give, showing only those
314 that are currently online.">
316 <helpop key="invite" value="/INVITE <nick> <channel> [<time>]
318 Invites a user to a channel. If the channel is NOT +A, only
319 channel halfoperators or above can invite people. If +A is set,
320 anyone can invite people to the channel, as long as the person
321 doing the invite is a member of the channel they wish to invite
324 Invited users may override bans, +k, and similar in addition to
325 +i, depending on configuration.
327 If a time is provided, the invite expires after that time and the user
328 can no longer use it to enter the channel.">
330 <helpop key="pass" value="/PASS <password>
332 This command is used by your client when setting up
333 your IRC session to submit a server password to the
336 You should not use it during an established connection.">
338 <helpop key="whowas" value="/WHOWAS <nick>
340 Returns a list of times the user was seen recently on IRC along with
341 the time they were last seen and their server.">
343 <helpop key="links" value="/LINKS
345 Shows all servers linked to this one.">
347 <helpop key="map" value="/MAP
349 Shows a graphical representation of all users and servers on the
350 network, and the links between them, as a tree from the perspective
353 <helpop key="whois" value="/WHOIS <nick> [<server>]
355 Returns the WHOIS information of a user, their channels, hostname,
356 etc. If a second nickname or server is provided, then a whois is
357 performed from the server where the user is actually located rather
358 than locally, showing idle and signon times.">
360 <helpop key="time" value="/TIME [<server>]
362 Returns the local time of the server, or remote time of another
365 <helpop key="info" value="/INFO [<server>]
367 Returns information on the developers and supporters who made this
368 IRC server possible.">
370 <helpop key="setname" value="/SETNAME <name>
372 Sets your name to the specified name.">
375 #####################
377 #####################
379 <helpop key="coper" value="Oper Commands
382 OPERMOTD CHECK CLONES USERIP TLINE
383 ALLTIME WALLOPS GLOBOPS MODENOTICE
386 SETHOST SETIDENT CHGHOST CHGIDENT CHGNAME
389 SANICK NICKLOCK NICKUNLOCK
391 SAJOIN SAPART SAMODE SATOPIC SAKICK
393 KILL SAQUIT GLINE ZLINE QLINE
394 KLINE RLINE ELINE CBAN SHUN
397 CONNECT SQUIT RCONNECT RSQUIT
400 CLEARCACHE LOADMODULE UNLOADMODULE
401 RELOADMODULE GLOADMODULE GUNLOADMODULE
402 GRELOADMODULE CLOSE JUMPSERVER
403 LOCKSERV UNLOCKSERV">
405 <helpop key="userip" value="/USERIP <nick> [<nick>]
407 Returns the ip and nickname of the given users.">
409 <helpop key="tline" value="/TLINE <mask>
411 This command returns the number of local and global clients matched,
412 and the percentage of clients matched, plus how they were matched
413 (by IP address or by hostname). Mask should be given as either a
414 nick!user@host or user@IP (wildcards acceptable).">
416 <helpop key="lockserv" value="/LOCKSERV
418 Locks out all new connections notifying connecting users that the
419 service is temporarily closed and to try again later.">
421 <helpop key="unlockserv" value="/UNLOCKSERV
423 Opens the server up again for new connections.">
425 <helpop key="jumpserver" value="/JUMPSERVER [<newserver> <newport> <(+|-)[flags]> :[<reason>]]
427 Sets or cancels jumpserver mode. If no parameters are given,
428 jumpserver mode is cancelled, if it is currently set. If parameters
429 are given, a server address must be given for <newserver> and a
430 server port must be given for <newport>. Zero or more status flags
431 should be given for 'flags', from the list below (if you do not
432 wish to specify any flags just place a '+' in this field):
434 1. +a: Redirect all users immediately (except for opers) and cause
435 them to quit with the given reason
437 2. +n: Redirect any new users who connect and cause them to quit
440 You may use + and - to set or unset these flags in the command, the
441 default flags are -a+n, which will just redirect new users. The
442 reason parameter is optional, and if not provided defaults to
443 'Please use this server/port instead' (the default given in various
446 <helpop key="filter" value="/FILTER <filter-definition> [<action> <flags> [<gline-duration>] :<reason>]
448 This command will add a filter when more than one parameter is given,
449 for messages of the types specified by the flags, with the given
450 filter definition, action, gline duration (when the action is 'gline')
453 The filter will take effect when a message of any type specified by
454 the flags and matching the definition is sent to the server, and
455 perform the specified action.
461 Block Blocks message and informs +s IRCops of the blocked message
462 and all relevant info
463 Silent Blocks message, but does not notify IRCops
465 Gline Glines the user for the specified duration
470 p Block private and channel messages
471 n Block private and channel notices
472 P Block part messages
473 q Block quit messages
474 o Don't match against opers
475 c Strip all formatting codes from the message before matching
476 * Represents all of the above flags
477 - Does nothing, a non-op for when you do not want to specify any
480 The reason for the filter will be used as the reason for the action,
481 unless the action is 'none', and is sent to the user when their text is
482 blocked by 'block' and 'silent' actions.
484 A gline duration may be specified in seconds, or in the format
485 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5
486 minutes and 6 seconds. All fields in this format are optional.
488 When only one parameter is provided (the filter pattern) the provided
489 filter will be removed. Note that if you remove a
490 configuration-defined filter, it will reappear at next rehash unless
491 it is also removed from the config file.">
493 <helpop key="ojoin" value="/OJOIN <channel>
495 Force joins you to the specified channel, and gives you +Y and any other
496 configuration-defined modes on it, preventing you from being kicked.
497 Depending on configuration, may announce that you have joined the
498 channel on official network business.">
500 <helpop key="clones" value="/CLONES <limit>
502 Retrieves a list of users with more clones than the specified
505 <helpop key="check" value="/CHECK <nick|ip|hostmask|channel> [<server>]
507 Allows opers to look up advanced information on channels, hostmasks
508 or IP addresses, in a similar way to WHO but in more detail, displaying
509 most information the IRCD has stored on the target, including all
512 With the second parameter given, runs the command remotely on the
515 <helpop key="alltime" value="/ALLTIME
517 Shows the time on all servers on the network.">
519 <helpop key="rconnect" value="/RCONNECT <source mask> <target mask>
521 The server matching <source mask> will try to connect to the first
522 server in the config file matching <target mask>.">
524 <helpop key="rsquit" value="/RSQUIT <target mask> [<reason>]
526 Causes a remote server matching <target mask> to be disconnected from
529 <helpop key="globops" value="/GLOBOPS <message>
531 Sends a message to all users with the +g snomask.">
533 <helpop key="cban" value="/CBAN <channel> [<duration> :[<reason>]]
535 Sets or removes a channel ban. You must specify all three parameters
536 to add a ban, and one parameter to remove a ban (just the channel).
538 The duration may be specified in seconds, or in the format
539 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
540 5 minutes and 6 seconds. All fields in this format are optional.">
542 <helpop key="sajoin" value="/SAJOIN <nick> <channel>
544 Forces the user to join the channel.">
546 <helpop key="sapart" value="/SAPART <nick> <channel>
548 Forces the user to part the channel.">
550 <helpop key="samode" value="/SAMODE <target> (+|-)<modes> [<parameters for modes>]
552 Applies the given mode change to the channel or nick specified.">
554 <helpop key="sanick" value="/SANICK <nick> <new nick>
556 Changes the user's nick to the new nick.">
558 <helpop key="sakick" value="/SAKICK <channel> <nick> <reason>
560 Kicks the given user from the specified channel.">
562 <helpop key="satopic" value="/SATOPIC <channel> <new topic>
564 Applies the given topic to the specified channel.">
566 <helpop key="saquit" value="/SAQUIT <nick> <reason>
568 Forces user to quit with the specified reason.">
570 <helpop key="setidle" value="/SETIDLE <idle time>
572 Sets your idle time (in seconds) to the specified value.">
574 <helpop key="sethost" value="/SETHOST <host>
576 Sets your host to the specified host.">
578 <helpop key="setident" value="/SETIDENT <ident>
580 Sets your ident to the specified ident.">
582 <helpop key="swhois" line="/SWHOIS <nick> <swhois>
584 Sets the user's swhois field to the given swhois.">
586 <helpop key="mkpasswd" value="/MKPASSWD <hashtype> <plaintext>
588 Encodes the plaintext to a hash of the given type and displays
591 <helpop key="opermotd" value="/OPERMOTD
593 Displays the Oper MOTD.">
595 <helpop key="nicklock" value="/NICKLOCK <nick> <new nick>
597 Changes the user's nick to the new nick, and forces
598 it to remain as such for the remainder of the session.">
600 <helpop key="nickunlock" value="/NICKUNLOCK <nick>
602 Allows a previously locked user to change nicks again.">
604 <helpop key="chghost" value="/CHGHOST <nickname> <new hostname>
606 Changes the hostname of the user to the new hostname.">
608 <helpop key="chgname" value="/CHGNAME <nickname> <new name>
610 Changes the name of the user to the new name.">
612 <helpop key="chgident" value="/CHGIDENT <nickname> <new ident>
614 Changes the ident of the user to the new ident.">
616 <helpop key="shun" value="/SHUN <nick!user@host> [[<duration>] :<reason>]
618 Sets or removes a shun (server side ignore) on a host and ident mask.
619 You must specify all three parameters to add a shun, and one parameter
620 to remove a shun (just the nick!user@host section).
622 The duration may be specified in seconds, or in the format
623 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
624 5 minutes and 6 seconds. All fields in this format are optional.">
626 <helpop key="die" value="/DIE <password>
628 This command shuts down the local server. A single parameter is
629 required, which must match the password in the configuration for the
630 command to function.">
632 <helpop key="restart" value="/RESTART <password>
634 This command restarts the local server. A single parameter is
635 required, which must match the password in the configuration for the
636 command to function.">
638 <helpop key="commands" value="/COMMANDS
640 Shows all currently available commands.">
642 <helpop key="kill" value="/KILL <user> <reason>
644 This command will disconnect a user from IRC with the given reason.">
646 <helpop key="rehash" value="/REHASH <mask>
648 This command will cause the server configuration file to be reread and
649 values reinitialized for all servers matching the server mask, or the
650 local server if one is not specified.">
652 <helpop key="connect" value="/CONNECT <servermask>
654 Add a connection to the server matching the given server mask. You must
655 have configured the server for linking in your configuration file
656 before trying to link them.">
658 <helpop key="squit" value="/SQUIT <servermask>
660 Disconnects the server matching the given server mask from this server.">
662 <helpop key="modules" value="/MODULES
664 Lists currently loaded modules, their memory offsets, version numbers,
665 and flags. If you are not an operator, you will see reduced detail.">
667 <helpop key="loadmodule" value="/LOADMODULE <filename.so>
669 Loads the specified module into the local server.">
671 <helpop key="unloadmodule" value="/UNLOADMODULE <filename.so>
673 Unloads a module from the local server. The module cannot have the
674 static flag set (see the output of /MODULES).">
676 <helpop key="reloadmodule" value="/RELOADMODULE <filename.so>
678 Unloads and reloads a module on the local server. This module cannot
679 have the static flag set (see the output of /MODULES).">
681 <helpop key="gloadmodule" value="/GLOADMODULE <filename.so>
683 Loads the specified module on all linked servers.">
685 <helpop key="gunloadmodule" value="/GUNLOADMODULE <filename.so>
687 Unloads a module from all linked servers. The module cannot have the
688 static flag set (see the output of /MODULES).">
690 <helpop key="greloadmodule" value="/GRELOADMODULE <filename.so>
692 Unloads and reloads a module on all linked servers. This module cannot
693 have the static flag set (see the output of /MODULES).">
695 <helpop key="kline" value="/KLINE <user@host> [<duration> :<reason>]
697 Sets or removes a k-line (local host based ban) on a host and ident mask.
698 You must specify all three parameters to add a ban, and one parameter
699 to remove a ban (just the user@host section).
701 The duration may be specified in seconds, or in the format
702 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
703 5 minutes and 6 seconds. All fields in this format are optional.">
705 <helpop key="zline" value="/ZLINE <ipmask> [<duration> :<reason>]
707 Sets or removes a z-line (ip based ban) on an ip range mask.
708 You must specify all three parameters to add a ban, and one parameter
709 to remove a ban (just the ipmask).
711 The duration may be specified in seconds, or in the format
712 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
713 5 minutes and 6 seconds. All fields in this format are optional.">
715 <helpop key="qline" value="/QLINE <nickmask> [<duration> :<reason>]
717 Sets or removes a q-line (nick based ban) on a nick mask.
718 You must specify all three parameters to add a ban, and one parameter
719 to remove a ban (just the nickmask).
721 The duration may be specified in seconds, or in the format
722 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
723 5 minutes and 6 seconds. All fields in this format are optional.">
725 <helpop key="gline" value="/GLINE <user@host> [<duration> :<reason>]
727 Sets or removes a g-line (host based ban) on host mask.
728 You must specify all three parameters to add a ban, and one
729 parameter to remove a ban (just the user@host section).
731 The duration may be specified in seconds, or in the format
732 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
733 5 minutes and 6 seconds. All fields in this format are optional.">
735 <helpop key="eline" value="/ELINE <user@host> [<duration> :<reason>]
737 Sets or removes a e-line (global ban exception) on host mask.
738 You must specify at least 3 parameters to add an exception, and one
739 parameter to remove an exception (just the user@host section).
741 The duration may be specified in seconds, or in the format
742 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
743 5 minutes and 6 seconds. All fields in this format are optional.
745 This command has a few important limitations. Bans on *@<ip> can only
746 be negated by an eline on *@<ip>, bans on *@<host> can be negated by
747 elines on *@<ip>, or *@<host>, and bans on <ident>@* or <ident>@<host>
748 can be negated by any eline that matches.">
750 <helpop key="wallops" value="/WALLOPS <message>
752 Sends a message to all +w users.">
754 <helpop key="rline" value="/RLINE <regex> [<duration> :<reason>]
756 Sets or removes an r-line (regex line) on a n!u@h\sgecos mask. You
757 must specify all three parameters to add an rline, and one parameter
758 to remove an rline (just the regex).
760 The duration may be specified in seconds, or in the format
761 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
762 5 minutes and 6 seconds. All fields in this format are optional.">
764 <helpop key="clearcache" value="/CLEARCACHE
766 This command clears the DNS cache of the local server.">
768 <helpop key="close" value="/CLOSE
770 Closes all unregistered connections to the local server.">
772 <helpop key="modenotice" value="/MODENOTICE <modeletters> <message>
774 Sends a notice to all users who have the given mode(s) set.
775 If multiple mode letters are given, the notice is only sent to users
776 who have all of them set.">
778 <helpop key="cloak" value="/CLOAK <host>
780 Generate the cloak of a host or IP. This is useful for example when
781 trying to get the cloak of a user from /WHOWAS and they were not
782 using their cloak when they quit.">
784 ######################
785 # User/Channel Modes #
786 ######################
788 <helpop key="umodes" value="User Modes
791 c Blocks private messages and notices from users who do
792 not share a common channel with you (requires the
794 d Deaf mode. User will not receive any messages or notices
795 from channels they are in (requires the deaf module).
796 g In combination with /ACCEPT, provides for server side
797 ignore (requires the callerid module).
798 h Marks as 'available for help' in WHOIS (IRCop only,
799 requires the helpop module).
800 i Makes invisible to /WHO if the user using /WHO is not in
802 k Prevents the user from being kicked from channels, or
803 having op modes removed from them (services only,
804 requires the servprotect module).
805 o Marks as a IRC operator.
806 s <mask> Receives server notices specified by <mask>
808 r Marks as a having a registered nickname
809 (requires the services account module).
810 w Receives wallops messages.
811 x Gives a cloaked hostname (requires the cloaking module).
812 B Marks as a bot (requires the botmode module).
813 G Censors messages sent to the user based on filters
814 configured for the network (requires the censor module).
815 H Hides an oper's oper status from WHOIS (requires the
817 I Hides a user's entire channel list in WHOIS from
818 non-IRCops (requires the hidechans module).
819 L Stops redirections done by m_redirect (mode must be
820 enabled in the config).
821 R Blocks private messages from unregistered users
822 (requires the services account module).
823 S Strips formatting codes out of private messages
824 to the user (requires the stripcolor module).
825 W Receives notification when a user uses WHOIS on them
826 (IRCop only, requires the showwhois module).">
828 <helpop key="chmodes" value="Channel Modes
831 v <nickname> Gives voice to <nickname>, allowing them to speak
832 while the channel is +m.
833 h <nickname> Gives halfop status to <nickname> (requires the
834 customprefix module).
835 o <nickname> Gives op status to <nickname>.
836 a <nickname> Gives protected status to <nickname>, preventing
837 them from being kicked (+q only, requires the
838 customprefix module).
839 q <nickname> Gives owner status to <nickname>, preventing them
840 from being kicked (Services or +q only, requires
841 the customprefix module).
843 b <hostmask> Bans <hostmask> from the channel.
844 e <hostmask> Excepts <hostmask> from bans (requires the
845 banexception module).
846 I <hostmask> Excepts <hostmask> from +i, allowing matching
847 users to join while the channel is invite-only
848 (requires the inviteexception module).
850 c Blocks messages that contain formatting codes
851 (requires the blockcolor module).
852 d <time> Blocks messages to a channel from new users
853 until they have been in the channel for <time>
854 seconds (requires the delaymsg module).
855 f [*]<lines>:<sec> Kicks on text flood equal to or above the
856 specified rate. With *, the user is banned
857 (requires the messageflood module).
858 g <mask> Blocks messages matching the given glob mask
859 (requires the chanfilter module).
860 i Makes the channel invite-only.
861 Users can only join if an operator
862 uses /INVITE to invite them.
863 j <joins>:<sec> Limits joins to the specified rate (requires
864 the joinflood module).
865 k <key> Set the channel key (password) to <key>.
866 l <limit> Set the maximum allowed users to <limit>.
867 m Enable moderation. Only users with +v, +h, or +o
869 n Blocks users who are not members of the channel
871 p Make channel private, hiding it in users' whoises
872 and replacing it with * in /LIST.
873 r Marks the channel as registered with Services
874 (requires the services account module).
875 s Make channel secret, hiding it in users' whoises
877 t Prevents users without +h or +o from changing the
879 u Makes the channel an auditorium; normal users only
880 see themselves or themselves and the operators,
881 while operators see all the users (requires the
883 w <flag>:<banmask> Adds basic channel access controls of <flag> to
884 <banmask>, via the +w listmode.
885 For example, +w o:R:Brain will op anyone identified
886 to the account 'Brain' on join.
887 (requires the autoop module)
888 z Blocks non-SSL clients from joining the channel.
890 A Allows anyone to invite users to the channel
891 (normally only chanops can invite, requires
892 the allowinvite module).
893 B Blocks messages with too many capital letters,
894 as determined by the network configuration
895 (requires the blockcaps module).
896 C Blocks any CTCPs to the channel (requires the
898 D Delays join messages from users until they message
899 the channel (requires the delayjoin module).
900 F <changes>:<sec> Blocks nick changes when they equal or exceed the
901 specified rate (requires the nickflood module).
902 G Censors messages to the channel based on the
903 network configuration (requires the censor module).
904 H <num>:<duration> Displays the last <num> lines of chat to joining
905 users. <duration> is the maximum time to keep
906 lines in the history buffer (requires the
908 J <seconds> Prevents rejoin after kick for the specified
909 number of seconds. This prevents auto-rejoin
910 (requires the kicknorejoin module).
911 K Blocks /KNOCK on the channel.
912 L <channel> If the channel reaches its limit set by +l,
913 redirect users to <channel> (requires the
915 M Blocks unregistered users from speaking (requires
916 the services account module).
917 N Prevents users on the channel from changing nick
918 (requires the nonicks module).
919 O Channel is IRCops only (can only be set by IRCops,
920 requires the operchans module).
921 P Makes the channel permanent; Bans, invites, the
922 topic, modes, and such will not be lost when it
923 empties (can only be set by IRCops, requires
924 the permchannels module).
925 Q Only ulined servers and their users can kick
926 (requires the nokicks module)
927 R Blocks unregistered users from joining (requires
928 the services account module).
929 S Strips formatting codes from messages to the
930 channel (requires the stripcolor module).
931 T Blocks /NOTICEs to the channel from users who are
932 not at least halfop (requires the nonotice module).
933 X <type>:<status> Makes users of <status> or higher exempt to the
934 specified restriction <type>. For example: flood:h
935 (requires the exemptchanops module).
936 Possible restriction types to exempt with +X are:
938 auditorium-see Permission required to see the full user list of
939 a +u channel (requires the auditorium module).
940 auditorium-vis Permission required to be visible in a +u channel
941 (requires the auditorium module).
942 blockcaps Channel mode +B
943 blockcolor Channel mode +c
944 censor Channel mode +G
945 filter Channel mode +g
946 flood Channel mode +f
947 nickflood Channel mode +F
948 noctcp Channel mode +C
949 nonick Channel mode +N
950 nonotice Channel mode +T
951 regmoderated Channel mode +M
952 stripcolor Channel mode +S
953 topiclock Channel mode +t
956 NOTE: A large number of these modes are dependent upon server-side modules
957 being loaded by a server/network administrator. The actual modes available
958 on your network may be very different to this list. Please consult your
959 help channel if you have any questions.">
961 ######################
963 ######################
965 <helpop key="stats" value="/STATS <symbol>
967 Shows various server statistics. Depending on configuration, some
968 symbols may be only available to opers.
972 e Show E-lines (local ban exemptions)
973 g Show G-lines (host bans)
974 k Show K-lines (local host bans)
975 q Show Q-lines (nick mask bans)
976 R Show R-lines (regular expression bans)
977 Z Show Z-lines (IP mask bans)
984 d Show configured DNSBLs and related statistics
985 m Show command statistics, number of times commands have been used
986 o Show a list of all valid oper usernames and hostmasks
987 p Show open client ports, and the port type (ssl, plaintext, etc)
989 z Show memory usage statistics
990 i Show connect class permissions
991 l Show all client connections with information (sendq, commands, bytes, time connected)
992 L Show all client connections with information and IP address
993 P Show online opers and their idle times
994 T Show bandwidth/socket statistics
995 U Show U-lined servers
996 Y Show connection classes
997 O Show opertypes and the allowed user and channel modes it can set
998 E Show socket engine events
999 S Show currently held registered nicknames
1000 G Show how many local users are connected from each country according to GeoIP
1002 Note that all /STATS use is broadcast to online IRC operators.">
1004 ######################
1006 ######################
1008 <helpop key="snomasks" value="Server Notice Masks
1010 a Allows receipt of local announcement messages.
1011 A Allows receipt of remote announcement messages.
1012 c Allows receipt of local connect messages.
1013 C Allows receipt of remote connect messages.
1014 d Allows receipt of general (and sometimes random) debug messages.
1015 f Allows receipt of flooding notices.
1016 g Allows receipt of globops (requires the globops module).
1017 j Allows receipt of channel creation notices (requires the chancreate module).
1018 J Allows receipt of remote channel creation notices (requires the chancreate module).
1019 k Allows receipt of local kill messages.
1020 K Allows receipt of remote kill messages.
1021 l Allows receipt of local linking related messages.
1022 L Allows receipt of remote linking related messages.
1023 n See local nickname changes (requires the seenicks module).
1024 N See remote nickname changes (requires the seenicks modules).
1025 o Allows receipt of oper-up, oper-down, and oper-failure messages.
1026 O Allows receipt of remote oper-up, oper-down, and oper-failure messages.
1027 q Allows receipt of local quit messages.
1028 Q Allows receipt of remote quit messages.
1029 r Allows receipt of local oper commands (requires the operlog module).
1030 R Allows receipt of remote oper commands (requires the operlog module).
1031 t Allows receipt of attempts to use /STATS (local and remote).
1032 v Allows receipt of oper-override notices (requires the override module).
1033 x Allows receipt of local Xline notices (g/Z/q/k/e/R/shuns).
1034 X Allows receipt of remote Xline notices (g/Z/q/k/e/R/shuns).">
1036 ######################
1038 ######################
1040 <helpop key="extbans" value="Extended Bans
1043 Extbans are split into two types; matching extbans, which match on
1044 users in additional ways, and acting extbans, which restrict users
1045 in different ways to a standard ban.
1047 To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
1048 instead of a normal nick!user@host mask, to ban or exempt matching
1049 users. Ban exceptions on acting extbans exempt that user from matching
1050 an extban of that type, and from any channel mode corresponding to the
1051 restriction. Matching extbans may also be used for invite exceptions by
1052 setting +I <extban>.
1056 j:<channel> Matches anyone in the given channel. Does not support
1057 wildcards (requires the channelban module).
1058 r:<realname> Matches users with a matching realname (requires the
1060 s:<server> Matches users on a matching server (requires the
1062 z:<certfp> Matches users having the given SSL certificate
1063 fingerprint (requires the sslmodes module).
1064 O:<opertype> Matches IRCops of a matching type, mostly useful as an
1065 an invite exception (requires the operchans module).
1066 R:<account> Matches users logged into a matching account (requires
1067 the services account module).
1068 U:<banmask> Matches unregistered users matching the given banmask.
1069 (requires the services account module).
1073 c:<banmask> Blocks any messages that contain formatting codes from
1074 matching users (requires the blockcolor module).
1075 m:<banmask> Blocks messages from matching users (requires the muteban
1076 module). Users with +v or above are not affected.
1077 p:<banmask> Blocks part messages from matching users (requires
1078 the nopartmsg module).
1079 A:<banmask> Blocks invites by matching users even when +A is set
1080 (requires the allowinvite module).
1081 B:<banmask> Blocks all capital or nearly all capital messages from
1082 matching users (requires the blockcaps module).
1083 C:<banmask> Blocks CTCPs from matching users (requires the noctcp
1085 N:<banmask> Blocks nick changes from matching users (requires
1086 the nonicks module).
1087 Q:<banmask> Blocks kicks by matching users (requires the nokicks
1089 S:<banmask> Strips formatting codes from messages from matching
1090 users (requires the stripcolor module).
1091 T:<banmask> Blocks notices from matching users (requires the
1094 A ban given to an Acting extban may either be a nick!user@host mask
1095 (unless stated otherwise), matched against users as for a normal ban,
1096 or a Matching extban.
1098 There is an additional special type of extended ban, a redirect ban:
1100 Redirect n!u@h#channel will redirect the banned user to #channel
1101 when they try to join (requires the banredirect module).">