# Sample configuration file for the help module.
# You can either copy this into your conf folder and set up the module to use it,
# or you can customize the responses for your network and/or add more.
#
# The way the new help system works is simple. You use one or more helptopic tags.
# <helptopic key="moo" title="something here" value="something here">
# key is what the user is looking for (i.e. /HELP moo), title is the title, and
# value is what they get back
# (note that it can span multiple lines!).
# -- w00t 16/dec/2006
#
<alias text="HELPOP" replace="HELP $2-">
<helpmsg nohelp="There is no help for the topic you searched for. Please try again.">
<helptopic key="start" title="InspIRCd Help System" value="
This system provides help for commands and modes.
Specify your question or a command name as the
parameter for this command.
/HELP CUSER - To see a list of user commands
/HELP COPER - To see a list of oper commands
/HELP UMODES - To see a list of user modes
/HELP CHMODES - To see a list of channel modes
/HELP SNOMASKS - To see a list of oper snotice masks
/HELP EXTBANS - To see a list of extended bans
/HELP INDEX - To see a list of help topics
">
<helptopic key="cuser" title="User Commands" value="
ACCEPT ADMIN AWAY COMMANDS CYCLE DCCALLOW
HEXIP INFO INVITE ISON JOIN KICK
KNOCK LINKS LIST LUSERS MAP MKPASSWD
MODE MODULES MONITOR MOTD NAMES NICK
NOTICE OPER PART PASS PING PONG
PRIVMSG QUIT REMOVE SERVLIST SETNAME SILENCE
SQUERY SSLINFO STATS TBAN TIME TITLE
TOPIC UNINVITE USER USERHOST VERSION VHOST
WATCH WHO WHOIS WHOWAS
">
<helptopic key="squery" title="/SQUERY <target> :<message>" value="
Sends a message to the network service specified in <target>.
">
<helptopic key="servlist" title="/SERVLIST [<nick> [<oper-type>]]" value="
List network services that are currently connected to the network and
visible to you. The optional glob-based nick and oper-type parameters
match against the nickname of the network service and the oper type of
the network service.
">
<helptopic key="sslinfo" title="/SSLINFO [<chan>|<nick>]" value="
If a channel is specified then display TLS connection information
for users in the specified channel.
If a user is specified then display information on the TLS connection
and certificate of the specified user.
If no target is specified then display information on the TLS
connection and certificate of the executing user.
">
<helptopic key="uninvite" title="/UNINVITE <nick> <channel>" value="
Uninvite a user from a channel, same syntax as INVITE.
">
<helptopic key="tban" title="/TBAN <channel> <duration> <banmask>" value="
Sets a timed ban. The duration of the ban can be specified in the
form of 1y2w3d4h5m6s - meaning one year, two weeks, three days,
four hours, five minutes and six seconds. All fields in this
format are optional. Alternatively, the ban may just be specified
as a number of seconds. All timed bans appear in the banlist as
normal bans and may be safely removed before their time is up.
">
<helptopic key="dccallow" title="/DCCALLOW [(+|-)<nick> [<time>]]|[LIST|HELP]" value="
/DCCALLOW - List allowed nicks
/DCCALLOW LIST - This also lists allowed nicks
/DCCALLOW +<nick> [<duration>] - Add a nick
/DCCALLOW -<nick> - Remove a nick
/DCCALLOW HELP - Display help
Duration is optional, and may be specified in seconds or in the
form of 1y2w3d4h5m6s - meaning one year, two weeks, three days,
four hours, five minutes and six seconds. All fields in this
format are optional.
">
<helptopic key="accept" title="/ACCEPT *|(+|-)<nick>[,(+|-)<nick>]+" value="
Manages your accept list. This list is used to determine who can
private message you when you have user mode +g set.
/ACCEPT * - List accepted nicks
/ACCEPT +<nick> - Add a nick
/ACCEPT -<nick> - Remove a nick
This command accepts multiple nicks like so:
/ACCEPT +<nick>,-<nick>,+<nick>
">
<helptopic key="cycle" title="/CYCLE <channel> [:<reason>]" value="
Cycles a channel (leaving and rejoining), overrides restrictions that
would stop a new user joining, such as user limits and channel keys.
">
<helptopic key="title" title="/TITLE <username> <password>" value="
Authenticate for a WHOIS title line and optionally a vhost using the
specified username and password.
">
<helptopic key="watch" title="/WATCH C|L|l|S|(+|-)<nick> [(+|-)<nick>]+" value="
/WATCH - List watched nicks that are online
/WATCH l - List watched nicks that are online
/WATCH L - List watched nicks, online and offline
/WATCH C - Clear all watched nicks
/WATCH S - Show statistics
/WATCH +<nick> - Add a nick
/WATCH -<nick> - Remove a nick
This command accepts multiple nicks like so:
/WATCH +<nick> -<nick> +<nick>
">
<helptopic key="monitor" title="/MONITOR C|L|S|(+|-) <nick>[,<nick>]+" value="
/MONITOR L - List all monitored nicks, not differentiating between
online and offline nicks
/MONITOR C - Clear all monitored nicks
/MONITOR S - List all monitored nicks, indicating which are online
and which are offline
/MONITOR + <nick> - Add a nick
/MONITOR - <nick> - Remove a nick
This command accepts multiple nicks like so:
/MONITOR + <nick>,<nick>,<nick>
/MONITOR - <nick>,<nick>,<nick>
">
<helptopic key="vhost" title="/VHOST <username> <password>" value="
Authenticate for a vhost using the specified username and password.
">
<helptopic key="remove" title="/REMOVE <channel> <nick> [:<reason>]" value="
Removes a user from a channel you specify. You must be at least a
channel halfoperator to remove a user. A removed user will part with
a message stating they were removed from the channel and by whom.
">
<helptopic key="rmode" title="/RMODE <channel> <mode> [<pattern>]" value="
Removes list and prefix modes from the specified channel. If a pattern is
specified then all modes matching the specified pattern will be removed. If
removing a list mode and the pattern is the nick of an online user then all
modes in the list matching the specified user will be removed.
">
<helptopic key="hexip" title="/HEXIP <hex-ip|raw-ip>" value="
If the specified argument is a raw IP address then respond with the
hex encoded equivalent as if sent by a username gateway. Otherwise, if
the specified argument is a hex encoded IP address then respond with
the equivalent raw IP address.
">
<helptopic key="silence" title="/SILENCE [(+|-)<mask> [CcdiHNnPpTtx]]" value="
A server-side ignore of the given n!u@h mask. If the optional flags field is
specified then it must contain one or more flags which specify what kind of
messages should be blocked and how they should be blocked.
/SILENCE - Shows a list of silenced masks
/SILENCE +<mask> [<flags>] - Add a mask
/SILENCE -<mask> - Remove a mask
Valid SILENCE Flags
-------------------
C Matches a CTCP targeted at a user.
c Matches a CTCP targeted at a channel.
d Default behaviour; equivalent to CciNnPpTt.
H Hide the contents of messages instead of blocking.
i Matches an invite to a channel.
N Matches a NOTICE targeted at a user.
n Matches a NOTICE targeted at a channel.
P Matches a PRIVMSG targeted at a user.
p Matches a PRIVMSG targeted at a channel.
T Matches a TAGMSG targeted at a user.
t Matches a TAGMSG targeted at a channel.
x Exempt the mask from silence rules.
Any combination of flags is valid.
">
<helptopic key="knock" title="/KNOCK <channel> :<reason>" value="
Sends a notice to a channel indicating you wish to join.
">
<helptopic key="user" title="/USER <username> <unused> <unused> :<realname>" value="
This command is used by your client to register your
IRC session, providing your username and real name to
the server.
You should not use it during an established connection.
">
<helptopic key="nick" title="/NICK <newnick>" value="
Change your nickname to <newnick>.
">
<helptopic key="quit" title="/QUIT [:<message>]" value="
Quit from IRC and end your current session.
">
<helptopic key="version" title="/VERSION [<servername>]" value="
Returns the server's version information.
">
<helptopic key="ping" title="/PING <cookie> [<servername>]" value="
Ping a server. The server will answer with a PONG.
">
<helptopic key="pong" title="/PONG <cookie> [<servername>]" value="
Your client should send this to answer server PINGs. You
should not issue this command manually.
">
<helptopic key="prop" title="/PROP <target> [(+|-)<name> [<value>]]+" value="
Allows users to add, remove, and view the modes of a specific target.
">
<helptopic key="admin" title="/ADMIN [<servername>]" value="
Shows the administrative information for the given server.
">
<helptopic key="privmsg" title="/PRIVMSG <target>[,<target>]+ :<message>" value="
Sends a message to a user or channel specified in <target>.
">
<helptopic key="notice" title="/NOTICE <target>[,<target>]+ :<message>" value="
Sends a notice to a user or channel specified in <target>.
">
<helptopic key="join" title="/JOIN <channel>[,<channel>]+ [<key>[,<key>]+]" value="
Joins one or more channels you provide the names for.
">
<helptopic key="names" title="/NAMES [<channel>[,<channel>]+]" value="
Return a list of users on the channel(s) you provide.
">
<helptopic key="part" title="/PART <channel>[,<channel>]+ [:<reason>]" value="
Leaves one or more channels you specify.
">
<helptopic key="kick" title="/KICK <channel> <nick>[,<nick>]+ [:<reason>]" value="
Kicks a user from a channel you specify. You must be
at least a channel halfoperator to kick a user.
">
<helptopic key="mode" title="/MODE <target> [[(+|-)]<modes> [<mode-parameters>]]" value="
Change or view modes of <target>.
/MODE <target> - Show modes of <target>.
/MODE <channel> <list mode char> - List bans, exceptions, etc. set on <channel>.
Sets the mode for a channel or a nickname specified in <target>.
A user may only set modes upon themselves, and may not set the
+o user mode, and a user may only change channel modes of
channels where they are at least a halfoperator.
For a list of all user and channel modes, enter /HELP UMODES or /HELP CHMODES.
">
<helptopic key="topic" title="/TOPIC <channel> [:<topic>]" value="
Sets or retrieves the channel topic. If a channel topic is
given in the command and either the channel is not +t, or
you are at least a halfoperator, the channel topic will be
changed to the new one you provide.
">
<helptopic key="who" title="/WHO <pattern> [<flags>][%[<fields>[,<querytype>]]] <pattern>" value="
Looks up information about users matching the provided pattern. You can specify
a flag specific pattern, a channel name, user hostname, a user server name, a
user real name, or a user nickname. Matching users will only be included in the
WHO response if:
1) The specified pattern is an exact channel name that does not have the
private or secret channel modes set and the user does not have the invisible
user mode set.
2) The specified pattern is an exact nickname.
3) You share one or more common channels with the user.
4) The user does not have the invisible user mode set.
5) You are a server operator with the users/auspex privilege.
If you specify any fields the response returned will be a WHOX response rather
than a RFC 1459 WHO response.
Valid WHO Flags
---------------
The following flags use <pattern> to match against the specified user data:
A Show users who have an away message matching <pattern>.
a Show users who have an account name matching <pattern>.
G Show users who are connecting from a country code matching <pattern>.
Requires the geoban module.
h Show users who have a hostname matching <pattern>. If the 'x' modifier
is specified then this will match against the real hostname instead of
the display hostname.
i Show users who have an IP address matching <pattern>.
m Show users who have the modes listed in <pattern>. The pattern
should be in the same format as a mode change e.g. +ow-i (server
operators only).
n Show users who have a nickname matching <pattern>.
p Show users who are connected to a port in the <pattern> range (server
operators only).
r Show users who have a real name matching <pattern>.
s Show users who are on a server with a name matching <pattern>. If the 'x'
modifier is specified then this will match against the real server name
instead of the masked server name.
t Show users who have connected in the last <pattern> seconds.
u Show users who have a username matching <pattern>.
The following flags filter users by their status:
f Only show users on remote (far) servers.
l Only show users on the local server.
o Only show server operators.
The following flags modify the command output:
x Show sensitive data like real user hostnames and, when hideserver is
enabled, real server hostnames.
You may combine one flag from the first group and multiple from the others in
one WHO command.
Valid WHO Fields
----------------
a Include the user's account name in the response.
c Include the first common channel name in the response.
d Include the user's server distance from you in the response.
f Include the user's away status, oper status, and highest channel prefix
in the response.
h Include the user's hostname in the response. If the 'x' flag was
specified then this is the real host rather than the display host.
i Include the user's IP address in the response.
l Include the user's idle time in the response.
n Include the user's nickname in the response.
o Include the user's channel operator rank level in the response.
r Include the user's real name in the response.
s Include the user's server name in the response. If the 'x' flag was
specified then this is the real server name rather than the masked server
name.
t Include the query type in the response.
u Include the user's username in the response.
">
<helptopic key="motd" title="/MOTD [<servername>]" value="
Show the message of the day for <server>. Messages of the day often
contain important server rules and notices and should be read prior
to using a server.
">
<helptopic key="oper" title="/OPER <username> [<password>]" value="
Attempts to authenticate as a server operator.
Both successful and unsuccessful oper attempts are
logged, and sent to online server operators.
">
<helptopic key="list" title="/LIST [<pattern>]" value="
Creates a list of all existing channels matching the glob pattern
<pattern>, e.g. *chat* or bot*.
">
<helptopic key="lusers" title="/LUSERS" value="
Shows a count of local and remote users, servers and channels.
">
<helptopic key="userhost" title="/USERHOST <nick> [<nick>]+" value="
Returns the hostname and nickname of a user, and some other
miscellaneous information.
">
<helptopic key="away" title="/AWAY [:<message>]" value="
If a message is given, marks you as being away, otherwise
removes your away status and previous message.
">
<helptopic key="ison" title="/ISON <nick> [<nick>]+" value="
Returns a subset of the nicks you give, showing only those
that are currently online.
">
<helptopic key="invite" title="/INVITE [<nick> <channel> [<time>]]" value="
Invites a user to a channel. If the channel is NOT +A, only
channel halfoperators or above can invite people. If +A is set,
anyone can invite people to the channel, as long as the person
doing the invite is a member of the channel they wish to invite
the user to.
Invited users may override bans, +k, and similar in addition to
+i, depending on configuration.
If a time is provided, the invite expires after that time and the user
can no longer use it to enter the channel. The time can be specified
in the form of 1y2w3d4h5m6s - meaning one year, two weeks, three days,
four hours, five minutes and six seconds. All fields in this format
are optional. Alternatively, the time may just be specified as a number
of seconds.
/INVITE without a parameter will list pending invitations for channels
you have been invited to.
">
<helptopic key="pass" title="/PASS <password>" value="
This command is used by your client when setting up
your IRC session to submit a server password to the
server.
You should not use it during an established connection.
">
<helptopic key="whowas" title="/WHOWAS <nick> [<count>]" value="
Returns a list of times the user was seen recently on IRC along with
the time they were last seen and their server.
If <count> is given, only return the <count> most recent entries.
">
<helptopic key="links" title="/LINKS" value="
Shows all linked servers.
">
<helptopic key="map" title="/MAP" value="
Shows a graphical representation of all users and servers on the
network, and the links between them, as a tree from the perspective
of your server.
">
<helptopic key="whois" title="/WHOIS [<servername>] <nick>[,<nick>]+" value="
Returns the WHOIS information of a user, their channels, hostname,
etc. If a servername is provided, then a whois is performed from
the server where the user is actually located rather than locally,
showing idle and signon times.
">
<helptopic key="time" title="/TIME [<servername>]" value="
Returns the local time of the server, or remote time of another
server.
">
<helptopic key="info" title="/INFO [<servername>]" value="
Returns information on the developers and supporters who made this
IRC server possible.
">
<helptopic key="setname" title="/SETNAME :<realname>" value="
Sets your real name to the specified real name.
">
<helptopic key="coper" title="Oper Commands" value="
ALLTIME CBAN CHECK CHGHOST CHGIDENT
CHGNAME CLEARCHAN CLOAK CONNECT DIE
ELINE FILTER GLINE GLOADMODULE GLOBOPS
GRELOADMODULE GUNLOADMODULE KILL KLINE LOADMODULE
NICKLOCK NICKUNLOCK OJOIN OPERMOTD QLINE
RCONNECT REHASH RELOADMODULE RESTART RLINE
RSQUIT SAJOIN SAKICK SAMODE SANICK
SAPART SAQUIT SATOPIC SETHOST SETIDENT
SETIDLE SHUN SQUIT SWHOIS TLINE
UNLOADMODULE WALLOPS ZLINE
">
<helptopic key="tline" title="/TLINE <mask>" value="
This command returns the number of local and global clients matched,
and the percentage of clients matched, plus how they were matched
(by IP address or by hostname). Mask should be given as either
nick!user@host or user@IP (wildcards and CIDR blocks are accepted).
">
<helptopic key="filter" title="/FILTER <pattern> [<action> <flags> [<duration>] :<reason>]" value="
This command will add a global filter when more than one parameter is
given, for messages of the types specified by the flags, with the given
filter pattern, action, duration (when the action is 'gline', 'zline'
or 'shun'), and reason.
The filter will take effect when a message of any type specified by
the flags and matching the pattern is sent to the server, and
perform the specified action.
Valid FILTER Actions
--------------------
None Does nothing
Warn Lets the message through and informs +s server operators
of the message and all relevant info
Block Blocks message and informs +s server operators of the blocked
message and all relevant info
Silent Blocks message, but does not notify server operators
Kill Kills the user
Gline G-lines the user for the specified duration
Zline Z-lines the user for the specified duration
Shun Shuns the user for the specified duration (requires the shun module)
Valid FILTER Flags
------------------
p Block private and channel messages
n Block private and channel notices
P Block part messages
q Block quit messages
o Don't match against opers
r Don't match against registered users
c Strip all formatting codes from the message before matching
* Represents all of the above flags except r
- Does nothing, a non-op for when you do not want to specify any
flags
The reason for the filter will be used as the reason for the action,
unless the action is 'none', and is sent to the user when their text is
blocked by 'block' and 'silent' actions.
A G-line, Z-line or shun duration may be specified in seconds, or in the
format 1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours, 5
minutes and 6 seconds. All fields in this format are optional.
When only one parameter is provided (the filter pattern) the provided
filter will be removed. Note that if you remove a
configuration-defined filter, it will reappear at next rehash unless
it is also removed from the config file.
">
<helptopic key="ojoin" title="/OJOIN <channel>" value="
Force joins you to the specified channel, and gives you +Y and any other
configuration-defined modes on it, preventing you from being kicked.
Depending on configuration, may announce that you have joined the
channel on official network business.
">
<helptopic key="check" title="/CHECK <nick>|<ipmask>|<hostmask>|<channel> [<servername>]" value="
Allows opers to look up advanced information on nicknames, IP addresses,
hostmasks or channels, in a similar way to WHO but in more detail,
displaying most information the server has stored on the target,
including all metadata.
With the second parameter given, runs the command remotely on the
specified server, useful especially if used on a nickname that is
online on a remote server.
">
<helptopic key="alltime" title="/ALLTIME" value="
Shows the date and time of all servers on the network.
">
<helptopic key="rconnect" title="/RCONNECT <remote-server-mask> <target-server-mask>" value="
The server matching <remote-server-mask> will try to connect to the first
server in the config file matching <target-server-mask>.
">
<helptopic key="rsquit" title="/RSQUIT <target-server-mask> [:<reason>]" value="
Causes a remote server matching <target-server-mask> to be disconnected from
the network.
">
<helptopic key="globops" title="/GLOBOPS :<message>" value="
Sends a message to all users with the +g snomask.
">
<helptopic key="cban" title="/CBAN <channelmask> [[<duration>] :<reason>]" value="
Sets or removes a global channel based ban. You must specify two or more parameters
to add a ban, and one parameter to remove a ban (just the channelmask).
The duration may be specified in seconds, or in the format
1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
five minutes and six seconds. All fields in this format are optional.
">
<helptopic key="sajoin" title="/SAJOIN [<nick>] <channel>[,<channel>]+" value="
Forces the user to join the channel(s).
If no nick is given, it joins the oper doing the /SAJOIN.
">
<helptopic key="sapart" title="/SAPART <nick> <channel>[,<channel>]+ [:<reason>]" value="
Forces the user to part the channel(s), with an optional reason.
">
<helptopic key="samode" title="/SAMODE <target> (+|-)<modes> [<mode-parameters>]" value="
Applies the given mode change to the channel or nick specified.
">
<helptopic key="sanick" title="/SANICK <nick> <newnick>" value="
Changes the user's nick to the new nick.
">
<helptopic key="sakick" title="/SAKICK <channel> <nick> [:<reason>]" value="
Kicks the given user from the specified channel, with an optional reason.
">
<helptopic key="satopic" title="/SATOPIC <channel> :<topic>" value="
Applies the given topic to the specified channel.
">
<helptopic key="saquit" title="/SAQUIT <nick> :<reason>" value="
Forces user to quit with the specified reason.
">
<helptopic key="setidle" title="/SETIDLE <duration>" value="
Sets your idle time to the specified value.
The time can be specified in the form of 1y2w3d4h5m6s - meaning one year,
two weeks, three days, four hours, five minutes and six seconds.
All fields in this format are optional. Alternatively, the time may
just be specified as a number of seconds.
">
<helptopic key="sethost" title="/SETHOST <host>" value="
Sets your host to the specified host.
">
<helptopic key="setident" title="/SETIDENT <username>" value="
Sets your username to the specified value.
">
<helptopic key="swhois" title="/SWHOIS <nick> :<swhois>" value="
Sets the user's swhois field to the given swhois message.
This will be visible in their /WHOIS.
To remove this message again, use:
/SWHOIS <nick> :
">
<helptopic key="mkpasswd" title="/MKPASSWD <hashtype> <plaintext>" value="
Encodes the plaintext to a hash of the given type and displays
the result.
">
<helptopic key="opermotd" title="/OPERMOTD [<servername>]" value="
Displays the Oper MOTD.
">
<helptopic key="nicklock" title="/NICKLOCK <nick> <newnick>" value="
Changes the user's nick to the new nick, and forces
it to remain as such for the remainder of the session.
">
<helptopic key="nickunlock" title="/NICKUNLOCK <nick>" value="
Allows a previously locked user to change nicks again.
">
<helptopic key="chghost" title="/CHGHOST <nick> <host>" value="
Changes the host of the user to the specified host.
">
<helptopic key="chgname" title="/CHGNAME <nick> :<realname>" value="
Changes the real name of the user to the specified real name.
">
<helptopic key="chgident" title="/CHGIDENT <nick> <username>" value="
Changes the username of the user to the specified value.
">
<helptopic key="shun" title="/SHUN <nick!user@host>[,<nick!user@host>]+ [[<duration>] :<reason>]" value="
Sets or removes a shun (global server-side ignore) on a nick!user@host mask.
You must specify two or more parameters to add a shun, and one parameter
to remove a shun (just the nick!user@host).
The duration may be specified in seconds, or in the format
1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
five minutes and six seconds. All fields in this format are optional.
">
<helptopic key="die" title="/DIE <servername>" value="
This command shuts down the local server. A single parameter is
required, which must match the name of the local server.
">
<helptopic key="restart" title="/RESTART <servername>" value="
This command restarts the local server. A single parameter is
required, which must match the name of the local server.
">
<helptopic key="commands" title="/COMMANDS" value="
Shows all currently available commands.
">
<helptopic key="kill" title="/KILL <nick>[,<nick>]+ :<reason>" value="
This command will disconnect a user from IRC with the given reason.
">
<helptopic key="rehash" title="/REHASH [<servermask>]" value="
This command will cause the server configuration file to be reread and
values reinitialized for all servers matching the server mask, or the
local server if one is not specified.
">
<helptopic key="connect" title="/CONNECT <servermask>" value="
Add a connection to the server matching the given server mask. You must
have configured the server for linking in your configuration file
before trying to link them.
">
<helptopic key="squit" title="/SQUIT <servermask>" value="
Disconnects the server matching the given server mask from this server.
">
<helptopic key="modules" title="/MODULES [<servername>]" value="
Lists currently loaded modules, their memory offsets, version numbers,
and flags. If you are not an operator, you will see reduced detail.
">
<helptopic key="loadmodule" title="/LOADMODULE <modulename>" value="
Loads the specified module into the local server.
">
<helptopic key="unloadmodule" title="/UNLOADMODULE <modulename>" value="
Unloads a module from the local server.
">
<helptopic key="reloadmodule" title="/RELOADMODULE <modulename>" value="
Unloads and reloads a module on the local server.
">
<helptopic key="gloadmodule" title="/GLOADMODULE <modulename> [<servermask>]" value="
Loads the specified module on all linked servers.
">
<helptopic key="gunloadmodule" title="/GUNLOADMODULE <modulename> [<servermask>]" value="
Unloads a module from all linked servers.
">
<helptopic key="greloadmodule" title="/GRELOADMODULE <modulename> [<servermask>]" value="
Unloads and reloads a module on all linked servers.
">
<helptopic key="kline" title="/KLINE <user@host>[,<user@host>]+ [[<duration>] :<reason>]" value="
Sets or removes a K-line (local user@host based ban) on a user@host mask.
You must specify two or more parameters to add a ban, and one parameter
to remove a ban (just the user@host).
The duration may be specified in seconds, or in the format
1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
five minutes and six seconds. All fields in this format are optional.
">
<helptopic key="zline" title="/ZLINE <ipmask>[,<ipmask>]+ [[<duration>] :<reason>]" value="
Sets or removes a Z-line (global IP based ban) on an IP mask.
You must specify two or more parameters to add a ban, and one parameter
to remove a ban (just the ipmask).
The duration may be specified in seconds, or in the format
1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
five minutes and six seconds. All fields in this format are optional.
">
<helptopic key="qline" title="/QLINE <nickmask>[,<nickmask>]+ [[<duration>] :<reason>]" value="
Sets or removes a Q-line (global nick based ban) on a nick mask.
You must specify two or more parameters to add a ban, and one parameter
to remove a ban (just the nickmask).
The duration may be specified in seconds, or in the format
1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
five minutes and six seconds. All fields in this format are optional.
">
<helptopic key="gline" title="/GLINE <user@host>[,<user@host>]+ [[<duration>] :<reason>]" value="
Sets or removes a G-line (global user@host based ban) on a user@host mask.
You must specify two or more parameters to add a ban, and one
parameter to remove a ban (just the user@host).
The duration may be specified in seconds, or in the format
1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
five minutes and six seconds. All fields in this format are optional.
">
<helptopic key="eline" title="/ELINE <user@host>[,<user@host>]+ [[<duration>] :<reason>]" value="
Sets or removes a E-line (global user@host ban exception) on a user@host mask.
You must specify at least 3 parameters to add an exception, and one
parameter to remove an exception (just the user@host).
The duration may be specified in seconds, or in the format
1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
five minutes and six seconds. All fields in this format are optional.
This command has a few important limitations. Bans on *@<ip> can only
be negated by an E-line on *@<ip>, bans on *@<host> can be negated by
E-lines on *@<ip>, or *@<host>, and bans on <user>@* or <user>@<host>
can be negated by any E-line that matches.
">
<helptopic key="wallops" title="/WALLOPS :<message>" value="
Sends a message to all +w users.
">
<helptopic key="rline" title="/RLINE <regex> [[<duration>] :<reason>]" value="
Sets or removes an R-line (global regex ban) on a n!u@h\srealname mask. You
must specify two or more parameters to add an R-line, and one parameter
to remove an R-line (just the regex).
The duration may be specified in seconds, or in the format
1y2w3d4h5m6s - meaning one year, two weeks, three days, four hours,
five minutes and six seconds. All fields in this format are optional.
">
<helptopic key="clearchan" title="/CLEARCHAN <channel> [KILL|KICK|G|Z] [:<reason>]" value="
Quits or kicks all non-opers from a channel, optionally G/Z-lines them.
Useful for quickly nuking bot channels.
The default method, KILL, simply disconnects the victims from the server,
while methods G and Z also add G/Z-lines for all the targets.
When used, the victims won't see each other getting kicked or quitting.
">
<helptopic key="cloak" title="/CLOAK <host>" value="
Generate the cloak of a host or IP. This is useful for example when
trying to get the cloak of a user from /WHOWAS and they were not
using their cloak when they quit.
">
<helptopic key="umodes" title="User Modes" value="
c Blocks private messages and notices from users who do
not share a common channel with you (requires the
commonchans module).
d Deaf mode. User will not receive any messages or notices
from channels they are in (requires the deaf module).
g In combination with /ACCEPT, provides for server-side
ignore (requires the callerid module).
h Marks as 'available for help' in WHOIS (server operators
only, requires the helpmode module).
i Makes invisible to /WHO if the user using /WHO is not in
a common channel.
k Prevents the user from being kicked from channels, or
having op modes removed from them (services only,
requires the services module).
o Marks as a server operator.
s <mask> Receives server notices specified by <mask>
(server operators only).
r Marks as a having a registered nickname
(requires the account module).
w Receives wallops messages.
x Gives a cloaked hostname (requires the cloak module).
z Only allow private messages from TLS users (requires
the sslmodes module).
B Marks as a bot (requires the botmode module).
D Privdeaf mode. User will not receive any private messages
or notices from users (requires the deaf module).
H Hides an oper's oper status from WHOIS (requires the
hideoper module).
I Hides a user's entire channel list in WHOIS from
non-server operators (requires the hidechans module).
L Stops redirections done by the redirect module (requires
the redirect module).
N Allows users to opt-out of receiving channel history
(requires the chanhistory module).
O Allows server operators to opt-in to overriding
restrictions (requires the override module).
R Blocks private messages from unregistered users
(requires the account module).
S Strips formatting codes out of private messages
to the user (requires the stripcolor module).
T Enables blocking private messages that contain CTCPs
(requires the noctcp module).
W Receives notifications when a user uses WHOIS on them
(server operators only, requires the showwhois module).
">
<helptopic key="chmodes" title="Channel Modes" value="
v <nickname> Gives voice to <nickname>, allowing them to speak
while the channel is +m.
h <nickname> Gives halfop status to <nickname> (requires the
customprefix module).
o <nickname> Gives op status to <nickname>.
a <nickname> Gives protected status to <nickname>, preventing
them from being kicked (+q only, requires the
customprefix module).
q <nickname> Gives owner status to <nickname>, preventing them
from being kicked (Services or +q only, requires
the customprefix module).
y <nickname> Grants the server operator-only channel operprefix
status to <nickname>. Can not be directly set by users,
gets set automatically on server operators.
(requires the operprefix module).
Y <nickname> Grants the server operator-only channel official-join
status to <nickname>. Can not be directly set by users,
use /OJOIN to have it set (requires the ojoin module).
b <hostmask> Bans <hostmask> from the channel.
e <hostmask> Excepts <hostmask> from bans (requires the
banexception module).
I <hostmask> Excepts <hostmask> from +i, allowing matching
users to join while the channel is invite-only
(requires the inviteexception module).
c Blocks messages that contain formatting codes
(requires the blockcolor module).
d <time> Blocks messages to a channel from new users
until they have been in the channel for <time>
seconds (requires the delaymsg module).
f [*]<lines>:<sec> Kicks on text flood equal to or above the
specified rate. With *, the user is banned
(requires the messageflood module).
g <mask> Blocks messages matching the given glob mask
(requires the chanfilter module).
i Makes the channel invite-only.
Users can only join if an operator
uses /INVITE to invite them.
j <joins>:<sec> Limits joins to the specified rate (requires
the joinflood module).
k <key> Set the channel key (password) to <key>.
l <limit> Set the maximum allowed users to <limit>.
m Enable moderation. Only users with +v, +h, or +o
can speak.
n Blocks users who are not members of the channel
from messaging it.
p Hides the channel in /WHOIS from people who are not a member.
You probably want the s (secret) channel mode rather than this.
r Marks the channel as registered with Services
(requires the account module).
s Hides the channel in /WHOIS and /LIST from people who are not a member.
t Prevents users without +h or +o from changing the
topic.
u Makes the channel an auditorium; normal users only
see themselves or themselves and the operators,
while operators see all the users (requires the
auditorium module).
w <flag>:<banmask> Adds basic channel access controls of <flag> to
<banmask>, via the +w listmode.
For example, +w o:R:Brain will op anyone identified
to the account 'Brain' on join.
(requires the autoop module)
z Blocks non-TLS clients from joining the channel
(requires the sslmodes module).
A Allows anyone to invite users to the channel
(normally only chanops can invite, requires
the allowinvite module).
B {ban|block|mute|kick|kickban}:<minlen>:<percent>
Blocks messages with too many capital letters,
as determined by the network configuration
(requires the anticaps module).
C Blocks any CTCPs to the channel (requires the
noctcp module).
D Delays join messages from users until they message
the channel (requires the delayjoin module).
E [~|*]<lines>:<sec>[:<difference>][:<backlog>] Allows blocking of
similar messages (requires the repeat module).
Kicks as default, blocks with ~ and bans with *
The last two parameters are optional.
F <changes>:<sec> Blocks nick changes when they equal or exceed the
specified rate (requires the nickflood module).
H <num>:<duration> Displays the last <num> lines of chat to joining
users. <duration> is the maximum time to keep
lines in the history buffer (requires the
chanhistory module).
J <seconds> Prevents rejoin after kick for the specified
number of seconds. This prevents auto-rejoin
(requires the kicknorejoin module).
K Blocks /KNOCK on the channel (requires the
knock module).
L <channel> If the channel reaches its limit set by +l,
redirect users to <channel> (requires the
redirect module).
M Blocks unregistered users from speaking (requires
the account module).
N Prevents users on the channel from changing nick
(requires the nonicks module).
O Channel is server operators only (can only be set
by server operators, requires the operchans module).
P Makes the channel permanent; Bans, invites, the
topic, modes, and such will not be lost when it
empties (can only be set by server operators,
requires the permchannels module).
Q Only services servers and their users can kick
(requires the nokicks module).
R Blocks unregistered users from joining (requires
the account module).
S Strips formatting codes from messages to the
channel (requires the stripcolor module).
T Blocks /NOTICEs to the channel from users who are
not at least halfop (requires the nonotice module).
U Hides the messages of unprivileged users from other
unprivileged users (requires the opmoderated module).
X <type>:<status> Makes users of <status> or higher exempt to the
specified restriction <type>. For example: flood:h
(requires the exemptchanops module).
Z <name>[=<value>] Add and remove modes via their long names (requires
the namedmodes module).
Possible restriction types to exempt with +X are:
anticaps Channel mode +B
auditorium-see Permission required to see the full user list of
a +u channel (requires the auditorium module).
auditorium-vis Permission required to be visible in a +u channel
(requires the auditorium module).
blockcolor Channel mode +c
delaymsg Channel mode +d
filter Channel mode +g
flood Channel mode +f
nickflood Channel mode +F
noctcp Channel mode +C
nonick Channel mode +N
nonotice Channel mode +T
opmoderated Channel mode +U
regmoderated Channel mode +M
repeat Channel mode +E
stripcolor Channel mode +S
topiclock Channel mode +t
NOTE: A large number of these modes are dependent upon server-side modules
being loaded by a server/network administrator. The actual modes available
on your network may be very different to this list. Please consult your
help channel if you have any questions.
">
<helptopic key="stats" title="/STATS <symbol> [<servername>]" value="
Shows various server statistics. Depending on configuration, some
symbols may be only available to opers.
Valid symbols are:
e Show E-lines (global user@host ban exceptions)
g Show G-lines (global user@host bans)
k Show K-lines (local user@host bans)
q Show Q-lines (global nick bans)
R Show R-lines (global regular expression bans)
Z Show Z-lines (global IP mask bans)
s Show filters (global)
C Show channel bans (global)
H Show shuns (global)
c Show link blocks
d Show configured DNSBLs and related statistics
m Show command statistics, number of times commands have been used
o Show a list of all valid oper usernames and hostmasks
p Show open client ports, and the port type (tls, plaintext, etc)
u Show server uptime
z Show memory usage statistics
i Show connect class permissions
l Show all client connections with information (sendq, commands, bytes, time connected)
L Show all client connections with information and IP address
P Show online opers and their idle times
T Show bandwidth/socket statistics
U Show services servers
Y Show connection classes
O Show opertypes and the allowed user and channel modes it can set
E Show socket engine events
S Show currently held registered nicknames
G Show how many local users are connected from each country
Note that all /STATS use is broadcast to online server operators.
">
<helptopic key="snomasks" title="Server Notice Masks" value="
A Notifications about unspecified events on a remote server.
a Notifications about unspecified events on the local server.
C Notifications about users connecting to a remote server.
c Notifications about users connecting to the local server.
D Notifications about DNSBL hits on a remote server (requires the dnsbl module).
d Notifications about DNSBL hits on the local server (requires the dnsbl module).
F Notifications about filter matches on a remote server (requires the filter module).
f Notifications about filter matches on the local server (requires the filter module).
G Messages from server operators on a remote server (requires the globops module).
g Messages from server operators on the local server (requires the globops module).
J Notifications about channels being created on a remote server (requires the chancreate module).
j Notifications about channels being created on the local server (requires the chancreate
module).
K Notifications about users being killed on a remote server.
k Notifications about users being killed on the local server.
L Messages relating to server linking on a remote server (requires the spanningtree module).
l Messages relating to server linking on the local server (requires the spanningtree module).
N Notifications about nicknames being changed on a remote server (requires the seenicks module).
n Notifications about nicknames being changed on the local server (requires the seenicks module).
O Notifications about users logging in and out of server operator accounts on a remote server.
o Notifications about users logging in and out of server operator accounts on the local server.
Q Notifications about users disconnecting from a remote server.
q Notifications about users disconnecting from the local server.
R Notifications about a remote server rehashing.
r Notifications about the local server rehashing.
t Notifications about local and remote attempts to use the /STATS command.
V Notifications about server operators overriding channel-level restrictions on a remote server
(requires the override module).
v Notifications about server operators overriding channel-level restrictions on the local server
(requires the override module).
W Notifications about gateways changing IP addresses on a remote server (requires the gateway
module).
w Notifications about gateways changing IP addresses on the local server (requires the gateway
module).
X Notifications about X-lines being added/removed/expired on a remote server.
x Notifications about X-lines being added/removed/expired on the local server.
">
<helptopic key="extbans" title="Extended Bans" value="
Extbans are split into two types; matching extbans, which match on
users in additional ways, and acting extbans, which restrict users
in different ways to a standard ban.
To use an extban, simply set +b <ban> or +e <ban> with it as the ban,
instead of a normal nick!user@host mask, to ban or exempt matching
users. Ban exceptions on acting extbans exempt that user from matching
an extban of that type, and from any channel mode corresponding to the
restriction. Matching extbans may also be used for invite exceptions by
setting +I <extban>.
Matching extbans:
realmask:<mask>, a:<mask> Matches user with both a matching banmask and real name, where
<mask> is in the format nick!user@host+realname (requires the
realnameban module).
channel:<channel>, j:<channel> Matches anyone in the given channel. Supports wildcards
(requires the channelban module).
class:<class>, n:<class> Matches users in a matching connect class (requires the
classban module).
oper:<pattern>, o:<pattern> Checks whether users are logged into a server operator account
with a name matching <pattern> (requires the operchans module).
realname:<realname>, r:<realname> Matches users with a matching real name (requires the
realnameban module).
server:<server>, s:<server> Matches users on a matching server (requires the serverban
module).
sslfp:<tlsfp>, z:<tlsfp> Matches users having the given TLS certificate fingerprint
(requires the sslmodes module).
gateway:<gateway>, w:<gateway> Matches users who are connecting via a WebIRC gateway that
matches <gateway> (requires the gateway module).
country:<pattern>, G:<pattern> Matches against the two letter country code for the country
that users are connecting from (requires the geoban module).
opertype:<opertype>, O:<opertype> Matches server operators of a matching type, mostly useful as
an invite exception (requires the operchans module).
account:<account>, R:<account> Matches users logged into a matching account (requires the
account module).
unauthed:<banmask>, U:<banmask> Matches unregistered users matching the given banmask (requires
the account module).
Acting extbans:
blockcolor:<banmask>, c:<banmask> Blocks any messages that contain formatting codes from matching
users (requires the blockcolor module).
mute:<banmask>, m:<banmask> Blocks messages from matching users (requires the muteban
module). Users with +v or above are not affected.
opmoderated:<banmask>, u:<banmask> Blocks matching users from speaking to unprivileged users in
the channel (requires the opmoderated module).
blockinvite:<banmask>, A:<banmask> Blocks invites by matching users even when +A is set (requires
the allowinvite module).
noctcp:<banmask>, C:<banmask> Blocks CTCPs from matching users (requires the noctcp module).
nonick:<banmask>, N:<banmask> Blocks nick changes from matching users (requires the nonicks
module).
nokick:<banmask>, Q:<banmask> Blocks kicks by matching users (requires the nokicks module).
stripcolor:<banmask>, S:<banmask> Strips formatting codes from messages from matching users
(requires the stripcolor module).
nonotice:<banmask>, T:<banmask> Blocks notices from matching users (requires the nonotice
module).
A ban given to an Acting extban may either be a nick!user@host mask
(unless stated otherwise), matched against users as for a normal ban,
or a Matching extban.
There is an additional special type of extended ban, a redirect ban:
Redirect n!u@h#channel will redirect the banned user to #channel
when they try to join (requires the banredirect module).
">
