Clarify no_oper_flood option in the reference.conf

[irc/rqf/shadowircd.git] / doc / reference.conf

diff --git a/doc/reference.conf b/doc/reference.conf
index 101ef3e42a095d8373e1a0d764a93e3a763e5216..81c09422fb224f257ce0f89ba09901c96075da1f 100755 (executable)
--- a/doc/reference.conf
+++ b/doc/reference.conf
@@ -140,6 +140,14 @@ serverinfo {
        network_name = "MyNet";
        network_desc = "This is My Network";
 
+       /* helpchan/helpurl: These 2 items are shown when a user does
+        * /quote help with no additional parameters to direct them
+        * to a channel/URL where they can get more or network-specific help.
+        * They can be commented out and will not show to users if they are.
+        */
+       helpchan = "#help";
+       helpurl = "http://www.mynet.net/help";
+
        /* hub: allow this server to act as a hub and have multiple servers
         * connected to it.  
         */
@@ -692,10 +700,11 @@ shared {
         *    resv    - allow setting perm/temp resvs
         *    tresv   - allow setting temp resvs
         *    unresv  - allow removing xlines
+        *    rehash  - allow rehashing
         *    all     - allow oper/server to do all of above.
         *    locops  - allow locops - only used for servers who cluster
         *    die     - allow restarting/dying of servers
-        *    rehash  - allow rehashing
+        *    modules - allow loading/unloading/reloading of modules
         *    dline   - allow setting perm/temp dlines
         *    tdline  - allow setting temp dlines
         *    undline - allow removing dlines
@@ -778,8 +787,11 @@ channel {
         */
        use_except = yes;
 
-       /* forward: Enable/disable channel mode +f, a channel to forward
-        * users to if they can't join because of +i etc.
+       /* forward: Enable/disable channel mode +f, which allows you to set 
+        * a channel to forward users to if they can't join because of +i etc.
+        * Disabling this option via rehash will leave all previously set 
+        * forwards hanging around, though they will not do anything. For 
+        * this reason, you may want to restart to disable this option.
         */
        use_forward = yes;
 
@@ -1106,7 +1118,7 @@ general {
         */
        min_nonwildcard_simple = 3;
 
-        /* max accept: maximum allowed /accept's for +g usermode */
+        /* max accept: maximum allowed /accept's for +gGR usermodes */
         max_accept = 20;
 
        /* max monitor: the maximum amount of nicknames a client may have in
@@ -1194,6 +1206,13 @@ general {
         */
        warn_no_nline = yes;
 
+       /* use propagated bans: KLINE, XLINE and RESV set fully propagated bans.
+        * That means the bans are part of the netburst and restarted/split
+        * servers will get them, but they will not apply to 3.2 and older
+        * servers at all.
+        */
+       use_propagated_bans = yes;
+
        /* stats e disabled: disable stats e.  useful if server ips are
         * exempted and you dont want them listing on irc.
         */
@@ -1279,16 +1298,25 @@ general {
         */
        connect_timeout = 30 seconds;
 
+       /* ident timeout: Amount of time (in seconds) that the IRCd will
+        * wait for a user to respond to an ident request.
+        */
+       default_ident_timeout = 5;
+
        /* disable auth: disables identd checking */
        disable_auth = no;
 
-       /* no oper flood: increase flood limits for opers. */
+       /* no oper flood: increase flood limits for opers.
+        * This option quadruples the user command flood limits, it
+        * DOES NOT affect PRIVMSG/NOTICE usage.
+        */
        no_oper_flood = yes;
 
        /* true no oper flood: Allow opers to NEVER hit flood limits.
         * With the above setting, flood limits are set to 4x what they
         * are for normal users. With this setting, they're removed entirely.
         * For this setting to work, you need to have no_oper_flood enabled as well.
+        * This option DOES allow PRIVMSG/NOTICE flooding.
         * ENABLE THIS SETTING WITH CAUTION.
         */
        true_no_oper_flood = no;
@@ -1327,7 +1355,7 @@ general {
         * +V - noinvite   - Block INVITE to user.
         * +B - bot        - Marks as a bot.
         * +p - override   - Implicit operator access in all channels.
-        *                   This is oper-only and requires the oper:override privledge.
+        *                   This is oper-only and requires the oper:override priv.
         */
         
        /* oper only umodes: usermodes only opers may set */