added basic ssl support to ircu
[ircu2.10.12-pk.git] / doc / readme.features
index 2bad879611813268e7537c54c122cf9bf8094686..de1b33276cf3769e9bea5e8de4cbfb6c062926cd 100644 (file)
@@ -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
-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.
 
@@ -185,11 +185,10 @@ If you are playing with the server off-line, and no DNS is available,
 then long delays occur before the server starts up because it tries to
 resolve the name given in the General block (which usually isn't given
 in /etc/hosts) and for each connecting client.  If you specify "TRUE"
-here, then a call to gethostbyname() will be done only for the real
-hostname, and the server will not try to resolve clients that connect
-to "localhost."  Note that other calls to gethostbyname() are still
-done if you use VIRTUAL_HOST; also note that the server still tries to
-resolve clients that connect to the real IP address of the server.
+here, then a DNS lookup will be done only for the real hostname, and
+the server will not try to resolve clients that connect to
+"localhost."  Note that other DNS lookups are still done for outbound
+connections.
 
 RANDOM_SEED
  * Type: string
@@ -294,7 +293,7 @@ This is the expected average ban mask length.  Leave it at 40.
 
 MAXBANS
  * Type: integer
- * Default: 30
+ * Default: 45
 
 This is the maximum number of bans a user may set on a given channel.
 
@@ -364,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 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
@@ -373,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
-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
@@ -411,18 +408,6 @@ PPATH is the filename (relative to DPATH) or the full path of the
 "PID" file.  It is used for storing the server's process ID so that a
 ps(1) isn't necessary.
 
-VIRTUAL_HOST
- * Type: boolean
- * Default: FALSE
-
-This option is only needed when you wish to run multiple IRC servers
-on the same machine, and they must share at least one port.  This will
-require having multiple IP addresses for the machine that will be
-hosting the servers.  If you specify "TRUE" here, you can cause the
-server to bind to one of these IP addresses.  Use the vhost field of
-the General block to specify the IP address.  If you are unsure, stick
-with "FALSE."
-
 TOS_SERVER
  * Type: integer
  * Default: 0x08
@@ -452,13 +437,12 @@ CONFIG_OPERCMDS
  * 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
@@ -502,11 +486,11 @@ HIS_TRACE
 
 As per UnderNet CFV-165, this removes /TRACE from users.
 
-HIS_STATS_l
+HIS_STATS_a
  * Type: boolean
  * Default: TRUE
 
-As per UnderNet CFV-165, this removes /STATS l from users.
+As per UnderNet CFV-165, this removes /STATS a from users.
 
 HIS_STATS_c
  * Type: boolean
@@ -514,29 +498,29 @@ HIS_STATS_c
 
 As per UnderNet CFV-165, this removes /STATS c from users.
 
-HIS_STATS_g
+HIS_STATS_d
  * 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_h
+HIS_STATS_e
  * Type: boolean
  * Default: TRUE
 
-As per UnderNet CFV-165, this removes /STATS h from users.
+As per UnderNet CFV-165, this removes /STATS e from users.
 
-HIS_STATS_k
+HIS_STATS_f
  * Type: boolean
  * Default: TRUE
 
-As per UnderNet CFV-165, this removes /STATS k from users.
+As per UnderNet CFV-165, this removes /STATS f from users.
 
-HIS_STATS_f
+HIS_STATS_g
  * Type: boolean
  * Default: TRUE
 
-As per UnderNet CFV-165, this removes /STATS f from users.
+As per UnderNet CFV-165, this removes /STATS g from users.
 
 HIS_STATS_i
  * Type: boolean
@@ -550,6 +534,30 @@ HIS_STATS_j
 
 As per UnderNet CFV-165, this removes /STATS j from users.
 
+HIS_STATS_J
+ * Type: boolean
+ * Default: TRUE
+
+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
@@ -586,17 +594,11 @@ HIS_STATS_r
 
 As per UnderNet CFV-165, this removes /STATS r from users.
 
-HIS_STATS_d
+HIS_STATS_R
  * 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.
+As per UnderNet CFV-165, this removes /STATS R from users.
 
 HIS_STATS_t
  * Type: boolean
@@ -652,6 +654,13 @@ HIS_STATS_z
 
 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
@@ -674,7 +683,15 @@ HIS_WHO_HOPCOUNT
  * Type: boolean
  * Default: TRUE
 
-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
@@ -708,6 +725,12 @@ HIS_NETSPLIT
 
 As per UnderNet CFV-165, this removes server names in net break sign-offs.
 
+HIS_WHOIS_LOCALCHAN
+ * Type: boolean
+ * Default: TRUE
+
+As per UnderNet CFV-165, this removes local channels in replies to /WHOIS.
+
 HIS_SERVERNAME
  * Type: string
  * Default: "*.undernet.org"
@@ -742,9 +765,17 @@ URL_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
- * 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
@@ -822,3 +853,44 @@ ANNOUNCE_INVITES
 
 If set, send RPL_ISSUEDINVITE (345) to a channel's operators to
 announce when someone is invited to the channel.
+
+LOCAL_CHANNELS
+ * Type: boolean
+ * Default: TRUE
+
+If set, allow users to create local channels.
+
+TOPIC_BURST
+ * Type: boolean
+ * Default: FALSE
+
+If set, send the current topic value and timestamp for channels during
+burst.  This generally only makes sense for hubs to use, and it causes
+a large increase in net.burst size.
+
+CHANNELLEN
+ * Type: integer
+ * Default: 200
+
+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.