- Minor cleanups to reference.conf

git-svn-id: svn://svn.ircd-hybrid.org/svnroot/ircd-hybrid/trunk@1863 82007160-df01-0410-b94d-b575c5fd34c7

1 files changed, 74 insertions, 75 deletions

diff --git a/doc/reference.conf b/doc/reference.conf
index eebc917..0407b72 100644
--- a/doc/reference.conf
+++ b/doc/reference.conf
@@ -47,7 +47,7 @@ serverinfo {
 	 * sid: a server's unique ID.  This is three characters long and must
 	 * be in the form [0-9][A-Z0-9][A-Z0-9].  The first character must be
 	 * a digit, followed by 2 alpha-numerical letters.
-	 * NOTE: The letters must be capitalized.  This cannot be changed at runtime.
+	 * NOTE: The letters must be capitalized. This cannot be changed at runtime.
 	 */
 	sid = "0HY";
 
@@ -58,7 +58,7 @@ serverinfo {
 
 	/*
 	 * network info: the name and description of the network this server
-	 * is on.  Shown in the 005 reply and used with serverhiding.
+	 * is on. Shown in the 005 reply and used with serverhiding.
 	 */
 	network_name = "MyNet";
 	network_desc = "This is My Network";
@@ -81,7 +81,7 @@ serverinfo {
 	 */
 	#vhost6 = "3ffe:80e8:546::2";
 
-	/* max_clients: the maximum number of clients allowed to connect */
+	/* max_clients: the maximum number of clients allowed to connect. */
 	max_clients = 512;
 
 	/*
@@ -117,7 +117,9 @@ serverinfo {
 	 * ssl certificate for encrypted client connection.
 	 *
 	 * This assumes your private RSA key is stored in rsa.key. You
-	 * MUST have an RSA key in order to generate the certificate
+	 * MUST have an RSA key in order to generate the certificate.
+	 *
+	 * Example command:
 	 *
 	 *	openssl req -new -days 365 -x509 -key rsa.key -out cert.pem
 	 *
@@ -192,7 +194,7 @@ admin {
  * class {}:  contains information about classes for users
  */
 class {
-	/* name: the name of the class */
+	/* name: the name of the class. */
 	name = "users";
 
 	/*
@@ -225,7 +227,7 @@ class {
 
 	/*
 	 * the following lines are optional and allow you to define
-	 * how many users can connect from one /NN subnet
+	 * how many users can connect from one /NN subnet.
 	 */
 	cidr_bitlen_ipv4 = 24;
 	cidr_bitlen_ipv6 = 120;
@@ -253,12 +255,12 @@ class {
 	sendq = 100 kbytes;
 
 	/*
-	 * min_idle: minimum idle time that is shown in /whois
+	 * min_idle: minimum idle time that is shown in /whois.
 	 */
 	min_idle = 3 hours;
 
 	/*
-	 * max_idle: maximum idle time that is shown in /whois
+	 * max_idle: maximum idle time that is shown in /whois.
 	 */
 	max_idle = 8 hours;
 
@@ -277,15 +279,15 @@ class {
 	ping_time = 90 seconds;
 
 	/*
-	 * connectfreq: only used in server classes.  Specifies the delay
+	 * connectfreq: only used in server classes. Specifies the delay
 	 * between autoconnecting to servers.
 	 */
 	connectfreq = 5 minutes;
 
-	/* max number: the amount of servers to autoconnect to */
+	/* max number: the amount of servers to autoconnect to. */
 	max_number = 1;
 
-	/* sendq: servers need a higher sendq as they send more data */
+	/* sendq: servers need a higher sendq as they send more data. */
 	sendq = 2 megabytes;
 };
 
@@ -294,7 +296,7 @@ class {
  */
 listen {
 	/*
-	 * port: the specific port to listen on.  If no host is specified
+	 * port: the specific port to listen on. If no host is specified
 	 * before, it will listen on all available IPs.
 	 *
 	 * Ports are separated via a comma, a range may be specified using ".."
@@ -307,7 +309,7 @@ listen {
 	 * Listen on 192.168.0.1/6697 with ssl enabled and hidden from STATS P
 	 * unless you are an administrator.
 	 *
-	 * NOTE: The "flags" directive has to come before "port".  Always!
+	 * NOTE: The "flags" directive has to come before "port". Always!
 	 *
 	 * Currently available flags are:
 	 *
@@ -321,7 +323,7 @@ listen {
 
 	/*
 	 * host: set a specific IP/host the ports after the line will listen 
-	 * on.  This may be ipv4 or ipv6.
+	 * on. This may be ipv4 or ipv6.
 	 */
 	host = "1.2.3.4";
 	port = 7000, 7001;
@@ -351,8 +353,8 @@ auth {
 	encrypted = yes;
 
 	/*
-	 * spoof: fake the users host to this.  This is free-form,
-	 * just do everyone a favor and don't abuse it. ('=' prefix on /stats I)
+	 * spoof: fake the users host to this. This is free-form, just do
+	 * everyone a favor and don't abuse it. ('=' prefix on /stats I)
 	 */
 	spoof = "I.still.hate.packets";
 
@@ -380,8 +382,8 @@ auth {
 
 auth {
 	/*
-	 * redirect: the server and port to redirect a user to.  A user does
-	 * not have to obey the redirection, the ircd just suggests an alternative
+	 * redirect: the server and port to redirect a user to. A user does not
+	 * have to obey the redirection, the ircd just suggests an alternative
 	 * server for them.
 	 */
 	redirserv = "this.is.not.a.real.server";
@@ -401,9 +403,6 @@ auth {
 
 /*
  * operator {}:  defines ircd operators
- *
- * ircd-hybrid no longer supports local operators, privileges are
- * controlled via flags.
  */
 operator {
 	/* name: the name of the oper */
@@ -417,7 +416,7 @@ operator {
 	user = "*@127.0.0.0/8";
 
 	/*
-	 * password: the password required to oper.  By default this will
+	 * password: the password required to oper. By default this will
 	 * need to be encrypted by using the provided mkpasswd tool.
 	 * Several password hash algorithms are available depending
 	 * on your system's crypt() implementation. For example, a modern
@@ -443,7 +442,7 @@ operator {
 	class = "opers";
 
 	/*
-	 * umodes: default usermodes opers get when they /oper.  If defined,
+	 * umodes: default usermodes opers get when they /oper. If defined,
 	 * it will override oper_umodes settings in general {}.
 	 * Available usermodes:
 	 *
@@ -520,7 +519,7 @@ connect {
 	name = "irc.uplink.com";
 
 	/*
-	 * host: the host or IP to connect to.  If a hostname is used it
+	 * host: the host or IP to connect to. If a hostname is used it
 	 * must match the reverse dns of the server.
 	 */
 	host = "192.168.0.1";
@@ -549,14 +548,14 @@ connect {
 	port = 6666;
 
 	/*
-	 * hub_mask: the mask of servers that this server may hub.  Multiple
-	 * entries are permitted
+	 * hub_mask: the mask of servers that this server may hub. Multiple
+	 * entries are permitted.
 	 */
 	hub_mask = "*";
 
 	/*
-	 * leaf_mask: the mask of servers this server may not hub.  Multiple
-	 * entries are permitted.  Useful for forbidding EU -> US -> EU routes.
+	 * leaf_mask: the mask of servers this server may not hub. Multiple
+	 * entries are permitted. Useful for forbidding EU -> US -> EU routes.
 	 */
 #	leaf_mask = "*.uk";
 
@@ -639,18 +638,18 @@ cluster {
  *
  * NOTE: This can be effectively used for remote klines.
  *       Please note that there is no password authentication
- *       for users setting remote klines.  You must also be
+ *       for users setting remote klines. You must also be
  *       /oper'd in order to issue a remote kline.
  */
 shared {
 	/*
-	 * name: the server the user must be on to set klines.  If this is not
+	 * name: the server the user must be on to set klines. If this is not
 	 * specified, the user will be allowed to kline from all servers.
 	 */
 	name = "irc2.some.server";
 
 	/*
-	 * user: the user@host mask that is allowed to set klines.  If this is
+	 * user: the user@host mask that is allowed to set klines. If this is
 	 * not specified, all users on the server above will be allowed to set
 	 * a remote kline.
 	 */
@@ -701,7 +700,7 @@ deny {
 };
 
 /*
- * exempt {}: IPs that are exempt from deny {} and Dlines
+ * exempt {}:  IPs that are exempt from deny {} and Dlines
  */
 exempt {
 	ip = "192.168.0.0/16";
@@ -723,7 +722,7 @@ resv { mask = "#*services*"; reason = "Reserved for services"; };
 resv {
 	/*
 	 * mask: masks starting with a '#' are automatically considered
-	 * as channel name mask
+	 * as channel name mask.
 	 */
 	mask = "#helsinki";
 	reason = "Channel is reserved for finnish inhabitants";
@@ -737,8 +736,7 @@ resv {
 };
 
 /*
- * gecos {}:  The X: replacement, used for banning users based on
- * their "realname".
+ * gecos {}:  Used for banning users based on their "realname".
  */
 gecos {
 	name = "*sex*";
@@ -827,13 +825,13 @@ channel {
 
 	/*
 	 * default_split_user_count: when the usercount is lower than this level,
-	 * consider ourselves split.  This must be set for automatic splitmode.
+	 * consider ourselves split. This must be set for automatic splitmode.
 	 */
 	default_split_user_count = 0;
 
 	/*
 	 * default_split_server_count: when the servercount is lower than this,
-	 * consider ourselves split.  This must be set for automatic splitmode.
+	 * consider ourselves split. This must be set for automatic splitmode.
 	 */
 	default_split_server_count = 0;
 
@@ -851,7 +849,7 @@ channel {
 serverhide {
 	/*
 	 * flatten_links: this option will show all servers in /links appear
-	 * that they are linked to this current server
+	 * that they are linked to this current server.
 	 */
 	flatten_links = no;
 
@@ -863,7 +861,7 @@ serverhide {
 
 	/*
 	 * hidden: hide this server from a /links output on servers that
-	 * support it.  This allows hub servers to be hidden etc.
+	 * support it. This allows hub servers to be hidden etc.
 	 */
 	hidden = no;
 
@@ -910,30 +908,30 @@ general {
 	/* max_watch: maximum WATCH entries a client can have. */
 	max_watch = 60;
 
-	/* gline_enable: enable glines, network wide temp klines */
+	/* gline_enable: enable glines, network wide temp klines. */
 	gline_enable = yes;
 
 	/*
 	 * gline_duration: the amount of time a gline will remain on your
-	 * server before expiring
+	 * server before expiring.
 	 */
 	gline_duration = 1 day;
 
 	/*
-	 * gline_request_duration:  how long a pending G-line can be around.
-	 * 10 minutes should be plenty
+	 * gline_request_duration: how long a pending G-line can be around.
+	 * 10 minutes should be plenty.
 	 */
 	gline_request_duration = 10 minutes;
 
 	/*
 	 * gline_min_cidr: the minimum required length of a CIDR bitmask
-	 * for IPv4 based glines
+	 * for IPv4 based glines.
 	 */
 	gline_min_cidr = 16;
 
 	/*
 	 * gline_min_cidr6: the minimum required length of a CIDR bitmask
-	 * for IPv6 based glines
+	 * for IPv6 based glines.
 	 */
 	gline_min_cidr6 = 48;
 
@@ -943,21 +941,22 @@ general {
 	invisible_on_connect = yes;
 
 	/*
-	 * Max time from the nickname change that still causes KILL
-	 * automatically to switch for the current nick of that user.
+	 * kill_chase_time_limit: maximum time from the nickname change that
+	 * still causes KILL automatically to switch for the current nick of
+	 * that user.
 	 */
 	kill_chase_time_limit = 90 seconds;
 
 	/*
-	 * If hide_spoof_ips is disabled, opers will be allowed to see the real
+	 * hide_spoof_ips: if disabled, opers will be allowed to see the real
 	 * IP of spoofed users in /trace etc. If this is defined they will be
 	 * shown a masked IP.
 	 */
 	hide_spoof_ips = yes;
 
 	/*
-	 * Ignore bogus timestamps from other servers.  Yes, this will desync
-	 * the network, but it will allow chanops to resync with a valid non TS 0
+	 * Ignore bogus timestamps from other servers. Yes, this will desync the
+	 * network, but it will allow chanops to resync with a valid non TS 0
 	 *
 	 * This should be enabled network wide, or not at all.
 	 */
@@ -969,7 +968,7 @@ general {
 	 */
 	disable_auth = no;
 
-	/* disable_remote_commands: disable users doing commands on remote servers */
+	/* disable_remote_commands: disable users doing commands on remote servers. */
 	disable_remote_commands = no;
 
 	/*
@@ -980,7 +979,7 @@ general {
 
 	/*
 	 * default_floodcount: the default value of floodcount that is configurable
-	 * via /quote set floodcount.  This is the amount of lines a user
+	 * via /quote set floodcount. This is the amount of lines a user
 	 * may send to any other user/channel in one second.
 	 */
 	default_floodcount = 10;
@@ -999,21 +998,21 @@ general {
 
 	/*
 	 * min_nonwildcard: the minimum non wildcard characters in k/d/g lines
-	 * placed via the server.  klines hand placed are exempt from limits.
+	 * placed via the server. K-lines hand placed are exempt from limits.
 	 * wildcard chars: '.' ':' '*' '?' '@' '!' '#'
 	 */
 	min_nonwildcard = 4;
 
 	/*
 	 * min_nonwildcard_simple: the minimum non wildcard characters in 
-	 * gecos bans.  wildcard chars: '*' '?' '#'
+	 * gecos bans. wildcard chars: '*' '?' '#'
 	 */
 	min_nonwildcard_simple = 3;
 
-	/* max_accept: maximum allowed /accept's for +g usermode */
+	/* max_accept: maximum allowed /accept's for +g usermode. */
 	max_accept = 20;
 
-	/* anti_nick_flood: enable the nickflood control code */
+	/* anti_nick_flood: enable the nickflood control code. */
 	anti_nick_flood = yes;
 
 	/* nick flood: the nick changes allowed in the specified period */
@@ -1028,7 +1027,7 @@ general {
 
 	/*
 	 * ts delta: the time delta allowed between server clocks before
-	 * a warning is given, or before the link is dropped.  all servers
+	 * a warning is given, or before the link is dropped. All servers
 	 * should run ntpdate/rdate to keep clocks in sync
 	 */
 	ts_warn_delta = 30 seconds;
@@ -1036,14 +1035,14 @@ general {
 
 	/*
 	 * warn_no_nline: warn opers about servers that try to connect but
-	 * we don't have a connect {} block for.  Twits with misconfigured 
+	 * we don't have a connect {} block for. Twits with misconfigured 
 	 * servers can get really annoying with this enabled.
 	 */
 	warn_no_nline = yes;
 
 	/*
 	 * stats_e_disabled: set this to 'yes' to disable "STATS e" for both
-	 * operators and administrators.  Doing so is a good idea in case
+	 * operators and administrators. Doing so is a good idea in case
 	 * there are any exempted (exempt{}) server IPs you don't want to
 	 * see leaked.
 	 */
@@ -1056,18 +1055,18 @@ general {
 	stats_P_oper_only = yes;
 
 	/*
-	 * stats i oper only: make stats i (auth {}) oper only. set to:
-	 *     yes:    show users no auth blocks, made oper only.
-	 *     masked: show users first matching auth block
-	 *     no:     show users all auth blocks.
+	 * stats i oper only: make stats i (auth {}) oper only. Set to:
+	 *     yes    - show users no auth blocks, made oper only.
+	 *     masked - show users first matching auth block
+	 *     no     - show users all auth blocks.
 	 */
 	stats_i_oper_only = yes;
 
 	/*
-	 * stats_k_oper_only: make stats k/K (klines) oper only.  set to:
-	 *     yes:    show users no auth blocks, made oper only
-	 *     masked: show users first matching auth block
-	 *     no:     show users all auth blocks.
+	 * stats_k_oper_only: make stats k/K (klines) oper only. Set to:
+	 *     yes    - show users no auth blocks, made oper only
+	 *     masked - show users first matching auth block
+	 *     no     - show users all auth blocks.
 	 */
 	stats_k_oper_only = yes;
 
@@ -1112,11 +1111,11 @@ general {
 
 	/*
 	 * true_no_oper_flood: completely eliminate flood limits for opers
-	 * and for clients with can_flood = yes in their auth {} blocks
+	 * and for clients with can_flood = yes in their auth {} blocks.
 	 */
 	true_no_oper_flood = yes;
 
-	/* oper_pass_resv: allow opers to over-ride RESVs on nicks/channels */
+	/* oper_pass_resv: allow opers to over-ride RESVs on nicks/channels. */
 	oper_pass_resv = yes;
 
 	/* REMOVE ME.  The following line checks you've been reading. */
@@ -1124,7 +1123,7 @@ general {
 
 	/*
 	 * max_targets: the maximum amount of targets in a single 
-	 * PRIVMSG/NOTICE.  Set to 999 NOT 0 for unlimited.
+	 * PRIVMSG/NOTICE. Set to 999 NOT 0 for unlimited.
 	 */
 	max_targets = 4;
 
@@ -1165,8 +1164,8 @@ general {
 
 	/*
 	 * use_egd: if your system does not have *random devices yet you
-	 * want to use OpenSSL and encrypted links, enable this.  Beware -
-	 * EGD is *very* CPU intensive when gathering data for its pool
+	 * want to use OpenSSL and encrypted links, enable this. Beware -
+	 * EGD is *very* CPU intensive when gathering data for its pool.
 	 */
 #	use_egd = yes;
 
@@ -1178,8 +1177,8 @@ general {
 
 	/*
 	 * throttle_time: the minimum amount of time between connections from
-	 * the same ip.  exempt {} blocks are excluded from this throttling.
-	 * Offers protection against flooders who reconnect quickly.  
+	 * the same ip. exempt {} blocks are excluded from this throttling.
+	 * Offers protection against flooders who reconnect quickly.
 	 * Set to 0 to disable.
 	 */
 	throttle_time = 10;
@@ -1193,7 +1192,7 @@ modules {
 	path = "/usr/local/ircd/lib/ircd-hybrid/modules";
 	path = "/usr/local/ircd/lib/ircd-hybrid/modules/autoload";
 
-	/* module: the name of a module to load on startup/rehash */
+	/* module: the name of a module to load on startup/rehash. */
 	#module = "some_module.la";
 };