Author: Alex Badea <vampire@p16.pub.ro> (by way of Kev <klmitch@mit.edu>)

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

diff --git a/doc/readme.features b/doc/readme.features
index 74520d867683f0d7cb0b2d0029bccf107975c74e..5d9aea641d87b75f8cd66407061a6bec55861190 100644 (file)
--- a/doc/readme.features
+++ b/doc/readme.features
@@ -119,6 +119,13 @@ MOTD to the client by default; instead, it will only tell the client
 when the MOTD was last changed, and give instructions on how to obtain
 it by typing /MOTD.
 
+MOTD_BANNER
+ * Type: string
+ * Default: NULL
+
+If you enable NODEFAULTMOTD, this specifies a one-line banner to be sent
+to the client in addition to the instructions mentioned above.
+
 KILL_IPMISMATCH
  * Type: boolean
  * Default: FALSE
@@ -214,6 +221,27 @@ many client disappear that the whole "whowas" list is refreshed a few
 times (unless you make it rather large).  A reasonable value is "total
 number of clients" / 25.
 
+HOST_HIDING
+ * Type: boolean
+ * Default: FALSE
+
+This selects whether local users can set umode +x, thus allowing them
+to hide their hostname if they have also registered with a channel
+service (i.e. they have the ACCOUNT flag set).
+
+HIDDEN_HOST
+ * Type: string
+ * Default: users.undernet.org
+
+This selects the suffix for the hidden hostmask (see HOST_HIDING).
+
+HIDDEN_IP
+ * Type: string
+ * Default: 127.0.0.1
+
+This selects a fake IP to be shown on /USERIP and /WHO %i when the
+target has a hidden host (see HOST_HIDING).
+
 KILLCHASETIMELIMIT
  * Type: integer
  * Default: 30
@@ -402,6 +430,15 @@ This option is used to specify the type of service that will be
 requested for connections to users.  The value may be given as a
 hexadecimal integer.
 
+POLLS_PER_LOOP
+ * Type: integer
+ * Default: 200
+
+Some of the engines used by the event interface get a number of events
+from the kernel at once.  Since the number retrieved can impact
+performance, it can be tuned by modifying this value.  The engines
+enforce a lower limit of 20.
+
 CRYPT_OPER_PASSWORD
  * Type: boolean
  * Default: TRUE
@@ -587,7 +624,7 @@ REGULATED BY THE UNDERNET ADMINISTRATION.
 
 OPER_SET
  * Type: boolean
- * Default: TRUE
+ * Default: FALSE
 
 This selects whether global IRC operators on this server are permitted
 to use the /SET command to set various feature values.
@@ -610,6 +647,13 @@ This selects whether global IRC operators on this server are permitted
 to use the /GLINE command with the ! flag to force slightly wide
 G-lines to be set.
 
+OPER_LIST_CHAN 
+ * Type: boolean
+ * Default: TRUE
+
+This selects whether global IRC operators are permitted to list secret 
+(+s) channels.
+
 LOCOP_KILL
  * Type: boolean
  * Default: TRUE
@@ -691,3 +735,11 @@ LOCOP_WIDE_GLINE
 This selects whether local IRC operators are permitted to use the
 /GLINE command with the ! flag to force slightly wide G-lines to be
 set.
+
+LOCOP_LIST_CHAN
+ * Type: boolean
+ * Default: FALSE
+ 
+This selects whether local IRC operators are permitted to list secret 
+(+s) channels.
+