added basic ssl support to ircu

[ircu2.10.12-pk.git] / doc / readme.features

diff --git a/doc/readme.features b/doc/readme.features
index 63fa54d43ac6ce18e17740bf8163aeae0923a10d..de1b33276cf3769e9bea5e8de4cbfb6c062926cd 100644 (file)
--- a/doc/readme.features
+++ b/doc/readme.features
@@ -1,7 +1,7 @@
 Many of the old compile-time options are now configured through the
 server configuration file, ircd.conf.  This file is intended to
 document each of these features.  Logging, although also configured
 Many of the old compile-time options are now configured through the
 server configuration file, ircd.conf.  This file is intended to
 document each of these features.  Logging, although also configured

-through the use of F-lines, is documented in doc/readme.log.  NOTE
+through the use of Feature entries, is documented in doc/readme.log.  NOTE

 THAT THESE NAMES ARE CASE SENSITIVE!  Values are not case sensitive
 unless stated otherwise in the documentation for that feature.
 
 THAT THESE NAMES ARE CASE SENSITIVE!  Values are not case sensitive
 unless stated otherwise in the documentation for that feature.
 


@@ -293,7 +293,7 @@ This is the expected average ban mask length.  Leave it at 40.
 
 MAXBANS
  * Type: integer
 
 MAXBANS
  * Type: integer

- * Default: 30
+ * Default: 45

 
 This is the maximum number of bans a user may set on a given channel.
 
 
 This is the maximum number of bans a user may set on a given channel.
 


@@ -363,8 +363,8 @@ CONNECTFREQUENCY
 
 This is the default frequency that the server attempts to reconnect
 with its uplink server if it is set to auto connect to it. Note that
 
 This is the default frequency that the server attempts to reconnect
 with its uplink server if it is set to auto connect to it. Note that

-this value is overridden by a Class block in ircd.conf if the C-lines
-in ircd.conf assign a specific class to the connection (recommended).
+this value is overridden by a Class block in ircd.conf if the Connect
+entries in ircd.conf assign a specific class to the connection.

 
 DEFAULTMAXSENDQLENGTH
  * Type: integer
 
 DEFAULTMAXSENDQLENGTH
  * Type: integer


@@ -372,9 +372,7 @@ DEFAULTMAXSENDQLENGTH
 
 This is the default value of the maximum sendQ length of connection
 classes (see doc/example.conf for details on Class blocks).  You will
 
 This is the default value of the maximum sendQ length of connection
 classes (see doc/example.conf for details on Class blocks).  You will

-probably always override this value in your "ircd.conf" with the
-Y-lines.  The given value used to be an often used value for client
-sendQs.
+generally override this value in your "ircd.conf" with a Class block.

 
 GLINEMAXUSERCOUNT
  * Type: integer
 
 GLINEMAXUSERCOUNT
  * Type: integer


@@ -439,13 +437,12 @@ CONFIG_OPERCMDS
  * Type: boolean
  * Default: FALSE
 
  * Type: boolean
  * Default: FALSE
 

-For u2.10.11, several new oper-only features have been added that
-involve changes to the server<->server protocol.  Until the entire
-network is running the new version, these features cannot be enabled.
-This configuration option provides a single switch to prevent the use
-of these features until the entire network has been upgraded.  It is
-not required that all servers set this to "TRUE" in order for the
-features to be used.
+Since u2.10.11, several new oper-only features have been added that
+involve changes to the server<->server protocol.  This configuration
+option provides a single switch to prevent the use of these features
+until the entire network has been upgraded.  It is not required that
+all servers set this to "TRUE" in order for the features to be used,
+as long as all servers are running u2.10.11 or above.

 
 HIS_MAP
  * Type: boolean
 
 HIS_MAP
  * Type: boolean


@@ -495,35 +492,23 @@ HIS_STATS_a
 
 As per UnderNet CFV-165, this removes /STATS a from users.
 
 
 As per UnderNet CFV-165, this removes /STATS a from users.
 

-HIS_STATS_l
- * Type: boolean
- * Default: TRUE
-
-As per UnderNet CFV-165, this removes /STATS l from users.
-
-HIS_STATS_L
- * Type: boolean
- * Default: TRUE
-
-As per UnderNet CFV-165, this removes /STATS L from users.
-

 HIS_STATS_c
  * Type: boolean
  * Default: TRUE
 
 As per UnderNet CFV-165, this removes /STATS c from users.
 
 HIS_STATS_c
  * Type: boolean
  * Default: TRUE
 
 As per UnderNet CFV-165, this removes /STATS c from users.
 

-HIS_STATS_g
+HIS_STATS_d

  * Type: boolean
  * Default: TRUE
 
  * Type: boolean
  * Default: TRUE
 

-As per UnderNet CFV-165, this removes /STATS g from users.
+As per UnderNet CFV-165, this removes /STATS d from users.

 
 

-HIS_STATS_k
+HIS_STATS_e

  * Type: boolean
  * Default: TRUE
 
  * Type: boolean
  * Default: TRUE
 

-As per UnderNet CFV-165, this removes /STATS k from users.
+As per UnderNet CFV-165, this removes /STATS e from users.

 
 HIS_STATS_f
  * Type: boolean
 
 HIS_STATS_f
  * Type: boolean


@@ -531,6 +516,12 @@ HIS_STATS_f
 
 As per UnderNet CFV-165, this removes /STATS f from users.
 
 
 As per UnderNet CFV-165, this removes /STATS f from users.
 

+HIS_STATS_g
+ * Type: boolean
+ * Default: TRUE
+
+As per UnderNet CFV-165, this removes /STATS g from users.
+

 HIS_STATS_i
  * Type: boolean
  * Default: TRUE
 HIS_STATS_i
  * Type: boolean
  * Default: TRUE


@@ -549,6 +540,24 @@ HIS_STATS_J
 
 As per UnderNet CFV-165, this removes /STATS J from users.
 
 
 As per UnderNet CFV-165, this removes /STATS J from users.
 

+HIS_STATS_k
+ * Type: boolean
+ * Default: TRUE
+
+As per UnderNet CFV-165, this removes /STATS k from users.
+
+HIS_STATS_l
+ * Type: boolean
+ * Default: TRUE
+
+As per UnderNet CFV-165, this removes /STATS l from users.
+
+HIS_STATS_L
+ * Type: boolean
+ * Default: TRUE
+
+As per UnderNet CFV-165, this removes /STATS L from users.
+

 HIS_STATS_M
  * Type: boolean
  * Default: TRUE
 HIS_STATS_M
  * Type: boolean
  * Default: TRUE


@@ -591,18 +600,6 @@ HIS_STATS_R
 
 As per UnderNet CFV-165, this removes /STATS R from users.
 
 
 As per UnderNet CFV-165, this removes /STATS R from users.
 

-HIS_STATS_d
- * Type: boolean
- * Default: TRUE
-
-As per UnderNet CFV-165, this removes /STATS d from users.
-
-HIS_STATS_e
- * Type: boolean
- * Default: TRUE
-
-As per UnderNet CFV-165, this removes /STATS e from users.
-

 HIS_STATS_t
  * Type: boolean
  * Default: TRUE
 HIS_STATS_t
  * Type: boolean
  * Default: TRUE


@@ -657,6 +654,13 @@ HIS_STATS_z
 
 As per UnderNet CFV-165, this removes /STATS z from users.
 
 
 As per UnderNet CFV-165, this removes /STATS z from users.
 

+HIS_STATS_IAUTH
+ * Type: boolean
+ * Default: TRUE
+
+As per UnderNet CFV-165, this disables /STATS IAUTH and
+/STATS IAUTHCONF from users.
+

 HIS_WHOIS_SERVERNAME
  * Type: boolean
  * Default: TRUE
 HIS_WHOIS_SERVERNAME
  * Type: boolean
  * Default: TRUE


@@ -682,6 +686,13 @@ HIS_WHO_HOPCOUNT
 As per UnderNet CFV-165, this replaces hopcount to a static 3 in
 replies to /WHO.
 
 As per UnderNet CFV-165, this replaces hopcount to a static 3 in
 replies to /WHO.
 

+HIS_MODEWHO
+ * Type: boolean
+ * Default: TRUE
+
+As per UnderNet CFV-165, this doesn't show which server performed a channel
+mode change.
+

 HIS_BANWHO
  * Type: boolean
  * Default: TRUE
 HIS_BANWHO
  * Type: boolean
  * Default: TRUE


@@ -754,9 +765,17 @@ URL_CLIENTS
 
 This defines a URL that users may visit to find compatible IRC clients.
 
 
 This defines a URL that users may visit to find compatible IRC clients.
 

+URLREG
+ * Type: string
+ * Default: "http://cservice.undernet.org/live/"
+
+This defines a URL that is used in server response 477 (ERR_NEEDREGGEDNICK) to
+let users know which website they must visit to obtain a proper account for
+authentication.
+

 NICKLEN
  * Type: integer
 NICKLEN
  * Type: integer

- * Default: 9
+ * Default: 12

 
 This is the allowed length of the nickname length.  It may not be
 larger than the NICKLEN #define, and should usually be the same
 
 This is the allowed length of the nickname length.  It may not be
 larger than the NICKLEN #define, and should usually be the same


@@ -856,3 +875,22 @@ CHANNELLEN
 This is the allowed length of locally created channels.  It may not be
 larger than the CHANNELLEN #define.  Like the NICKLEN feature, this is
 intended to ease changes in channel name length across a network.
 This is the allowed length of locally created channels.  It may not be
 larger than the CHANNELLEN #define.  Like the NICKLEN feature, this is
 intended to ease changes in channel name length across a network.

+
+OPLEVELS
+ * Type: boolean
+ * Default: TRUE
+
+This allows local users to set the +A and +U modes (admin and user
+passwords, respectively) on channels where they are marked as channel
+managers.  This feature must be disabled until all servers on the
+network are able to interpret and handle these modes correctly.
+
+ZANNELS
+ * Type: boolean
+ * Default: TRUE
+
+This preserves empty channels with no admin password so that it is
+impractical to become the channel manager by clearing out the channel.
+It must be set to FALSE if there are both 2.10.11.x servers and
+2.10.12.y servers on the network where y < 4.  It should be set to
+TRUE whenever the OPLEVELS features is TRUE.