Allow configuring whether SETNAME sends snotices and is oper-only.

[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 bdd3c4605862113cf2ea94f0fc209c0c42e5c84f..a4bfc751b49e7504c1a0d127fe11dc8076d882ba 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.
 #


@@ -11,6 +11,8 @@
 
 <alias text="HELP" replace="HELPOP $2-">
 
 
 <alias text="HELP" replace="HELPOP $2-">
 

+<helpmsg nohelp="There is no help for the topic you searched for. Please try again.">
+

 <helpop key="start" value="InspIRCd Help System
 
 This system provides help for commands and modes.
 <helpop key="start" value="InspIRCd Help System
 
 This system provides help for commands and modes.


@@ -24,27 +26,22 @@ parameter for this command.
 /HELPOP SNOMASKS -      To see a list of oper snotice masks
 /HELPOP EXTBANS  -      To see a list of extended bans">
 
 /HELPOP SNOMASKS -      To see a list of oper snotice masks
 /HELPOP EXTBANS  -      To see a list of extended bans">
 

-<helpop key="nohelp" value="There is no help for the topic
-you searched for. Please try again.">
-

 <helpop key="cuser" value="User Commands
 -------------
 
 PRIVMSG   NOTICE   NICK      JOIN      PART
 <helpop key="cuser" value="User Commands
 -------------
 
 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
 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
 
 ADMIN     MAP      LINKS     LUSERS    TIME
 STATS     VERSION  INFO      MODULES   COMMANDS
 SSLINFO
 

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

 
 <helpop key="coper" value="Oper Commands
 -------------
 
 <helpop key="coper" value="Oper Commands
 -------------


@@ -62,12 +59,12 @@ SAJOIN    SAPART    SAMODE      SATOPIC  SAKICK
 
 KILL      SAQUIT    GLINE       ZLINE    QLINE
 KLINE     RLINE     ELINE       CBAN     SHUN
 
 KILL      SAQUIT    GLINE       ZLINE    QLINE
 KLINE     RLINE     ELINE       CBAN     SHUN

-FILTER
+FILTER    CLEARCHAN

 
 CONNECT   SQUIT     RCONNECT    RSQUIT
 
 DIE            RESTART      REHASH
 
 CONNECT   SQUIT     RCONNECT    RSQUIT
 
 DIE            RESTART      REHASH

-CLEARCACHE     LOADMODULE   UNLOADMODULE
+               LOADMODULE   UNLOADMODULE

 RELOADMODULE   GLOADMODULE  GUNLOADMODULE
 GRELOADMODULE  CLOSE        JUMPSERVER
 LOCKSERV       UNLOCKSERV">
 RELOADMODULE   GLOADMODULE  GUNLOADMODULE
 GRELOADMODULE  CLOSE        JUMPSERVER
 LOCKSERV       UNLOCKSERV">


@@ -96,6 +93,8 @@ LOCKSERV       UNLOCKSERV">
               (requires the services account module).
  w            Receives wallops messages.
  x            Gives a cloaked hostname (requires the cloaking module).
               (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).
  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).


@@ -184,6 +183,10 @@ LOCKSERV       UNLOCKSERV">
                     noctcp module).
  D                  Delays join messages from users until they message
                     the channel (requires the delayjoin module).
                     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
  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


@@ -233,8 +236,10 @@ help channel if you have any questions.">
  A      Allows receipt of remote announcement messages.
  c      Allows receipt of local connect messages.
  C      Allows receipt of remote connect messages.
  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.
+ 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).
  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).


@@ -252,8 +257,8 @@ help channel if you have any questions.">
  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 the override 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 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).">
+ x      Allows receipt of local X-line notices (G/Z/Q/K/E/R/SHUN/CBan).
+ X      Allows receipt of remote X-line notices (G/Z/Q/K/E/R/SHUN/CBan).">

 
 <helpop key="extbans" value="Extended Bans
 ----------
 
 <helpop key="extbans" value="Extended Bans
 ----------


@@ -271,9 +276,14 @@ setting +I <extban>.
 
 Matching extbans:
 
 
 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 the channelban module).
  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).
                gecosban module).
  s:<server>    Matches users on a matching server (requires the
                serverban module).