Add optional oper override umode +O.

[user/henk/code/inspircd.git] / docs / conf / helpop.conf.example

diff --git a/docs/conf/helpop.conf.example b/docs/conf/helpop.conf.example
index 7d505b26186ea6f28167fa7e6b1b802f30359caf..68328272ed1c5718cd22c52bea88d03aa3b94a44 100644 (file)
--- a/docs/conf/helpop.conf.example
+++ b/docs/conf/helpop.conf.example
@@ -1,4 +1,4 @@
-# Sample configuration file for m_helpop.so
+# Sample configuration file for the helpop 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.
 #
 # 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.
 #


@@ -31,7 +31,7 @@ you searched for. Please try again.">
 -------------
 
 PRIVMSG   NOTICE   NICK      JOIN      PART
 -------------
 
 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
 KICK      FPART    REMOVE    TBAN      INVITE
 UNINVITE  AWAY     DCCALLOW  SILENCE   ACCEPT
 MKPASSWD  VHOST    TITLE     SETNAME


@@ -42,15 +42,14 @@ ADMIN     MAP      LINKS     LUSERS    TIME
 STATS     VERSION  INFO      MODULES   COMMANDS
 SSLINFO
 
 STATS     VERSION  INFO      MODULES   COMMANDS
 SSLINFO
 

-USER      PASS     PING     PONG       QUIT
-
-OPER">
+USER      PASS     PING     PONG       QUIT">

 
 <helpop key="coper" value="Oper Commands
 -------------
 
 OPERMOTD  CHECK     CLONES      USERIP   TLINE
 
 <helpop key="coper" value="Oper Commands
 -------------
 
 OPERMOTD  CHECK     CLONES      USERIP   TLINE

-ALLTIME   WALLOPS   GLOBOPS
+ALLTIME   WALLOPS   GLOBOPS     MODENOTICE
+CLOAK

 
 SETHOST   SETIDENT  CHGHOST     CHGIDENT CHGNAME
 SETIDLE   SWHOIS
 
 SETHOST   SETIDENT  CHGHOST     CHGIDENT CHGNAME
 SETIDLE   SWHOIS


@@ -68,8 +67,8 @@ CONNECT   SQUIT     RCONNECT    RSQUIT
 DIE            RESTART      REHASH
 CLEARCACHE     LOADMODULE   UNLOADMODULE
 RELOADMODULE   GLOADMODULE  GUNLOADMODULE
 DIE            RESTART      REHASH
 CLEARCACHE     LOADMODULE   UNLOADMODULE
 RELOADMODULE   GLOADMODULE  GUNLOADMODULE

-GRELOADMODULE  RELOAD       CLOSE
-LOCKSERV       UNLOCKSERV   JUMPSERVER">
+GRELOADMODULE  CLOSE        JUMPSERVER
+LOCKSERV       UNLOCKSERV">

 
 <helpop key="umodes" value="User Modes
 ----------
 
 <helpop key="umodes" value="User Modes
 ----------


@@ -79,7 +78,7 @@ LOCKSERV       UNLOCKSERV   JUMPSERVER">
               commonchans module).
  d            Deaf mode. User will not receive any messages or notices
               from channels they are in (requires deaf module).
               commonchans module).
  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).
               ignore (requires callerid module).
  h            Marks as 'available for help' in WHOIS (IRCop only,
               requires helpop module).


@@ -89,7 +88,7 @@ LOCKSERV       UNLOCKSERV   JUMPSERVER">
               having op modes removed from them (services only,
               requires servprotect module).
  o            Marks as a IRC operator.
               having op modes removed from them (services only,
               requires servprotect module).
  o            Marks as a IRC operator.

- s [mask]     Receives server notices specified by [mask]
+ s <mask>     Receives server notices specified by <mask>

               (IRCop only).
  r            Marks as a having a registered nickname
               (requires services account module).
               (IRCop only).
  r            Marks as a having a registered nickname
               (requires services account module).


@@ -102,6 +101,8 @@ LOCKSERV       UNLOCKSERV   JUMPSERVER">
               hideoper module).
  I            Hides a user's entire channel list in WHOIS from
               non-IRCops (requires hidechans module).
               hideoper module).
  I            Hides a user's entire channel list in WHOIS from
               non-IRCops (requires 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
  R            Blocks private messages from unregistered users
               (requires services account module).
  S            Strips mIRC color/bold/underline codes out of private


@@ -112,48 +113,49 @@ LOCKSERV       UNLOCKSERV   JUMPSERVER">
 <helpop key="chmodes" value="Channel Modes
 -------------
 
 <helpop key="chmodes" value="Channel Modes
 -------------
 

- v [nickname]       Gives voice to [nickname], allowing them to speak
+ v <nickname>       Gives voice to <nickname>, allowing them to speak

                     while the channel is +m.
                     while the channel is +m.

- h [nickname]       Gives halfop status to [nickname] (requires
+ h <nickname>       Gives halfop status to <nickname> (requires

                     customprefix module).
                     customprefix module).

- o [nickname]       Gives op status to [nickname].
- a [nickname]       Gives protected status to [nickname], preventing
+ 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).
                     them from them from being kicked (+q only,
                     requires customprefix module).

- q [nickname]       Gives owner status to [nickname], preventing them
+ q <nickname>       Gives owner status to <nickname>, preventing them

                     from being kicked (Services or only, requires
                     customprefix module).
 
                     from being kicked (Services or only, requires
                     customprefix module).
 

- b [hostmask]       Bans [hostmask] from the channel.
- e [hostmask]       Excepts [hostmask] from bans (requires
+ b <hostmask>       Bans <hostmask> from the channel.
+ e <hostmask>       Excepts <hostmask> from bans (requires

                     banexception module).
                     banexception module).

- I [hostmask]       Excepts [hostmask] from +i, allowing matching
+ I <hostmask>       Excepts <hostmask> from +i, allowing matching

                     users to join while the channel is invite-only
                     (requires inviteexception module).
 
  c                  Blocks messages containing mIRC color codes
                     (requires blockcolor module).
                     users to join while the channel is invite-only
                     (requires inviteexception module).
 
  c                  Blocks messages containing mIRC color codes
                     (requires blockcolor module).

- f [*][lines]:[sec] Kicks on text flood equal to or above the
+ d <time>           Blocks messages to a channel from new users
+                    until they have been in the channel for <time>
+                    seconds (requires delaymsg module).
+ f [*]<lines>:<sec> Kicks on text flood equal to or above the

                     specified rate. With *, the user is banned
                     (requires messageflood module).
                     specified rate. With *, the user is banned
                     (requires messageflood module).

- g [mask]           Blocks messages matching the given blob mask
-                    (requires chanfilter module).

  i                  Makes the channel invite-only.
                     Users can only join if an operator
                     uses /INVITE to invite them.
  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
+ j <joins>:<sec>    Limits joins to the specified rate (requires

                     joinflood module).
                     joinflood module).

- k [key]            Set the channel key (password) to [key].
- l [limit]          Set the maximum allowed users to [limit].
+ 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.
  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                  Make channel private, hiding it in user's whoises
+ 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).
                     and replacing it with * in /LIST.
  r                  Marks the channel as registered with Services
                     (requires services account module).

- s                  Make channel secret, hiding it in user's whoises
+ s                  Make channel secret, hiding it in users' whoises

                     and /LIST.
  t                  Prevents users without +h or +o from changing the
                     topic.
                     and /LIST.
  t                  Prevents users without +h or +o from changing the
                     topic.


@@ -161,8 +163,8 @@ LOCKSERV       UNLOCKSERV   JUMPSERVER">
                     see themselves or themselves and the operators,
                     while operators see all the users (requires
                     auditorium module).
                     see themselves or themselves and the operators,
                     while operators see all the users (requires
                     auditorium module).

- w [flag]:[banmask] Adds basic channel access controls of [flag] to
-                    [banmask], via the +w listmode.
+ 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)
                     For example, +w o:R:Brain will op anyone identified
                     to the account 'Brain' on join.
                     (requires autoop module)


@@ -178,23 +180,27 @@ LOCKSERV       UNLOCKSERV   JUMPSERVER">
                     module).
  D                  Delays join messages from users until they
                     message the channel (requires delayjoin module).
                     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.
+ E [~*][lines]:[sec]{[:difference]}{[:backlog]} Allows blocking of similar messages.

                     Kicks as default, blocks with ~ and bans with *
                     The last two parameters are optional.
                     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
+ 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
                     network configuration (requires censor module).
                     specified rate (requires nickflood module).
  G                  Censors messages to the channel based on the
                     network configuration (requires censor module).

- J [seconds]        Prevents rejoin after kick for the specified
+ 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).
+ J <seconds>        Prevents rejoin after kick for the specified

                     number of seconds. This prevents auto-rejoin
                     (requires kicknorejoin module).
  K                  Blocks /KNOCK on the channel.
                     number of seconds. This prevents auto-rejoin
                     (requires 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
+ L <channel>        If the channel reaches its limit set by +l,
+                    redirect users to <channel> (requires redirect

                     module).
  M                  Blocks unregistered users from speaking (requires
                     services account module).
                     module).
  M                  Blocks unregistered users from speaking (requires
                     services account module).

- N                  Prevents users on the channel from chainging nick
+ N                  Prevents users on the channel from changing nick

                     (requires nonicks module).
  O                  Channel is IRCops only (can only be set by IRCops,
                     requires operchans module).
                     (requires nonicks module).
  O                  Channel is IRCops only (can only be set by IRCops,
                     requires operchans module).


@@ -207,10 +213,15 @@ LOCKSERV       UNLOCKSERV   JUMPSERVER">
  R                  Blocks unregistered users from joining (requires
                     services account module).
  S                  Strips mIRC color codes from messages to the
  R                  Blocks unregistered users from joining (requires
                     services account module).
  S                  Strips mIRC color codes from messages to the

-                    channel (requirs stripcolor module).
+                    channel (requires stripcolor module).

  T                  Blocks /NOTICEs to the channel from users who are
                     not at least halfop (requires nonotice 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).
+

 -------------
 NOTE: A large number of these modes are dependent upon server-side modules
 being loaded by a server/network administrator. The actual modes available
 -------------
 NOTE: A large number of these modes are dependent upon server-side modules
 being loaded by a server/network administrator. The actual modes available


@@ -253,50 +264,64 @@ help channel if you have any questions.">
 <helpop key="extbans" value="Extended Bans
 ----------
 
 <helpop key="extbans" value="Extended Bans
 ----------
 

- c:n!u@h      Blocks any messages that contain color codes from
-              matching users (requires blockcolor module).
- j:#channel   Prevents anyone in #channel from joining the channel
-              (requires channelban module).
- m:n!u@h      Blocks messages from matching users (requires muteban
-              module).
- p:n!u@h      Blocks part messages from matching users (requires
-              nopartmsg module).
- r:realname   Prevents users with a matching realname from joining
-              the channel (requires gecosban module).
- s:server     Prevents users on a matching server from joining the
-              channel (requires services account).
-
- A:n!u@h      Blocks invites by matching users even when +A is set
-              (requires allowinvite module).
- B:n!u@h      Blocks all capital or nearly all capital messages from
-              matching users (requires blockcaps module).
- C:n!u@h      Blocks CTCPs from matching users (requires noctcp
-              module).
- M:account    Blocks messages from users logged into a matching
-              account (requires services account module).
- N:n!u@h      Blocks nick changes from matching users (requires
-              nonicks module).
- O:opertype   Prevents IRCops of the specified opertype from joining
-              the channel, mostly useful as an invite exception (IRCop
-              only, requires operchans module).
- Q:n!u@h      Blocks kicks by matching users (requires nokicks
-              module).
- R:account    Prevents users logged into a matching account from
-              joining the channel (requires services account module).
- S:n!u@h      Strips color/bold/underline from messages from matching
-              users (requires stripcolor module).
- T:n!u@h      Blocks notices from matching users (requires nonotice
-              module).
- U:n!u@h      Blocks unregistered users matching the given ban.
-              (requires m_services_account)
- z:certfp     Blocks users having the given certificate fingerprint
-              (requires m_sslmodes)
-
- Redirect     n!u@h#channel will redirect the banned user to #channel
-              when they try to join (requires banredirect module).
-
-All extbans that prevent users from joining may by used for ban
-exceptions and invite exceptions (invex), and extbans blocking
-specific actions may be used for ban exceptions to exempt people from
-either wider extbans or the restrictive mode matching the extban,
-where one exists.">
+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:
+
+ j:<channel>   Matches anyone in the given channel. Does not support
+               wildcards (requires channelban module).
+ n:<class>     Matches users in a matching connect class (requires
+               classban 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 having the given SSL certificate
+               fingerprint (requires sslmodes module).
+ O:<opertype>  Matches IRCops of a matching type, mostly useful as an
+               an invite exception (requires operchans module).
+ R:<account>   Matches users logged into a matching account (requires
+               services account module).
+ U:<banmask>   Matches unregistered users matching the given banmask.
+               (requires 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
+               module). Users with +v or above are not affected.
+ p:<banmask>   Blocks part messages from matching users (requires
+               nopartmsg module).
+ A:<banmask>   Blocks invites by matching users even when +A is set
+               (requires 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
+               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
+               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 banredirect module).">