- Update documents

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

diff --git a/INSTALL b/INSTALL
index 086e21befce2eb9d59b845a23305211b57e938c3..7562b7702ca63c3181833511c2e7dbd7e58a8e61 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -47,14 +47,14 @@ Configuration
     the first part of a connection.  If you're not sure, the best thing to do
     is telnet to your ircd from your shell, e.g.:
 
-      [andy@fullers hopm]$ telnet porkscratchings.someserver.org 6667
-      Trying 207.8.219.202...
-      Connected to porkscratchings.someserver.org.
+      [miwob@svn ~]$ telnet irc.ircd-hybrid.org 6667
+      Trying 74.208.44.181...
+      Connected to irc.ircd-hybrid.org (74.208.44.181).
       Escape character is '^]'.
-      :porkscratchings.pa.us.someserver.org NOTICE AUTH :*** Looking up your hostname
-      :porkscratchings.pa.us.someserver.org NOTICE AUTH :*** Checking Ident
-      :porkscratchings.pa.us.someserver.org NOTICE AUTH :*** Got Ident response
-      :porkscratchings.pa.us.someserver.org NOTICE AUTH :*** Found your hostname
+      :irc.ircd-hybrid.org NOTICE * :*** Looking up your hostname
+      :irc.ircd-hybrid.org NOTICE * :*** Checking Ident
+      :irc.ircd-hybrid.org NOTICE * :*** No Ident response
+      :irc.ircd-hybrid.org NOTICE * :*** Found your hostname
 
     Just try to pick something in the first line of IRC output (for efficiency
     reasons).

diff --git a/README b/README
index 71024b9ca98f51d0b2efb77d8ce1f347b94c9397..d0f3775b67d41458742cd99c299fb6c695802d35 100644 (file)
--- a/README
+++ b/README
@@ -4,9 +4,9 @@ Introduction
 HOPM (Hybrid Open Proxy Monitor) is an open proxy monitoring bot designed for
 Hybrid based ircds.  The bot is designed to monitor an individual server (all
 servers on the network have to run their own bot) with a local operator {}
-block and monitor connections.  When a client connects to the server, HOPM will 
-scan the connection for insecure proxies.  Insecure proxies are determined by 
-attempting to connect the proxy back to another host (usually the IRC server in 
+block and monitor connections.  When a client connects to the server, HOPM will
+scan the connection for insecure proxies.  Insecure proxies are determined by
+attempting to connect the proxy back to another host (usually the IRC server in
 question).
 
 HOPM is written ground-up in C language, concept derived from wgmon.  It
@@ -65,10 +65,10 @@ botnick stats                   -- Output scan stats, uptime and client connecti
 botnick fdstat                  -- Output some into about file descriptors in use.
 
 Also if several HOPMs are present in one channel they will all respond to !all,
-for example !all stats (fixed in BOPM 3.1.0).
+for example !all stats.
 
 
-Rehashing HOPM 
+Rehashing HOPM
 --------------
 
 A /kill to hopm will cause the process to restart, rehashing the configuration file
@@ -98,8 +98,3 @@ Support
     - bugs@ircd-hybrid.org
   * IRC contact:
     - #ircd-coders on irc.ircd-hybrid.org
-
-Credits
--------
-
-Please see the CREDITS file.

diff --git a/doc/reference.conf b/doc/reference.conf
index 9685824887715c43276c5ea774d90cf3f19e95b9..f348dfb1dee431532355f39914f64f07eba6d520 100644 (file)
--- a/doc/reference.conf
+++ b/doc/reference.conf
@@ -1,8 +1,21 @@
 /*
+ * Hybrid Open Proxy Monitor - HOPM sample configuration
+ */
 
-HOPM sample configuration
-
-*/
+/*
+ * Shell style (#), C++ style (//) and C style comments are supported.
+ *
+ * Times/durations are written as:
+ *        12 hours 30 minutes 1 second
+ *
+ * Valid units of time:
+ *        year, month, week, day, hour, minute, second
+ *
+ * Valid units of size:
+ *        megabyte/mbyte/mb, kilobyte/kbyte/kb, byte
+ *
+ * Sizes and times may be singular or plural.
+ */
 
 options {
        /*
@@ -45,7 +58,7 @@ options {
 };
 
 
-IRC {
+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
@@ -105,7 +118,7 @@ IRC {
         * The username and password needed for HOPM to oper up.
         */
        oper = "hopm operpass";
- 
+
        /*
         * Mode string that HOPM needs to set on itself as soon as it opers
         * up.  This needs to include the mode for seeing connection notices,
@@ -124,7 +137,7 @@ IRC {
         * commands.  HOPM will also print messages in these channels every
         * time it detects a proxy.  Only IRC operators can command HOPM to do
         * anything, but some of the things HOPM reports to these channels
-        * could be soncidered sensitive, so it's best not to put HOPM into
+        * could be considered sensitive, so it's best not to put HOPM into
         * public channels.
         */
        channel {
@@ -220,8 +233,7 @@ IRC {
  * proxies or other forms of IRC abuse. By checking against these blacklists,
  * HOPMs are able to ban known sources of abuse without completely scanning them.
  */
-
-OPM {
+opm {
        /*
         * Blacklist zones to check IPs against.  If you would rather not
         * trust a remotely managed blacklist, you could set up your own, or
@@ -385,7 +397,6 @@ OPM {
  * target_string is matched, or if at least max_read bytes are read from the
  * connection, the negotiation is considered failed.
  */
-
 scanner {
 
        /*
@@ -393,7 +404,7 @@ scanner {
         * user {} blocks to decide which users get affected by which
         * scanners.
         */
-       name="default";
+       name = "default";
 
        /*
         * HTTP CONNECT - very common proxy protocol supported by widely known
@@ -475,9 +486,9 @@ scanner {
         */
        timeout = 30 seconds;
 
-       /* 
+       /*
         * Target IP to tell the proxy to connect to
-        * 
+        *
         * !!! THIS MUST BE CHANGED !!!
         *
         * You cannot instruct the proxy to connect to itself! The easiest
@@ -501,7 +512,7 @@ scanner {
         */
        target_port = 6667;
 
-       /* 
+       /*
         * Target string we check for in the data read back by the scanner.
         * This should be some string out of the data that your ircd usually
         * sends on connect.  The example below will work on most
@@ -513,7 +524,7 @@ scanner {
         */
 
        /*
-        * Usually first line sent to client on connection to ircd. 
+        * Usually first line sent to client on connection to ircd.
         * If your ircd supports a more specific line (see below),
         * using it will reduce false positives.
         */