]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/conf/helpop-full.conf.example
Merge branch 'insp20' into master.
[user/henk/code/inspircd.git] / docs / conf / helpop-full.conf.example
index 959f2249df37cb05a831524ffb266f5de9f94ffd..5705cad8ec78b55ffe63a50043a98926a2b6eb29 100644 (file)
@@ -30,20 +30,18 @@ you searched for. Please try again.">
 -------------
 
 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
 
 WHOIS     WHOWAS   ISON      USERHOST  WATCH
-LIST      NAMES    WHO       MOTD      RULES
+LIST      NAMES    WHO       MOTD
 ADMIN     MAP      LINKS     LUSERS    TIME
 STATS     VERSION  INFO      MODULES   COMMANDS
 SSLINFO
 
-USER      PASS     PING     PONG       QUIT
-
-OPER">
+USER      PASS     PING     PONG       QUIT">
 
 <helpop key="sslinfo" value="/SSLINFO <nick>
 
@@ -104,22 +102,21 @@ This command accepts multiple nicks like so:
 
 Authenticate for a vhost using the specified username and password.">
 
-<helpop key="remove" value="/REMOVE <nick> <channel> [<reason>]
+<helpop key="remove" value="/REMOVE <channel> <nick> [<reason>]
 
 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.">
 
-<helpop key="fpart" value="/FPART <channel> <nick> [<reason>]
+<helpop key="rmode" value="/RMODE [channel] [modeletter] {[pattern]}
 
-This behaves identically to /REMOVE, the only difference is that the
-<channel> and <nick> parameters are switched around to match /KICK's
-syntax. Also, /REMOVE is a built-in mIRC command which caused trouble
-for some users.">
+Removes listmodes from a channel.
+E.g. /RMODE #Chan b m:* will remove all mute extbans.">
 
-<helpop key="devoice" value="/DEVOICE <channel>
+<helpop key="fpart" value="/FPART <channel> <nick> [<reason>]
 
-Devoices yourself on the specified channel.">
+This behaves identically to /REMOVE. /REMOVE is a built-in mIRC command
+which caused trouble for some users.">
 
 <helpop key="silence" value="/SILENCE - Shows a list of silenced masks
 /SILENCE +<mask> [<flags>] - Add a mask
@@ -150,10 +147,10 @@ everything from people with a host matching *.foo.net, you would do
 
 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.">
@@ -229,33 +226,47 @@ 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.">
 
-<helpop key="who" value="/WHO <pattern> [afhilMmoprt]
+<helpop key="who" value="/WHO <pattern> [<flags>][%[<fields>[,<querytype>]]] <pattern>
 
-Looks up the information of users matching the range you provide.
+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:
 
-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 a server 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 use <pattern> to match against the specified user data:
 
- a     Show users who have an away message matching <pattern>.
- i     Show users who have an ident (username) matching <pattern>.
- M     Show users who have metadata attached to them with a key name matching
-       <pattern> (server operators only).
+ 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:
 
@@ -265,11 +276,34 @@ The following flags filter users by their status:
 
 The following flags modify the command output:
 
h     Show real hostnames rather than display hostnames (server operators
-       only).
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.">
+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>]
 
@@ -277,11 +311,6 @@ 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.">
 
-<helpop key="rules" value="/RULES
-
-Show the rules file for the local server. This is similar in effect to
-except that these are not sent automatically on connect.">
-
 <helpop key="oper" value="/OPER <login> <password>
 
 Attempts to authenticate a user as an IRC operator.
@@ -392,12 +421,12 @@ SAJOIN    SAPART    SAMODE      SATOPIC  SAKICK
 
 KILL      SAQUIT    GLINE       ZLINE    QLINE
 KLINE     RLINE     ELINE       CBAN     SHUN
-FILTER    OJOIN
+FILTER    OJOIN     CLEARCHAN
 
 CONNECT   SQUIT     RCONNECT    RSQUIT
 
 DIE            RESTART      REHASH
-CLEARCACHE     LOADMODULE   UNLOADMODULE
+               LOADMODULE   UNLOADMODULE
 RELOADMODULE   GLOADMODULE  GUNLOADMODULE
 GRELOADMODULE  CLOSE        JUMPSERVER
 LOCKSERV       UNLOCKSERV">
@@ -413,7 +442,7 @@ and the percentage of clients matched, plus how they were matched
 (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.">
@@ -443,11 +472,11 @@ reason parameter is optional, and if not provided defaults to
 '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
@@ -463,6 +492,7 @@ Block   Blocks message and informs +s IRCops of the blocked message
 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
 ------------------
@@ -539,13 +569,14 @@ The 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.">
 
-<helpop key="sajoin" value="/SAJOIN <nick> <channel>
+<helpop key="sajoin" value="/SAJOIN [<nick>] <channel>[,<channel>]
 
-Forces the user to join the channel.">
+Forces the user to join the channel(s).
+If no nick is given, it joins the oper doing the /SAJOIN.">
 
-<helpop key="sapart" value="/SAPART <nick> <channel>
+<helpop key="sapart" value="/SAPART <nick> <channel>[,<channel>]
 
-Forces the user to part the channel.">
+Forces the user to part the channel(s).">
 
 <helpop key="samode" value="/SAMODE <target> (+|-)<modes> [<parameters for modes>]
 
@@ -623,17 +654,15 @@ The 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.">
 
-<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
 
@@ -664,33 +693,29 @@ Disconnects the server matching the given server mask from this server.">
 Lists currently loaded modules, their memory offsets, version numbers,
 and flags. If you are not an operator, you will see reduced detail.">
 
-<helpop key="loadmodule" value="/LOADMODULE <filename.so>
+<helpop key="loadmodule" value="/LOADMODULE <modname>
 
 Loads the specified module into the local server.">
 
-<helpop key="unloadmodule" value="/UNLOADMODULE <filename.so>
+<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 <filename.so>
+<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 <filename.so>
+<helpop key="gloadmodule" value="/GLOADMODULE <modname>
 
 Loads the specified module on all linked servers.">
 
-<helpop key="gunloadmodule" value="/GUNLOADMODULE <filename.so>
+<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 <filename.so>
+<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>]
 
@@ -753,7 +778,7 @@ Sends a message to all +w users.">
 
 <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).
 
@@ -761,14 +786,20 @@ The 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.">
 
-<helpop key="clearcache" value="/CLEARCACHE
-
-This command clears the DNS cache of the local server.">
-
 <helpop key="close" value="/CLOSE
 
 Closes all unregistered connections to the local server.">
 
+<helpop key="clearchan" value="/CLEARCHAN <channel> [<KILL|KICK|G|Z>] [<reason>]
+
+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.">
+
 <helpop key="modenotice" value="/MODENOTICE <modeletters> <message>
 
 Sends a notice to all users who have the given mode(s) set.
@@ -809,6 +840,8 @@ using their cloak when they quit.">
               (requires the services account module).
  w            Receives wallops messages.
  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 the censor module).
@@ -897,6 +930,9 @@ using their cloak when they quit.">
                     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 the nickflood module).
  G                  Censors messages to the channel based on the
@@ -1055,7 +1091,9 @@ Matching extbans:
 
  j:<channel>   Matches anyone in the given channel. Does not support
                wildcards (requires the channelban module).
- r:<realname>  Matches users with a matching realname (requires the
+ 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).