INSTALL:

	Documentation for new build process.

diff --git a/INSTALL b/INSTALL
index 572077757924b9bb96ffae3d584a6a3fa392a817..b74725f62f39809c1f339121abb583a4a03af635 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -5,13 +5,27 @@ Make
 
     1. ./configure
     2. make
-    3. copy bopm.conf.sample to bopm.conf and edit to suit
-    4. ./bopm
+    3. make install
+    4. cd $HOME/bopm
+    5. edit etc/bopm.conf to suit
+    6. bin/bopm
 
     In detail:
 
     ./configure has a few options which you might need:
 
+    --prefix            Sets the root of bopm's install.  By default this
+                        is $HOME/bopm, with binaries going in
+                       $HOME/bopm/bin, config in $HOME/bopm/etc and logs
+                       in $HOME/bopm/var.
+
+    --bindir            Specify the place to install binaries.  By default
+                        this is $PREFIX/bin. (see --prefix, above)
+
+    --localstatedir     Specify the place where logs and PID files will be
+                        kept.  By default this is $PREFIX/var. (see
+                       --prefix, above)
+
     --with-unreal       You need this if you are using Unreal ircd (any
                         version).  At this stage Unreal also requires
                         patching, you can get that patch from our web site.
@@ -19,6 +33,9 @@ Make
     --with-select       Use select() instead of poll() even if your system
                         has poll()
 
+    configure has many other options, see ./configure --help for more
+    details.
+
     There are some further options in options.h which may be moved to
     configure at some point.  If you think you need to change these then we
     assume you've read the code and know why.
@@ -28,8 +45,8 @@ Make
 Configuration
 -------------
 
-    Rename bopm.conf.sample to bopm.conf, edit as needed.  Most options are
-    self explanatory and contain a short description.
+    Edit bopm.conf as needed.  Most options are self explanatory and
+    contain a short description.
 
     Please take note of the TARGET_STRING, this is new in version 2 and may be
     different for your ircd.  Because we now check that we really have
@@ -64,13 +81,18 @@ Configuration
     banner at all (ircnet??).  Worst case is you'll need to make something
     listen on one of your ports that gives some predictable string.
 
+    Remember that your users might run their own ircd on some typical proxy
+    port like 8080!  If you can, put a banner in that contains your own
+    server name, so that it is unlikely to be duplicated.
+
 
 Execution
 ---------
 
-    Run bopm from the same directory as bopm.conf.  The bot will fork and
-    connect to the IRC server immediately.  Any errors and debug information
-    can be found in bopm.log.
+    You can run bopm from any directory, the path to its config file is
+    compiled into it.  The bot will fork and connect to the IRC server
+    immediately.  Any errors and debug information can be found in
+    $PREFIX/var/bopm.log.
 
     You can tell bopm to use a different config file with the -c argument,
     this works the same way that wgmon's -c argument does, just give the name
@@ -78,7 +100,8 @@ Execution
     and PID files i.e. ./bopm -c myserver will read from myserver.conf, log to
     myserver.log and write PID to myserver.pid.  If you do not use -c, the
     files bopm.conf, bopm.log and bopm.pid will be used by default.  This can
-    be altered in options.h.
+    be altered in options.h.  This is useful for running multiple bopm on
+    the same host.
 
     Further debugging can be enabled by using one or more -d switches.  One or
     more -d switches will cause the bot to not fork on startup, and it will