INSTALL

   1               X3 Installation Instructions
   2
   3 Introduction:
   4 ----------
   5 If you encounter any problems compiling/running X3, please make sure
   6 you have followed the directions in this file correctly and that all
   7 of the requirements listed below are met.
   8
   9 If the problem persists, report it to one (or all) of the coders
  10 listed in the AUTHORS file. Please try to include ALL relevant
  11 information about the error/bug, including anything out of the
  12 ordinary reported from make and the appropriate entries from the log
  13 files.
  14
  15 Requirements:
  16 ----------
  17 This release of X3 (1.4) only supports the Undernet P10
  18 protocol and is known to link to ircu/Undernet (u2.10.11, u2.10.12),
  19 Nefarious IRCu 0.4.0 and Nefarious IRCu 1.0. It does not support
  20 bahamut, hybrid, Unreal, or any other ircd not listed. Should
  21 you find other compatible ircds, please let us know.  Most of the
  22 testing has been done on Nefarious IRCu 0.4.0/1.0 (Based on ircu2.10.11.x).
  23
  24 X3 is known to compile on the following systems as long as you
  25 are using GNU make (make on Linux, gmake on many other systems):
  26
  27   * Linux (libc5 or glibc2); glibc2.1 recommended+    (SPARC, ALPHA, x86, PPC)
  28   * FreeBSD 4.x; tested on 4.2-RELEASE and 4.2-STABLE (SPARC, x86)
  29   * FreeBSD 3.x; tested on 3.3-RELEASE and 3.4-STABLE (SPARC, x86)
  30   * FreeBSD 2.x; tested on 2.2.8-RELEASE              (SPARC, x86)
  31   * NetBSD 1.6+;                                      (ALPHA, MIPS, x86)
  32   * SunOS 5.x; tested on 5.8                          (SPARC, x86)
  33   * OpenBSD 2.x; tested on 2.8                        (x86)
  34   * BSDi 4.x; tested on 4.0.1                         (x86)
  35   * CYGWIN 1.1.x and 1.3.x; tested on 1.1.8           (x86)
  36
  37 For the Linux kernel, X3 has been tested on Debian 2.x - 3.x, and
  38 Redhat 5.x - 8.x.
  39
  40 X3 should compile on other system types also.  If you have success
  41 on other platforms/archs or problems on any platforms/archs, please
  42 contact the authors to let us know.
  43
  44 gcc 2.96 tends to emit spurious warnings; before reporting any
  45 compiler warnings from it, make sure you are using the most recent
  46 version of it or try using an official release of gcc.
  47
  48 You may also have trouble unless your compiler's C preprocessor
  49 supports ISO C99 varadic macros.  gcc is the compiler we use for
  50 almost all our testing, and we recommend it for use with X3.
  51
  52 Quick Install:
  53 ----------
  54 $ ./configure
  55     NOTE: The protocol the resulting X3 binary will support is
  56     determined by the configure script. The P10 protocol is the
  57     default.
  58 $ make
  59 $ ${EDITOR} x3.conf
  60     NOTE: You may want to copy x3.conf.example to x3.conf and
  61     edit that.
  62 $ ./x3
  63
  64 Compiling:
  65 ----------
  66   1) Enter the root directory of the X3 tree.  If installation is done
  67      from outside of it, it may cause problems during compile, or during
  68      runtime.
  69
  70   2) Run the configure script (sh configure), it will verify that your
  71      system will have the resources needed for X3 to compile.  If you
  72      would like to change the path where X3 will be installed to,
  73      execute configure with the --prefix=/path option.  The default path
  74      is ~/x3/, with the X's representing the version.
  75
  76   3) On some systems you may need to edit the Makefile in order for
  77      it to compile correctly.  Includes, and other such things may
  78      reside in other directories.  Most likely the Makefile won't require
  79      any modifications.
  80
  81   4) You may optionally edit config.h in case the configure script made a
  82      mistake.
  83
  84   5) Execute the "make" command to begin compiling.  If you encounter any
  85      uncorrectable errors/warnings, please scroll up to the introduction
  86      section and follow the instructions.
  87
  88   6) You may now either type "make install" to install it to your
  89      installation path, or work from your build directory, either is fine.
  90
  91   7) Copy sockcheck.conf.example to sockcheck.conf (and edit to add
  92      new proxy types, if you wish).
  93
  94   8) Copy x3.conf.example to x3.conf and edit to suit your
  95      needs. Errors in the configuration file will be logged to
  96      main.log (and if X3 is running in the foreground, printed to
  97      stdout) when you start the daemon.
  98
  99   9) You can now begin using your service bots.  You can debug by
 100      running it with '-fd', it will not background itself, and it
 101      will be fairly verbose if you gave the configure script the
 102      --enable-debug flag. If you would like to run in the foreground
 103      with no verbosity, use the '-f' flag. If you just want to run it,
 104      execute X3 without any flags.
 105
 106  10) Once you have X3 started, you'll need to register a AuthServ
 107      account:
 108        /msg AuthServ@services.irc.com register <account> <password>
 109      Make sure that you register the first account -- it is
 110      automatically granted certain privileges and gives you root-level
 111      access to O3 once you are opered up.
 112
 113  11) New operators can be given access to O3 through AuthServ's
 114      (or whatever you've named the nick/authentication service) oset
 115      command:
 116        /msg AuthServ oset <nick>|*<account> level <level>
 117      Levels are generally beween 0 and 1000 by convention; higher
 118      numbers correspond to more access. You can also add helpers
 119      (users with extra privileges such as security override in
 120      traditional configurations) through AuthServ:
 121        /msg AuthServ oset <nick>|*<account> flags +H
 122
 123 End of file, INSTALL.
 124
 125 -Jedi (jedi@turboflux.net)