- doc/reference.conf: revised reference.conf by Dominic Hargreaves <dom@earth.li>

- version.c, AUTHORS: added Dom to contributors list since he helped al lot with
  GNU/Hurd testing and bugfixing


git-svn-id: svn://svn.ircd-hybrid.org/svnroot/ircd-hybrid/branches/8.1.x@2321 82007160-df01-0410-b94d-b575c5fd34c7

1 files changed, 103 insertions, 94 deletions

diff --git a/doc/reference.conf b/doc/reference.conf
index 4e283ba..80bde27 100644
--- a/doc/reference.conf
+++ b/doc/reference.conf
@@ -8,7 +8,7 @@
 
 /*
  * ########################################################################
- * IMPORTANT NOTES:
+ * IMPORTANT NOTE:
  *
  * auth {} blocks MUST be specified in order of precedence.  The first one
  * that matches a user will be used.  So place spoofs first, then specials,
@@ -76,8 +76,8 @@ serverinfo {
 #	vhost = "192.169.0.1";
 
 	/*
-	 * vhost6: the IP to bind to when we connect outward to ipv6 servers.
-	 * This should be an ipv6 IP only, or "*" for INADDR_ANY.
+	 * vhost6: the address to bind to when we make outgoing connections
+	 * to IPv6 servers. This should be an IPv6 address, or "*" for INADDR_ANY.
 	 */
 #	vhost6 = "3ffe:80e8:546::2";
 
@@ -98,10 +98,10 @@ serverinfo {
 	max_topic_length = 160;
 
 	/*
-	 * rsa_private_key_file: the path to the file containing our
-	 * rsa key for cryptlink.
+	 * rsa_private_key_file: the path to the file containing the
+	 * RSA key for cryptlink.
 	 *
-	 * Example command to store a 2048 bit RSA keypair in
+	 * Example commands to store a 2048 bit RSA keypair in
 	 * rsa.key, and the public key in rsa.pub:
 	 *
 	 *	openssl genrsa -out rsa.key 2048
@@ -114,7 +114,7 @@ serverinfo {
 
 	/*
 	 * ssl_certificate_file: the path to the file containing our
-	 * ssl certificate for encrypted client connection.
+	 * 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.
@@ -138,8 +138,8 @@ serverinfo {
 	 * ssl_dh_param_file:
 	 *
 	 * Path to the PEM encoded Diffie-Hellman parameter file.
-	 * DH parameters are strictly required when using ciphers
-	 * with EDH (ephemeral Diffie-Hellman) key exchange.
+	 * DH parameters are required when using ciphers with EDH
+	 * (ephemeral Diffie-Hellman) key exchange.
 	 *
 	 * A DH parameter file can be created by running:
 	 *
@@ -154,13 +154,13 @@ serverinfo {
 	/*
 	 * ssl_cipher_list:
 	 *
-	 * List of ciphers that are supported by _this_ server. Can be used to
+	 * List of ciphers to support on _this_ server. Can be used to
 	 * enforce specific ciphers for incoming SSL/TLS connections.
-	 * If a client (which also includes incoming server connections) isn't
-	 * capable of any cipher listed below, the connection will simply be
-	 * rejected.
+	 * If a client (which also includes incoming server connections) is not
+	 * capable of using any of the ciphers listed here, the connection will
+	 * simply be rejected.
 	 *
-	 * A list of supported ciphers can be obtained by running:
+	 * A list of supported ciphers by OpenSSL can be obtained by running:
 	 *
 	 *	openssl ciphers -ssl3 -tls1 -v
 	 *
@@ -205,13 +205,13 @@ class {
 
 	/*
 	 * number_per_ip: how many local users are allowed to connect
-	 * from one IP  (optional)
+	 * from a single IP address  (optional)
 	 */
 	number_per_ip = 2;
 
 	/*
 	 * max_local: how many local users are allowed to connect
-	 * from one ident@host  (optional)
+	 * from a single ident@host  (optional)
 	 */
 	max_local = 2;
 
@@ -234,13 +234,13 @@ class {
 	number_per_cidr = 16;
 
 	/*
-	 * sendq: the amount of data allowed in a clients send queue before
+	 * sendq: the amount of data allowed in a client's send queue before
 	 * they are dropped.
 	 */
 	sendq = 100 kbytes;
 
 	/*
-	 * recvq: maximum amount of data in a clients receive queue before
+	 * recvq: the amount of data allowed in a client's receive queue before
 	 * they are dropped for flooding. Defaults to 2560 if the chosen
 	 * value isn't within the range of 512 to 8000.
 	 */
@@ -267,9 +267,9 @@ class {
 	/*
 	 * flags:
 	 *
-	 * random_idle          - idle time is randomly selected within the
-	 *                        range of min_idle to max_idle
-	 * hide_idle_from_opers - fake idle time will be shown to operators, too
+	 * random_idle          - a fake idle time is set randomly between
+	 *                        min_idle and max_idle
+	 * hide_idle_from_opers - the fake idle time will also be shown to operators
 	 */
 	flags = random_idle, hide_idle_from_opers;
 };
@@ -284,7 +284,7 @@ class {
 	 */
 	connectfreq = 5 minutes;
 
-	/* max number: the amount of servers to autoconnect to. */
+	/* max number: the number of servers to autoconnect to. */
 	max_number = 1;
 
 	/* sendq: servers need a higher sendq as they send more data. */
@@ -292,7 +292,7 @@ class {
 };
 
 /*
- * motd {}: Allows to show a different MOTD to a client
+ * motd {}: Allows the display of a different MOTD to a client
  * depending on its origin. Applies to local users only.
  */
 motd {
@@ -315,20 +315,20 @@ motd {
  */
 listen {
 	/*
-	 * port: the specific port to listen on. If no host is specified
-	 * before, it will listen on all available IPs.
+	 * port: the port to listen on. If no host is specified
+	 * earlier in the listen {} block, it will listen on all available IPs.
 	 *
-	 * Ports are separated via a comma, a range may be specified using ".."
+	 * Ports are separated by commsa; a range may be specified using ".."
 	 */
 	
-	/* port: listen on all available IPs, ports 6665 to 6669 */
+	/* port: listen on all available IP addresses, ports 6665 to 6669 */
 	port = 6665 .. 6669;
 
 	/*
-	 * Listen on 192.168.0.1/6697 with ssl enabled and hidden from STATS P
+	 * 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 always has to come before "port".
 	 *
 	 * Currently available flags are:
 	 *
@@ -341,8 +341,8 @@ listen {
 	port = 6697;
 
 	/*
-	 * host: set a specific IP/host the ports after the line will listen
-	 * on. This may be ipv4 or ipv6.
+	 * host: set a specific IP address/host to listen on using the
+	 * subsequent port definitions. This may be IPv4 or IPv6.
 	 */
 	host = "1.2.3.4";
 	port = 7000, 7001;
@@ -357,7 +357,7 @@ listen {
 auth {
 	/*
 	 * user: the user@host allowed to connect. Multiple user
-	 * lines are permitted per auth block.
+	 * lines are permitted within each auth block.
 	 */
 	user = "*@172.16.0.0/12";
 	user = "*test@123D:B567:*";
@@ -372,7 +372,7 @@ auth {
 	encrypted = yes;
 
 	/*
-	 * spoof: fake the users host to this. This is free-form, just do
+	 * spoof: fake the user's 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";
@@ -402,7 +402,7 @@ 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
+	 * have to obey the redirection; the ircd just suggests an alternative
 	 * server for them.
 	 */
 	redirserv = "this.is.not.a.real.server";
@@ -439,7 +439,7 @@ operator {
 	 * 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
-	 * glibc already has support for SHA-256/512, and MD5 encryption
+	 * glibc already has support for the SHA-256/512 and MD5 encryption
 	 * algorithms.
 	 */
 	password = "$5$x5zof8qe.Yc7/bPp$5zIg1Le2Lsgd4CvOjaD20pr5PmcfD7ha/9b2.TaUyG4";
@@ -452,7 +452,7 @@ operator {
 
 	/*
 	 * rsa_public_key_file: the public key for this oper when using Challenge.
-	 * A password should not be defined when this is used, see 
+	 * A password should not be defined when this is used; see 
 	 * doc/challenge.txt for more information.
 	 */
 #	rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
@@ -480,7 +480,7 @@ operator {
 	class = "opers";
 
 	/*
-	 * umodes: default usermodes opers get when they /oper. If defined,
+	 * umodes: the default usermodes opers get when they /oper. If defined,
 	 * it will override oper_umodes settings in general {}.
 	 * Available usermodes:
 	 *
@@ -542,9 +542,9 @@ operator {
 };
 
 /*
- * service {}: specifies what server may act as a network service
+ * service {}: specifies a server which may act as a network service
  *
- * NOTE: it is absolutely important that every single server on the network
+ * NOTE: it is very important that every server on the network
  *       has the same service{} block.
  */
 service {
@@ -553,28 +553,29 @@ service {
 };
 
 /*
- * connect {}:  controls servers we connect to
+ * connect {}: define a server to connect to
  */
 connect {
 	/* name: the name of the server */
 	name = "irc.uplink.com";
 
 	/*
-	 * host: the host or IP to connect to. If a hostname is used it
-	 * must match the reverse dns of the server.
+	 * host: the host or IP address to connect to. If a hostname is used it
+	 * must match the reverse DNS of the server.
 	 */
 	host = "192.168.0.1";
 
 	/*
-	 * vhost: the IP to bind to when we connect outward to servers.
+	 * vhost: the IP address to bind to when making outgoing connections to
+	 * servers.
 	 * serverinfo::vhost and serverinfo::vhost6 will be overridden
 	 * by this directive.
 	 */
 	vhost = "192.168.0.2";
 
 	/*
-	 * passwords: the passwords we send (OLD C:) and accept (OLD N:).
-	 * The remote server will have these passwords reversed.
+	 * passwords: the passwords to send (OLD C:) and accept (OLD N:).
+	 * The remote server will have these passwords swapped.
 	 */
 	send_password = "password";
 	accept_password = "anotherpassword";
@@ -607,8 +608,8 @@ connect {
 	 * ssl_cipher_list:
 	 *
 	 * List of ciphers that the server we are connecting to must support.
-	 * If the server isn't capable of any cipher listed below, the
-	 * connection will simply be rejected.
+	 * If the server is not capable of using any of the ciphers listed below,
+	 * the connection will simply be rejected.
 	 * Can be used to enforce stronger ciphers, even though this option
 	 * is not necessarily required to establish a SSL/TLS connection.
 	 *
@@ -653,9 +654,9 @@ connect {
  */
 cluster {
 	/*
-	 * name: the server to share with, this can take wildcards
+	 * name: the server to share with; this can take wildcards
 	 *
-	 * NOTE: only local actions will be clustered, meaning if
+	 * NOTE: only local actions will be clustered, meaning that if
 	 *       the server receives a shared kline/unkline/etc, it
 	 *       will not be propagated to clustered servers.
 	 *
@@ -666,7 +667,7 @@ cluster {
 	name = "*.arpa";
 
 	/*
-	 * type: list of what to share, options are as follows:
+	 * type: list of what to share; options are as follows:
 	 *      dline   - share dlines
 	 *      undline - share undlines
 	 *      kline   - share klines
@@ -684,15 +685,16 @@ cluster {
 /*
  * shared {}: users that are allowed to remote kline
  *
- * NOTE: This can be effectively used for remote klines.
+ * NOTE: This can effectively be used for remote klines.
  *       Please note that there is no password authentication
  *       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
-	 * specified, the user will be allowed to kline from all servers.
+	 * name: the server the user must be connected to in order to set klines.
+	 * If this is not specified, the user will be allowed to kline from all
+	 * servers.
 	 */
 	name = "irc2.some.server";
 
@@ -729,7 +731,8 @@ kill {
 };
 
 /*
- * deny {}:  IPs that are not allowed to connect (before DNS/ident lookup)
+ * deny {}:  IP addresses that are not allowed to connect
+ * (before DNS/ident lookup)
  * Oper issued dlines will be added to the specified dline config
  */
 deny {
@@ -738,7 +741,7 @@ deny {
 };
 
 /*
- * exempt {}:  IPs that are exempt from deny {} and Dlines
+ * exempt {}:  IP addresses that are exempt from deny {} and Dlines
  */
 exempt {
 	ip = "192.168.0.0/16";
@@ -761,7 +764,7 @@ resv { mask = "#*services*"; reason = "Reserved for services"; };
 resv {
 	/*
 	 * mask: masks starting with a '#' are automatically considered
-	 * as channel name mask.
+	 * as channel name masks.
 	 */
 	mask = "#helsinki";
 	reason = "Channel is reserved for finnish inhabitants";
@@ -793,7 +796,7 @@ gecos {
 channel {
 	/*
 	 * disable_fake_channels: this option, if set to 'yes', will
-	 * disallow clients to create or join channels that have one
+	 * disallow clients from creating or joining channels that have one
 	 * of the following ASCII characters in their name:
 	 *
 	 *   2 | bold
@@ -834,14 +837,16 @@ channel {
 	max_bans = 100;
 
 	/*
-	 * how many joins in how many seconds constitute a flood, use 0 to
+	 * how many joins in how many seconds constitute a flood. Use 0 to
 	 * disable. +b opers will be notified (changeable via /set)
 	 */
 	join_flood_count = 16;
 	join_flood_time = 8 seconds;
 
 	/*
-	 * splitcode: The ircd will now check splitmode every few seconds.
+	 * The ircd will now check splitmode (whether a server is split from
+	 * the network) every few seconds; this functionality is known as
+	 * splitcode and is influenced by the options below.
 	 *
 	 * Either split users or split servers can activate splitmode, but
 	 * both conditions must be met for the ircd to deactivate splitmode.
@@ -861,27 +866,27 @@ channel {
 	 */
 	default_split_server_count = 0;
 
-	/* no_create_on_split: disallow users creating channels on split. */
+	/* no_create_on_split: do not allow users to create channels on split. */
 	no_create_on_split = yes;
 
-	/* no_join_on_split: disallow users joining channels at all on a split. */
+	/* no_join_on_split: do not allow users to join channels on a split. */
 	no_join_on_split = no;
 };
 
 /*
  * serverhide {}:  The serverhide block contains the options regarding
- * serverhiding
+ * to server hiding
  */
 serverhide {
 	/*
-	 * disable_remote_commands: disable users doing commands
+	 * disable_remote_commands: disable users issuing commands
 	 * on remote servers.
 	 */
 	disable_remote_commands = no;
 
 	/*
 	 * flatten_links: this option will show all servers in /links appear
-	 * that they are linked to this current server.
+	 * as though they are linked to this current server.
 	 */
 	flatten_links = no;
 
@@ -916,12 +921,12 @@ serverhide {
 
 	/*
 	 * hide_server_ips: If this is disabled, opers will be unable to see
-	 * servers ips and will be shown a masked ip, admins will be shown the
-	 * real ip.
+	 * servers' IP addresses and will be shown a masked IP address; admins
+	 * will be shown the real IP address.
 	 *
-	 * If this is enabled, nobody can see a servers ip. *This is a kludge*,
-	 * it has the side effect of hiding the ips everywhere, including
-	 * logfiles.
+	 * If this is enabled, nobody can see a server's IP address.
+	 * *This is a kludge*: it has the side effect of hiding the IP addresses
+	 * everywhere, including logfiles.
 	 *
 	 * We recommend you leave this disabled, and just take care with who you
 	 * give administrator privileges to.
@@ -946,7 +951,7 @@ 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 temporary klines). */
 	gline_enable = yes;
 
 	/*
@@ -979,16 +984,17 @@ general {
 	invisible_on_connect = yes;
 
 	/*
-	 * 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: KILL chasing is a feature whereby a KILL
+	 * issued for a user who has recently changed nickname will be applied
+	 * automatically to the new nick. kill_chase_time_limit is the maximum
+	 * time following a nickname change that this chasing will apply.
 	 */
 	kill_chase_time_limit = 90 seconds;
 
 	/*
 	 * 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.
+	 * IP address of spoofed users in /trace etc. If this is defined they
+	 * will be shown a masked IP.
 	 */
 	hide_spoof_ips = yes;
 
@@ -1014,7 +1020,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 number of lines a user
 	 * may send to any other user/channel in one second.
 	 */
 	default_floodcount = 10;
@@ -1026,21 +1032,22 @@ general {
 	failed_oper_notice = yes;
 
 	/*
-	 * dots_in_ident: the amount of '.' characters permitted in an ident
+	 * dots_in_ident: the number of '.' characters permitted in an ident
 	 * reply before the user is rejected.
 	 */
 	dots_in_ident = 2;
 
 	/*
-	 * min_nonwildcard: the minimum non wildcard characters in k/d/g lines
-	 * placed via the server. K-lines hand placed are exempt from limits.
+	 * min_nonwildcard: the minimum number of non-wildcard characters in
+	 * k/d/g lines placed via the server. K-lines hand-placed are exempt from
+	 * this limit.
 	 * Wildcard chars: '.', ':', '*', '?', '@', '!'
 	 */
 	min_nonwildcard = 4;
 
 	/*
-	 * min_nonwildcard_simple: the minimum non wildcard characters in 
-	 * gecos bans. Wildcard chars: '*', '?'
+	 * min_nonwildcard_simple: the minimum number of non-wildcard characters
+	 * in gecos bans. Wildcard chars: '*', '?'
 	 */
 	min_nonwildcard_simple = 3;
 
@@ -1050,7 +1057,7 @@ general {
 	/* anti_nick_flood: enable the nickflood control code. */
 	anti_nick_flood = yes;
 
-	/* nick flood: the nick changes allowed in the specified period */
+	/* nick flood: the number of nick changes allowed in the specified period */
 	max_nick_time = 20 seconds;
 	max_nick_changes = 5;
 
@@ -1070,8 +1077,8 @@ general {
 
 	/*
 	 * warn_no_nline: warn opers about servers that try to connect but
-	 * we don't have a connect {} block for. Twits with misconfigured
-	 * servers can get really annoying with this enabled.
+	 * for which we don't have a connect {} block. Twits with misconfigured
+	 * servers can become really annoying with this enabled.
 	 */
 	warn_no_nline = yes;
 
@@ -1095,7 +1102,7 @@ general {
 	/*
 	 * 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
+	 *     masked - show users the first matching auth block
 	 *     no     - show users all auth blocks.
 	 */
 	stats_i_oper_only = yes;
@@ -1103,7 +1110,7 @@ general {
 	/*
 	 * 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
+	 *     masked - show users the first matching auth block
 	 *     no     - show users all auth blocks.
 	 */
 	stats_k_oper_only = yes;
@@ -1121,20 +1128,21 @@ general {
 	opers_bypass_callerid = no;
 
 	/*
-	 * pace_wait_simple: time between use of less intensive commands
+	 * pace_wait_simple: minimum time required between use of less
+	 * intensive commands
 	 * (ADMIN, HELP, (L)USERS, VERSION, remote WHOIS)
 	 */
 	pace_wait_simple = 1 second;
 
 	/*
-	 * pace_wait: time between more intensive commands
+	 * pace_wait: minimum time required between use of more intensive commands
 	 * (AWAY, INFO, LINKS, MAP, MOTD, STATS, WHO, wildcard WHOIS, WHOWAS)
 	 */
 	pace_wait = 10 seconds;
 
 	/*
-	 * short_motd: send clients a notice telling them to read the motd
-	 * instead of forcing a motd to clients who may simply ignore it.
+	 * short_motd: send clients a notice telling them to read the MOTD
+	 * instead of forcing an MOTD to clients who may simply ignore it.
 	 */
 	short_motd = no;
 
@@ -1156,11 +1164,11 @@ general {
 	/* 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. */
+	/* REMOVE ME.  The following line checks that you have been reading. */
 	havent_read_conf = 1;
 
 	/*
-	 * max_targets: the maximum amount of targets in a single
+	 * max_targets: the maximum number of targets in a single
 	 * PRIVMSG/NOTICE. Set to 999 NOT 0 for unlimited.
 	 */
 	max_targets = 4;
@@ -1214,8 +1222,9 @@ general {
 #	egdpool_path = "/var/run/egd-pool";
 
 	/*
-	 * throttle_time: the minimum amount of time between connections from
-	 * the same ip. exempt {} blocks are excluded from this throttling.
+	 * throttle_time: the minimum amount of time required between
+	 * connections from the same IP address. exempt {} blocks are excluded
+	 * from this throttling.
 	 * Offers protection against flooders who reconnect quickly.
 	 * Set to 0 to disable.
 	 */