- reference.conf: mostly cosmetical corrections
authormichael <michael@82007160-df01-0410-b94d-b575c5fd34c7>
Sat, 20 Jun 2015 16:18:28 +0000 (16:18 +0000)
committermichael <michael@82007160-df01-0410-b94d-b575c5fd34c7>
Sat, 20 Jun 2015 16:18:28 +0000 (16:18 +0000)
git-svn-id: svn://svn.ircd-hybrid.org/svnroot/hopm/trunk@6170 82007160-df01-0410-b94d-b575c5fd34c7

doc/reference.conf

index a2b2967542a152370afd4cff37415b7a806529da..d52ec1f41a80cd4c078b99f340e339a1e3fab992 100644 (file)
@@ -70,12 +70,12 @@ options {
 
 irc {
        /*
-        * IP to bind to for the IRC connection. You only need to use this if
-        * you wish HOPM to use a particular interface (virtual host, IP
-        * alias, ...) when connecting to the IRC server. There is another
-        * "vhost" setting in the scan {} block below for the actual
-        * portscans. Note that this directive expects an IP address, not a
-        * hostname. Please leave this commented out if you do not
+        * IP address to bind to for the IRC connection. You only need to
+        * use this if you wish HOPM to use a particular interface
+        * (virtual host, IP alias, ...) when connecting to the IRC server.
+        * There is another "vhost" setting in the scan {} block below for
+        * the actual portscans. Note that this directive expects an IP address,
+        * not a hostname. Please leave this commented out if you do not
         * understand what it does, as most people don't need it.
         */
 #      vhost = "0.0.0.0";
@@ -96,7 +96,7 @@ irc {
        username = "hopm";
 
        /*
-        * Hostname (or IP) of the IRC server which HOPM will monitor
+        * Hostname (or IP address) of the IRC server which HOPM will monitor
         * connections on. IPv6 is now supported.
         */
        server = "irc.example.org";
@@ -185,7 +185,7 @@ irc {
        /*
         * You can define a bunch of channels if you want:
         *
-        * channel { name = "#other"; }; channel { name="#channel"; }
+        * channel { name = "#other"; }; channel { name= "#channel"; }
         */
 
        /*
@@ -195,7 +195,7 @@ irc {
         *
         * Items in order MUST be: nick user host IP
         *
-        * HOPM will not work with ircds which do not send an IP in the
+        * HOPM will not work with ircds which do not send an IP address in the
         * connection notice.
         *
         * This is fairly complicated stuff, and the consequences of getting
@@ -300,7 +300,7 @@ irc {
                 * These options affect how the values specified to reply
                 * below will be interpreted, a bitmask is where the reply
                 * values are 2^n and more than one is added up, a reply is
-                * simply where the last octet of the IP is that number.
+                * simply where the last octet of the IP address is that number.
                 * If you are not sure then the values set for dnsbl.dronebl.org
                 * will work without any changes.
                 */
@@ -431,7 +431,7 @@ irc {
  * Scanner defines a virtual scanner. For each user being scanned, a scanner
  * will use a file descriptor (and subsequent connection) for each protocol.
  * Once connecting it will negotiate the proxy to connect to
- * target_ip:target_port (target_ip MUST be an IP).
+ * target_ip:target_port (target_ip MUST be an IP address).
  *
  * Once connected, any data passed through the proxy will be checked to see if
  * target_string is contained within that data. If it is the proxy is
@@ -504,7 +504,7 @@ scanner {
        protocol = HTTPPOST:80;
 
        /*
-        * IP this scanner will bind to. Use this if you need your scans to
+        * IP address this scanner will bind to. Use this if you need your scans to
         * come FROM a particular interface on the machine you run HOPM from.
         * If you don't understand what this means, please leave this
         * commented out, as this is a major source of support queries!
@@ -526,7 +526,7 @@ scanner {
         * that send endless data to tie up your scanner. 4KB is plenty for
         * any known proxy.
         */
-       max_read = 4kb;
+       max_read = 4 kbytes;
 
        /*
         * Amount of time before a test is considered timed out.
@@ -541,14 +541,14 @@ scanner {
         * !!! THIS MUST BE CHANGED !!!
         *
         * You cannot instruct the proxy to connect to itself! The easiest
-        * thing to do would be to set this to the IP of your ircd and then
-        * keep the default target_strings.
+        * thing to do would be to set this to the IP address of your ircd
+        * and then keep the default target_strings.
         *
-        * Please use an IP that is publically reachable from anywhere on the
-        * Internet, because you have no way of knowing where the insecure
+        * Please use an IP address that is publically reachable from anywhere
+        * on the Internet, because you have no way of knowing where the insecure
         * proxies will be located. Just because you and your HOPM can
-        * connect to your ircd on some private IP like 192.168.0.1, does not
-        * mean that the insecure proxies out there on the Internet will be
+        * connect to your ircd on some private IP address like 192.168.0.1,
+        * does not mean that the insecure proxies out there on the Internet will be
         * able to. And if they never connect, you will never detect them.
         *
         * Remember to change this setting for every scanner you configure.