   	      srvx Installation Instructions

srvx is known to compile on the following systems as long as you
are using GNU make (make on Linux, gmake on many other systems):

  * Linux (libc5 or glibc2); glibc2.1 recommended+    ( SPARC, ALPHA, x86, PPC )
  * FreeBSD 4.x; tested on 4.2-RELEASE and 4.2-STABLE ( SPARC, x86 )
  * FreeBSD 3.x; tested on 3.3-RELEASE and 3.4-STABLE ( SPARC, x86 )
  * FreeBSD 2.x; tested on 2.2.8-RELEASE	      ( SPARC, x86 )
  * NetBSD 1.x; tested on 1.4.1 and 1.4.2	      ( ALPHA, MIPS, x86 )
  * SunOS 5.x; tested on 5.8			      ( SPARC, x86 )
  * OpenBSD 2.x; tested on 2.8			      ( x86 )
  * BSDi 4.x; tested on 4.0.1			      ( x86 )
  * CYGWIN 1.1.x and 1.3.x; tested on 1.1.8	      ( x86 )

For the Linux kernel, srvx has been tested on Debian 2.x, Redhat 5.x,
Redhat 6.x and Redhat 7.x.

srvx should compile on other system types also.  If you have success
on other platforms/archs or problems on any platforms/archs, please
contact the authors to let us know.

gcc 2.96 tends to emit spurious warnings; before reporting any
compiler warnings from it, make sure you are using the most recent
version of it or try using an official release of gcc or egcs.

You may also have trouble unless your compiler's C preprocessor
supports ISO C99 varadic macros.  gcc is the compiler we use for
almost all our testing, and we recommend it for use with srvx.

Introduction:
~~~~~~~~~~~~
If you encounter any problems compiling/running srvx, please
report it to one (or all) of the coders listed in the AUTHORS
file.  Please try to include ALL relevant information about the error/bug,
including anything out of the ordinary reported from make.

Quick Install:
~~~~~~~~~~~~~
$ ./configure
   NOTE: If you are trying to link to a version of IRCU derived from
   Undernet's ircu (irc u2.10.10 or above), you should give the
   --with-undernet flag to configure, like this:
   $ ./configure --with-undernet
$ make
# make install

Compiling:
~~~~~~~~~
  1) Enter the root directory of the srvx tree.  If installation is done
     from outside of it, it may cause problems during compile, or during
     runtime.

  2) Run the configure script (sh configure), it will verify that your
     system will have the resources needed for srvx to compile.  If you
     would like to change the path where srvx will be installed to,
     execute configure with the --prefix=/path option.  The default path
     is ~/srvx-X.X.X/, with the X's representing the version.  See the
     note in "Quick Install" if you are linking to ircu2.10.10.

  3) On some systems you may need to edit the Makefile in order for
     it to compile correctly.  Includes, and other such things may
     reside in other directories.  Most likely the Makefile won't require
     any modifications.

  4) You may optionally edit config.h in case the configure script made a
     mistake.

  5) Execute the "make" command to begin compiling.  If you encounter any
     uncorrectable errors/warnings, please scroll up to the introduction
     section and follow the instructions.

  6) You may now either type "make install" to install it to your
     installation path, or work from your build directory, either is fine.

  7) Copy sockcheck.conf.example to sockcheck.conf (and edit to add
     new proxy types, if you wish).

  8) Copy srvx.conf.example to srvx.conf and edit to suit your
     needs.  Any errors in the config file will be made aware to you
     once you start the daemon.  If you disable nick ownership or enable
     the email features, you should copy srvx.conf to the src directory
     and re-run make; this will regenerate the help files (especially
     for NickServ) to include the appropriate entries.
     You can also do this by hand using the expnhelp program in src:
       ./src/expnhelp < nickserv.help.m4 > nickserv.help

  9) You can now begin using your service bots.  You can debug by
     running it with '-fV', it will not background itself, and it
     will be fairly verbose. If you would like to run in the foreground
     with no verbosity, use the '-f' flag.  If you just want to run it,
     execute srvx without any flags.

 10) Once you have srvx started, you'll need to register a NickServ
     account. Make sure that you register the first account - it is
     automatically granted certain privileges and gives you root-level
     access to OpServ once you are opered up.

End of file, INSTALL.

-Jedi (jedi@turboflux.net)
