# Helpop Standard #
#####################
+<config format="xml">
+
<alias text="HELP" replace="HELPOP $2-">
<helpop key="start" value="InspIRCd Help System
-------------
PRIVMSG NOTICE NICK JOIN PART
-CYCLE KNOCK MODE DEVOICE TOPIC
+CYCLE KNOCK MODE OPER TOPIC
KICK FPART REMOVE TBAN INVITE
UNINVITE AWAY DCCALLOW SILENCE ACCEPT
MKPASSWD VHOST TITLE SETNAME
STATS VERSION INFO MODULES COMMANDS
SSLINFO
-USER PASS PING PONG QUIT
-
-OPER">
+USER PASS PING PONG QUIT">
<helpop key="sslinfo" value="/SSLINFO <nick>
This behaves identically to /REMOVE. /REMOVE is a built-in mIRC command
which caused trouble for some users.">
-<helpop key="devoice" value="/DEVOICE <channel>
-
-Devoices yourself on the specified channel.">
-
<helpop key="silence" value="/SILENCE - Shows a list of silenced masks
/SILENCE +<mask> [<flags>] - Add a mask
/SILENCE -<mask> - Remove a mask
Sends a notice to a channel indicating you wish to join.">
-<helpop key="user" value="/USER <ident> <local host> <remote host> :<GECOS>
+<helpop key="user" value="/USER <ident> <local host> <remote host> :<real name>
This command is used by your client to register your
-IRC session, providing your ident and GECOS to the
+IRC session, providing your ident and real name to the
server.
You should not use it during an established connection.">
you are at least a halfoperator, the channel topic will be
changed to the new one you provide.">
-<helpop key="who" value="/WHO <search pattern> [ohurmaiMplf]
+<helpop key="who" value="/WHO <pattern> [<flags>][%[<fields>[,<querytype>]]] <pattern>
+
+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:
-Looks up the information of users matching the range you provide.
-You may only /WHO nicknames in channels or on servers where you
-share a common channel with them, or ones which are not +i (unless
-you are an IRC operator). The search-pattern may be a special
-sequence of characters determined by the flags given below, or
-it may be one of a nickname, a channel, a hostmask, an ip address
-mask or a server mask.
+ 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 after the mask have the following effects:
-
- o Show online IRC operators matching the mask
-
- a Show all users who have an away message matching the given mask
- i Show all users who have an ident (username) matching the given mask
- p Show all users who are connected on the given port number (IRC
- operators only)
- r Show all users whose realnames match the mask. When this
- flag is set it overrides the meaning of the search-pattern,
- which must contain a glob pattern intended to match GECOS
- (realname) fields.
- m Search for all users with a given set of user modes. When
- this flag is set it overrides the meaning of the
- search-pattern, which must contain the mode sequence to
- search for, for example to find all users with +i and
- without +s, issue the command WHO +i-s m (IRC operators only)
- t Show users connected within this number of seconds
- M Show all users who have metadata attached to them with
- the given key name (IRC operators only)
-
- f Show only remote (far) users
- l Show only local users
-
- h Show real hostnames rather than masked hostnames (IRC
- operators only)
- u Unlimit the results past the maximum /who results value
- (IRC operators only)
-
-You may combine multiple flags in one WHO command except where stated in the table above.">
+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>.
+ 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 an ident (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 ident in the response.
+
+">
<helpop key="motd" value="/MOTD [<server>]
OPERMOTD CHECK CLONES USERIP TLINE
ALLTIME WALLOPS GLOBOPS MODENOTICE
+CLOAK
SETHOST SETIDENT CHGHOST CHGIDENT CHGNAME
SETIDLE SWHOIS
CONNECT SQUIT RCONNECT RSQUIT
DIE RESTART REHASH
-CLEARCACHE LOADMODULE UNLOADMODULE
+ LOADMODULE UNLOADMODULE
RELOADMODULE GLOADMODULE GUNLOADMODULE
GRELOADMODULE CLOSE JUMPSERVER
LOCKSERV UNLOCKSERV">
Returns the ip and nickname of the given users.">
-<helpop key="tline" value="/TLINE <host/IP mask>
+<helpop key="tline" value="/TLINE <mask>
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).">
+(by IP address or by hostname). Mask should be given as either a
+nick!user@host or user@IP (wildcards acceptable).">
-<helpop key="lockserv" value="/LOCKSERV
+<helpop key="lockserv" value="/LOCKSERV :[<message>]
Locks out all new connections notifying connecting users that the
service is temporarily closed and to try again later.">
'Please use this server/port instead' (the default given in various
numeric lists)">
-<helpop key="filter" value="/FILTER <filter-definition> [<action> <flags> [<gline-duration>] :<reason>]
+<helpop key="filter" value="/FILTER <filter-definition> [<action> <flags> [<duration>] :<reason>]
This command will add a filter when more than one parameter is given,
for messages of the types specified by the flags, with the given
-filter definition, action, gline duration (when the action is 'gline')
+filter definition, action, duration (when the action is 'gline' or 'shun'),
and reason.
The filter will take effect when a message of any type specified by
Silent Blocks message, but does not notify IRCops
Kill Kills the user
Gline Glines the user for the specified duration
+Shun Shuns the user for the specified duration (requires the shun module)
Valid FILTER Flags
------------------
P Block part messages
q Block quit messages
o Don't match against opers
-c Strip all color codes from the message before matching
+c Strip all formatting codes from the message before matching
* Represents all of the above flags
- Does nothing, a non-op for when you do not want to specify any
flags
1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
5 minutes and 6 seconds. All fields in this format are optional.">
-<helpop key="die" value="/DIE <password>
+<helpop key="die" value="/DIE <server>
This command shuts down the local server. A single parameter is
-required, which must match the password in the configuration for the
-command to function.">
+required, which must match the name of the local server.">
-<helpop key="restart" value="/RESTART <password>
+<helpop key="restart" value="/RESTART <server>
This command restarts the local server. A single parameter is
-required, which must match the password in the configuration for the
-command to function.">
+required, which must match the name of the local server.">
<helpop key="commands" value="/COMMANDS
<helpop key="unloadmodule" value="/UNLOADMODULE <modname>
-Unloads a module from the local server. The module cannot have the
-static flag set (see the output of /MODULES).">
+Unloads a module from the local server.">
<helpop key="reloadmodule" value="/RELOADMODULE <modname>
-Unloads and reloads a module on the local server. This module cannot
-have the static flag set (see the output of /MODULES).">
+Unloads and reloads a module on the local server.">
<helpop key="gloadmodule" value="/GLOADMODULE <modname>
<helpop key="gunloadmodule" value="/GUNLOADMODULE <modname>
-Unloads a module from all linked servers. The module cannot have the
-static flag set (see the output of /MODULES).">
+Unloads a module from all linked servers.">
<helpop key="greloadmodule" value="/GRELOADMODULE <modname>
-Unloads and reloads a module on all linked servers. This module cannot
-have the static flag set (see the output of /MODULES).">
+Unloads and reloads a module on all linked servers.">
<helpop key="kline" value="/KLINE <user@host> [<duration> :<reason>]
<helpop key="rline" value="/RLINE <regex> [<duration> :<reason>]
-Sets or removes an r-line (regex line) on a n!u@h\\sgecos mask. You
+Sets or removes an r-line (regex line) on a n!u@h\srealname mask. You
must specify all three parameters to add an rline, and one parameter
to remove an rline (just the regex).
1y2w3d4h5m6s - meaning one year, two weeks, three days, 4 hours,
5 minutes and 6 seconds. All fields in this format are optional.">
-<helpop key="clearcache" value="/CLEARCACHE {servername}
-
-This command clears the DNS cache of the specified server. If no
-server is specified, the local server's DNS cache will be cleared.">
-
<helpop key="close" value="/CLOSE
Closes all unregistered connections to the local server.">
If multiple mode letters are given, the notice is only sent to users
who have all of them set.">
+<helpop key="cloak" value="/CLOAK <host>
+
+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.">
+
######################
# User/Channel Modes #
######################
----------
c Blocks private messages and notices from users who do
- not share a common channel with you (requires
+ 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 deaf module).
+ from channels they are in (requires the deaf module).
g In combination with /ACCEPT, provides for server side
- ignore (requires callerid module).
+ ignore (requires the callerid module).
h Marks as 'available for help' in WHOIS (IRCop only,
- requires helpop module).
+ requires the helpop 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 servprotect module).
+ requires the servprotect module).
o Marks as a IRC operator.
s <mask> Receives server notices specified by <mask>
(IRCop only).
r Marks as a having a registered nickname
- (requires services account module).
+ (requires the services account module).
w Receives wallops messages.
- x Gives a cloaked hostname (requires cloaking module).
- B Marks as a bot (requires botmode module).
+ x Gives a cloaked hostname (requires the cloaking module).
+ z Only allow private messages from SSL users (requires the
+ sslmode module).
+ B Marks as a bot (requires the botmode module).
G Censors messages sent to the user based on filters
- configured for the network (requires censor module).
- H Hides an oper's oper status from WHOIS (requires
+ configured for the network (requires the censor 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-IRCops (requires hidechans module).
+ non-IRCops (requires the hidechans module).
+ L Stops redirections done by m_redirect (mode must be
+ enabled in the config).
R Blocks private messages from unregistered users
- (requires services account module).
- S Strips mIRC color/bold/underline codes out of private
- messages to the user (requires stripcolor module).
+ (requires the services account module).
+ S Strips formatting codes out of private messages
+ to the user (requires the stripcolor module).
W Receives notification when a user uses WHOIS on them
- (IRCop only, requires showwhois module).">
+ (IRCop only, requires the showwhois module).">
<helpop key="chmodes" value="Channel Modes
-------------
v <nickname> Gives voice to <nickname>, allowing them to speak
while the channel is +m.
- h <nickname> Gives halfop status to <nickname> (requires
+ 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 them from being kicked (+q only,
- requires customprefix module).
- q <nickname> Gives owner status to <nickname>, preventing them
- from being kicked (Services or only, requires
+ 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).
b <hostmask> Bans <hostmask> from the channel.
- e <hostmask> Excepts <hostmask> from bans (requires
+ 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 inviteexception module).
+ (requires the inviteexception module).
- c Blocks messages containing mIRC color codes
- (requires blockcolor 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 delaymsg module).
+ 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 messageflood module).
+ (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
- joinflood module).
+ 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
p Make channel private, hiding it in users' whoises
and replacing it with * in /LIST.
r Marks the channel as registered with Services
- (requires services account module).
+ (requires the services account module).
s Make channel secret, hiding it in users' whoises
and /LIST.
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
+ 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 autoop module)
+ (requires the autoop module)
z Blocks non-SSL clients from joining the channel.
A Allows anyone to invite users to the channel
(normally only chanops can invite, requires
- allowinvite module).
+ the allowinvite module).
B Blocks messages with too many capital letters,
as determined by the network configuration
- (requires blockcaps module).
- C Blocks any CTCPs to the channel (requires noctcp
- module).
- D Delays join messages from users until they
- message the channel (requires delayjoin module).
+ (requires the blockcaps 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.
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 nickflood module).
+ specified rate (requires the nickflood module).
G Censors messages to the channel based on the
- network configuration (requires censor module).
+ network configuration (requires the censor 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 chanhistory
- module).
+ 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 kicknorejoin module).
+ (requires the kicknorejoin module).
K Blocks /KNOCK on the channel.
L <channel> If the channel reaches its limit set by +l,
- redirect users to <channel> (requires redirect
- module).
+ redirect users to <channel> (requires the
+ redirect module).
M Blocks unregistered users from speaking (requires
- services account module).
+ the services account module).
N Prevents users on the channel from changing nick
- (requires nonicks module).
+ (requires the nonicks module).
O Channel is IRCops only (can only be set by IRCops,
- requires operchans module).
+ 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 IRCops, requires
- permchannels module).
+ the permchannels module).
Q Only ulined servers and their users can kick
- (requires nokicks module)
+ (requires the nokicks module)
R Blocks unregistered users from joining (requires
- services account module).
- S Strips mIRC color codes from messages to the
- channel (requires stripcolor module).
+ the services 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 nonotice module).
-
- g <mask> Blocks messages matching the given glob mask
- (requires chanfilter module).
- X <mode> Makes channel operators immune to the specified
- restrictive mode (requires exemptchanops module).
+ not at least halfop (requires the nonotice module).
+ X <type>:<status> Makes users of <status> or higher exempt to the
+ specified restriction <type>. For example: flood:h
+ (requires the exemptchanops module).
+ Possible restriction types to exempt with +X are:
+
+ 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).
+ blockcaps Channel mode +B
+ blockcolor Channel mode +c
+ censor Channel mode +G
+ filter Channel mode +g
+ flood Channel mode +f
+ nickflood Channel mode +F
+ noctcp Channel mode +C
+ nonick Channel mode +N
+ nonotice Channel mode +T
+ regmoderated Channel mode +M
+ stripcolor Channel mode +S
+ topiclock Channel mode +t
-------------
NOTE: A large number of these modes are dependent upon server-side modules
A Allows receipt of remote announcement messages.
c Allows receipt of local connect messages.
C Allows receipt of remote connect messages.
- d Allows receipt of general (and sometimes random) debug
- messages.
- f Allows receipt of flooding notices.
- g Allows receipt of globops (requires globops module).
- j Allows receipt of channel creation notices (requires
- chancreate module).
- J Allows receipt of remote channel creation notices (requires
- chancreate module).
+ d Allows receipt of local DNSBL messages (requires the dnsbl module).
+ D Allows receipt of remote DNSBL messages (requires the dnsbl module).
+ f Allows receipt of local filter messages (requires the filter module).
+ F Allows receipt of remote filter messages (requires the filter module).
+ g Allows receipt of globops (requires the globops module).
+ j Allows receipt of channel creation notices (requires the chancreate module).
+ J Allows receipt of remote channel creation notices (requires the chancreate module).
k Allows receipt of local kill messages.
K Allows receipt of remote kill messages.
- l Allows receipt of local linking related
- messages.
- L Allows receipt of remote linking related
- messages.
- n See local nickname changes (requires seenicks module).
- N See remote nickname changes (requires seenicks modules).
- o Allows receipt of oper-up, oper-down, and oper-failure
- messages.
- O Allows receipt of remote oper-up, oper-down, and oper-failure
- messages.
+ l Allows receipt of local linking related messages.
+ L Allows receipt of remote linking related messages.
+ n See local nickname changes (requires the seenicks module).
+ N See remote nickname changes (requires the seenicks modules).
+ o Allows receipt of oper-up, oper-down, and oper-failure messages.
+ O Allows receipt of remote oper-up, oper-down, and oper-failure messages.
q Allows receipt of local quit messages.
Q Allows receipt of remote quit messages.
+ r Allows receipt of local oper commands (requires the operlog module).
+ R Allows receipt of remote oper commands (requires the operlog module).
t Allows receipt of attempts to use /STATS (local and remote).
- v Allows receipt of oper-override notices (requires override module).
+ v Allows receipt of oper-override notices (requires the override module).
x Allows receipt of local Xline notices (g/Z/q/k/e/R/shuns).
X Allows receipt of remote Xline notices (g/Z/q/k/e/R/shuns).">
Matching extbans:
+ a:<mask> Matches user with both a matching banmask and realname,
+ where <mask> is in the format nick!user@host+realname
+ (requires gecosban module).
j:<channel> Matches anyone in the given channel. Does not support
- wildcards (requires channelban module).
- r:<realname> Matches users with a matching realname (requires gecosban
- module).
- s:<server> Matches users on a matching server (requires serverban
- module).
- z:<certfp> Matches users with a matching SSL certificate fingerprint
- (requires sslmodes module)
+ wildcards (requires the channelban module).
+ n:<class> Matches users in a matching connect class (requires the
+ classban module).
+ r:<realname> Matches users with a matching real name (requires the
+ gecosban module).
+ s:<server> Matches users on a matching server (requires the
+ serverban module).
+ z:<certfp> Matches users having the given SSL certificate
+ fingerprint (requires the sslmodes module).
O:<opertype> Matches IRCops of a matching type, mostly useful as an
- an invite exception (requires operchans module).
+ an invite exception (requires the operchans module).
R:<account> Matches users logged into a matching account (requires
- services account module).
+ the services account module).
+ U:<banmask> Matches unregistered users matching the given banmask.
+ (requires the services account module).
Acting extbans:
- c:<banmask> Blocks any messages that contain color codes from
- matching users (requires blockcolor module).
- m:<banmask> Blocks messages from matching users (requires muteban
+ c:<banmask> Blocks any messages that contain formatting codes from
+ matching users (requires the blockcolor module).
+ m:<banmask> Blocks messages from matching users (requires the muteban
module). Users with +v or above are not affected.
p:<banmask> Blocks part messages from matching users (requires
- nopartmsg module).
+ the nopartmsg module).
A:<banmask> Blocks invites by matching users even when +A is set
- (requires allowinvite module).
+ (requires the allowinvite module).
B:<banmask> Blocks all capital or nearly all capital messages from
- matching users (requires blockcaps module).
- C:<banmask> Blocks CTCPs from matching users (requires noctcp
+ matching users (requires the blockcaps module).
+ C:<banmask> Blocks CTCPs from matching users (requires the noctcp
module).
N:<banmask> Blocks nick changes from matching users (requires
- nonicks module).
- Q:<banmask> Blocks kicks by matching users (requires nokicks
- module).
- S:<banmask> Strips color/bold/underline from messages from matching
- users (requires stripcolor module).
- T:<banmask> Blocks notices from matching users (requires nonotice
+ the nonicks module).
+ Q:<banmask> Blocks kicks by matching users (requires the nokicks
module).
- U:<banmask> Blocks unregistered users matching the given banmask.
- (requires services account).
+ S:<banmask> Strips formatting codes from messages from matching
+ users (requires the stripcolor module).
+ 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,
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 banredirect module).">
+ when they try to join (requires the banredirect module).">
projects / user / henk / code / inspircd.git / blobdiff