X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fconf%2Fhelpop-full.conf.example;h=bd959f0d2c7720245fb6ba69266b59c64c696bcb;hb=046da7da9bf57ac9254f76fd1c43eadf1673cdf5;hp=c972d04ddde8dd3d102fdf3047da19b328c155c3;hpb=8790551dc182cd8804ee7d8ef89ccb31067cc2a4;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/docs/conf/helpop-full.conf.example b/docs/conf/helpop-full.conf.example
index c972d04dd..bd959f0d2 100644
--- a/docs/conf/helpop-full.conf.example
+++ b/docs/conf/helpop-full.conf.example
@@ -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]
+<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,7 +91,7 @@ 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
@@ -104,14 +104,12 @@ 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 that
-[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 feature was added in the 1.1 branch.">
+This behaves identically to /REMOVE. /REMOVE is a builtin mIRC command
+which caused trouble for some users.">
 
 <helpop key="devoice" value="/DEVOICE [channel]
 
-Devoices yourself from the specified channel.">
+Devoices yourself on the specified channel.">
 
 <helpop key="silence" value="/SILENCE [+/-][hostmask] [p|c|i|n|t|a|x]
 
@@ -129,7 +127,7 @@ Valid SILENCE Flags
  a        Block all of the above
  x        Exception
 
-Multiple letters may be specified. For an exception, you msut pair x
+Multiple letters may be specified. For an exception, you must pair x
 with what you want excepted. For example, if you wanted to except
 everything from people with a host matching *.foo.net, you would do
 /SILENCE +*!*@*.foo.net xa
@@ -162,7 +160,7 @@ Returns the server's version information.">
 
 <helpop key="ping" value="/PING [server]
 
-Ping a server. Target server will answer with a PONG.">
+Ping a server. The server will answer with a PONG.">
 
 <helpop key="pong" value="/PONG [server]
 
@@ -196,11 +194,11 @@ Leaves one or more channels you specify.">
 <helpop key="kick" value="/KICK [channel] [nick] {[reason]}
 
 Kicks a user from a channel you specify. You must be
-At least a channel halfoperator to kick a user.">
+at least a channel halfoperator to kick a user.">
 
 <helpop key="mode" value="/MODE [target] [+|-][modes]{[+|-][modes]} {mode parameters}
 
-Sets the mode for a channel or a nickname specified in [target]
+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 usermode, and a user may only change channel modes of
 channels where they are at least a halfoperator.
@@ -234,7 +232,8 @@ The following flags after the mask have the following effects:
 
  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
+ 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
@@ -243,10 +242,10 @@ The following flags after the mask have the following effects:
         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.
+        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
+        the given key name (IRC operators only)
 
  f      Show only remote (far) users
  l      Show only local users
@@ -264,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.
@@ -366,8 +360,8 @@ Sets your name to the specified name.">
 <helpop key="coper" value="Oper Commands
 -------------
 
-OPERMOTD  CHECK     CLONES      USERIP   LINE
-ALLTIME   MODULES   WALLOPS     GLOBOPS
+OPERMOTD  CHECK     CLONES      USERIP   TLINE
+ALLTIME   WALLOPS   GLOBOPS
 
 SETHOST   SETIDENT  CHGHOST     CHGIDENT CHGNAME
 SETIDLE   SWHOIS
@@ -378,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
 
@@ -388,9 +382,9 @@ RELOADMODULE   GLOADMODULE  GUNLOADMODULE
 GRELOADMODULE  RELOAD       CLOSE
 LOCKSERV       UNLOCKSERV   JUMPSERVER">
 
-<helpop key="userip" value="/USERIP [nickname]
+<helpop key="userip" value="/USERIP [nicknames]
 
-Returns the ip and nickname of a user.">
+Returns the ip and nickname of the given users.">
 
 <helpop key="tline" value="/TLINE [host or ip mask]
 
@@ -457,12 +451,13 @@ n    Block private and channel notices
 P    Block part messages
 q    Block quit messages
 o    Don't match against opers
+c    Strip all color 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
 
 The reason for the filter will be used as the reason for the action,
-unless the ation is 'none', and is sent to the user when their text is
+unless the action is 'none', and is sent to the user when their text is
 blocked by 'block' and 'silent' actions.
 
 A gline duration may be specified in seconds, or in the format
@@ -524,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]}
 
@@ -567,7 +563,7 @@ the result.">
 
 <helpop key="opermotd" value="/OPERMOTD
 
-Redisplays the Oper MOTD.">
+Displays the Oper MOTD.">
 
 <helpop key="nicklock" value="/NICKLOCK [nick] [new nick]
 
@@ -592,7 +588,7 @@ Changes the ident of the user to the new ident.">
 
 <helpop key="shun" value="/SHUN [nick!user@host] {[duration] :[reason]}
 
-Sets or removes a shun (serverside ignore) on a host and ident mask.
+Sets or removes a shun (server side ignore) on a host and ident mask.
 You must specify all three parameters to add a shun, and one parameter
 to remove a shun (just the nick!user@host section).
 
@@ -608,7 +604,7 @@ command to function.">
 
 <helpop key="restart" value="/RESTART [password]
 
-This command restarts down the local server. A single parameter is
+This command restarts the local server. A single parameter is
 required, which must match the password in the configuration for the
 command to function.">
 
@@ -620,21 +616,21 @@ Shows all currently available commands.">
 
 This command will disconnect a user from IRC with the given reason.">
 
-<helpop key="rehash" value="/REHASH
+<helpop key="rehash" value="/REHASH [mask]
 
 This command will cause the server configuration file to be reread and
-values reinitialized for all servers matchin the server mask, or the
+values reinitialized for all servers matching the server mask, or the
 local server if one is not specified.">
 
 <helpop key="connect" value="/CONNECT [servermask]
 
-Add a connection to the server matching the given servermask. You must
+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.">
 
 <helpop key="squit" value="/SQUIT [servermask]
 
-Disconnects the server matching the given servermask from this server.">
+Disconnects the server matching the given server mask from this server.">
 
 <helpop key="modules" value="/MODULES
 
@@ -759,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 #
 ######################
@@ -769,9 +775,9 @@ Closes all unregistered connections to the local server.">
  c            Blocks private messages and notices from users who do
               not share a common channel with you (requires
               commonchans module).
- d            Deaf mode. User will not recieve any messages or notices
+ d            Deaf mode. User will not receive any messages or notices
               from channels they are in (requires deaf module).
- g            In combination with /allow, provides for server side
+ g            In combination with /ACCEPT, provides for server side
               ignore (requires callerid module).
  h            Marks as 'available for help' in WHOIS (IRCop only,
               requires helpop module).
@@ -794,9 +800,6 @@ Closes all unregistered connections to the local server.">
               hideoper module).
  I            Hides a user's entire channel list in WHOIS from
               non-IRCops (requires hidechans module).
- Q            Makes an operator invisible, preventing users from
-              seeing their presence, including in channel user lists
-              (IRCop only, requires invisible module).
  R            Blocks private messages from unregistered users
               (requires services account module).
  S            Strips mIRC color/bold/underline codes out of private
@@ -874,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
@@ -903,7 +909,7 @@ Closes all unregistered connections to the local server.">
                     channel (requirs 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 blob mask
                     (requires chanfilter module).
  X [mode]           Makes channel operators immune to the specified
@@ -926,16 +932,16 @@ symbols may be only available to opers.
 
 Valid symbols are:
 
-e  Show e-lines (local ban exemptions)
-g  Show g-lines (host bans)
-k  Show k-lines (local host bans)
-q  Show q-lines (nick mask bans)
-Z  Show z-lines (IP mask bans)
+e  Show E-lines (local ban exemptions)
+g  Show G-lines (host bans)
+k  Show K-lines (local host bans)
+q  Show Q-lines (nick mask bans)
 R  Show R-lines (regular expression bans)
+Z  Show Z-lines (IP mask bans)
 
-H  Show shuns
 s  Show filters
 C  Show channel bans
+H  Show shuns
 
 c  Show link blocks
 d  Show configured DNSBLs and related statistics
@@ -972,8 +978,6 @@ Note that all /STATS use is broadcast to online IRC operators.">
         messages.
  f      Allows receipt of flooding notices.
  g      Allows receipt of globops (requires globops module).
- G      Allows receipt of notices of use of oper-override (requires
-        override module)
  j      Allows receipt of channel creation notices (requires
         chancreate module).
  J      Allows receipt of remote channel creation notices (requires
@@ -994,7 +998,8 @@ 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 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).">
 
 ######################
 #      EXTBANS       #