reference.conf: Correct description of general::client_exit.

[solanum.git] / doc / reference.conf

diff --git a/doc/reference.conf b/doc/reference.conf
index 70b555002e7df51168dd44727522a56c7bf83d35..2017a8f6abb957cfbfaadc78330df981d24c2fbc 100755 (executable)
--- a/doc/reference.conf
+++ b/doc/reference.conf
@@ -160,6 +160,11 @@ serverinfo {
         *   /quote set maxclients <limit>
         */
        default_max_clients = 1024;
+
+       /* nicklen: enforced nickname length (for this server only; must not
+        * be longer than the maximum length set while building).
+        */
+       nicklen = 30;
 };
 
 /* admin {}: contains admin information about the server. (OLD A:) */
@@ -267,7 +272,13 @@ class "server" {
         */
        connectfreq = 5 minutes;
 
-       /* max number: the amount of servers to autoconnect to */
+       /* max number: the amount of servers to autoconnect to.  if the number
+        * of servers in the class is or exceeds this, no more servers in the
+        * class are autoconnected.  oper initiated connects are unaffected.
+        * this should usually be set to either 0 or 1.  (autoconnecting from
+        * hubs to leaves may cause leaves to function as hubs by having
+        * multiple servers connected to them.)
+        */
        max_number = 1;
 
        /* sendq: servers need a higher sendq as they are sent more data */
@@ -276,6 +287,13 @@ class "server" {
 
 /* listen {}: contain information about the ports ircd listens on (OLD P:) */
 listen {
+       /* defer_accept: wait for clients to send IRC handshake data before
+        * accepting them.  if you intend to use software which depends on the
+        * server replying first, such as BOPM, you should disable this feature.
+        * otherwise, you probably want to leave it on.
+        */
+       defer_accept = yes;
+
        /* port: the specific port to listen on.  if no host is specified
         * before, it will listen on all available IPs.
         *
@@ -314,6 +332,12 @@ auth {
        user = "*@172.16.0.0/12";
        user = "*test@123D:B567:*";
 
+       /* auth_user: This allows specifying a username:password instead of
+        * just a password in PASS, so that a fixed user@host is not
+        * necessary for a specific auth{} block.
+        */
+       #auth_user = "SomeUser";
+
        /* password: an optional password that is required to use this block.
         * By default this is not encrypted, specify the flag "encrypted" in
         * flags = ...; below if it is.
@@ -368,8 +392,6 @@ auth {
 auth {
        user = "*@*";
        class = "users";
-       
-       flags = need_ident;
 };
 
 /* privset{}: defines operator privilege sets. */
@@ -744,13 +766,6 @@ channel {
         * mode with a different key, kick all local users.
         *
         * note: this does not take +r, +b, +e and +I into account.
-        *
-        * warning: if there are any TS5 servers on the network, this
-        * will cause ban desyncs if they send such an SJOIN and the
-        * splitriders added any bans (our side will lose them, the TS5
-        * side will accept them). we will send a notice to the channel
-        * if this happens. most services do not send such SJOINs but
-        * ratbox-services does.
         */
        kick_on_split_riding = no;
 
@@ -1008,7 +1023,7 @@ general {
        ts_warn_delta = 30 seconds;
        ts_max_delta = 5 minutes;
 
-       /* client exit: prepend a users quit message with "Client exit: " */
+       /* client exit: prepend a user's quit message with "Quit: " */
        client_exit = yes;
 
        /* collision fnc: change user's nick to their UID instead of
@@ -1019,6 +1034,13 @@ general {
         */
        collision_fnc = yes;
 
+       /* resv fnc: change a user's nick to a nick they have recently used
+        * (or their UID, if no such nick can be found) when a resv matching
+        * them is set by services. Only enable this if all servers on the
+        * network allow remote nicks to start with a digit.
+        */
+       resv_fnc = yes;
+
        /* global snotices: send out certain snotices (most +b, +f, +y,
         * some +s) to other servers via ENCAP SNOTE. Received SNOTEs are
         * displayed unconditionally.
@@ -1266,6 +1288,19 @@ general {
        client_flood_burst_max = 5;
        client_flood_message_time = 1;
        client_flood_message_num = 2;
+
+       /* max_ratelimit_tokens: the maximum number of ratelimit tokens that one
+        * user can accumulate. This attempts to limit the amount of outbound
+        * bandwidth one user can consume.  Do not change unless you know what
+        * you're doing.
+        */
+       max_ratelimit_tokens = 30;
+
+       /* away_interval: the minimum interval between AWAY commands. One
+        * additional AWAY command is allowed, and only marking as away
+        * counts.
+        */
+       away_interval = 30;
 };
 
 modules {