]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/conf/helpop-full.conf.example
Move typedef ClassVector to ServerConfig::ClassVector
[user/henk/code/inspircd.git] / docs / conf / helpop-full.conf.example
index 445e0dd91d62e1a9d973c22cd4bda04cbaee5799..bd959f0d2c7720245fb6ba69266b59c64c696bcb 100644 (file)
@@ -34,7 +34,7 @@ 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
@@ -72,7 +72,7 @@ private message you when you have usermode +g set. ACCEPT +nick adds
 a nick to your accept list, ACCEPT -nick removes a nick from your
 accept list, and ACCEPT * displays your accept list.">
 
-<helpop key="cycle" value="/CYCLE [channel] [reason]
+<helpop key="cycle" value="/CYCLE [channel] :[reason]
 
 Cycles a channel (leaving and rejoining), overrides restrictions that
 would stop a new user joining, such as user limits and channel keys.">
@@ -91,18 +91,21 @@ and S queries the status.">
 
 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="rmode" value="/RMODE [channel] [modeletter] {[pattern]}
+
+Removes listmodes from a channel.
+E.g. /RMODE #Chan b m:* will remove all mute extbans.">
+
 <helpop key="fpart" value="/FPART [channel] [nick] {[reason]}
 
-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 builtin mIRC command which caused trouble
-for some users.">
+This behaves identically to /REMOVE. /REMOVE is a builtin mIRC command
+which caused trouble for some users.">
 
 <helpop key="devoice" value="/DEVOICE [channel]
 
@@ -260,11 +263,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.
@@ -374,7 +372,7 @@ SAJOIN    SAPART    SAMODE      SATOPIC  SAKICK
 
 KILL      SAQUIT    GLINE       ZLINE    QLINE
 KLINE     RLINE     ELINE       CBAN     SHUN
-FILTER    OJOIN
+FILTER    OJOIN     CLEARCHAN
 
 CONNECT   SQUIT     RCONNECT    RSQUIT
 
@@ -521,13 +519,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]}
 
@@ -756,6 +755,16 @@ Reloads the specified core command.">
 
 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.">
+
 ######################
 # User/Channel Modes #
 ######################
@@ -803,15 +812,15 @@ Closes all unregistered connections to the local server.">
 
  v [nickname]       Gives voice to [nickname], allowing them to speak
                     while the channel is +m.
- h [nickname]       Gives halfop status to [nickname] (this mode can
-                    be disabled).
+ h [nickname]       Gives halfop status to [nickname] (requires
+                    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 chanprotect module).
+                    requires customprefix module).
  q [nickname]       Gives owner status to [nickname], preventing them
                     from being kicked (Services or only, requires
-                    chanprotect module).
+                    customprefix module).
 
  b [hostmask]       Bans [hostmask] from the channel.
  e [hostmask]       Excepts [hostmask] from bans (requires
@@ -868,6 +877,9 @@ Closes all unregistered connections to the local server.">
                     module).
  D                  Delays join messages from users until they
                     message the channel (requires delayjoin module).
+ E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similiar 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).
  G                  Censors messages to the channel based on the
@@ -986,7 +998,7 @@ Note that all /STATS use is broadcast to online IRC operators.">
  Q      Allows receipt of remote quit messages.
  t      Allows receipt of attempts to use /STATS (local and remote).
  v      Allows receipt of oper-override notices (requires override module).
- x      Allows receipt of local Xline notices (g/z/q/k/e/R/shuns)."
+ 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).">
 
 ######################