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.8) only supports the Undernet P10
  18 protocol and nefarious extensions. It is tested with Nefarious IRCu
  19 1.3. It does not support bahamut, hybrid, Unreal, or any other ircd
  20 not listed. Should you find other compatible ircds, please let us know.
  21 Most of the testing has been done on Nefarious IRCu 1.3.0 (Based on ircu2.10.11.x).
  22
  23 X3 is known to compile on the following systems as long as you
  24 are using GNU make (make on Linux, gmake on many other systems):
  25
  26   * Linux (libc5 or glibc2); glibc2.1 recommended+    (SPARC, ALPHA, x86, PPC)
  27   * FreeBSD 4.x; tested on 4.2-RELEASE and 4.2-STABLE (SPARC, x86)
  28   * FreeBSD 3.x; tested on 3.3-RELEASE and 3.4-STABLE (SPARC, x86)
  29   * FreeBSD 2.x; tested on 2.2.8-RELEASE              (SPARC, x86)
  30   * NetBSD 1.6+;                                      (ALPHA, MIPS, x86)
  31   * SunOS 5.x; tested on 5.8                          (SPARC, x86)
  32   * OpenBSD 2.x; tested on 2.8                        (x86)
  33   * BSDi 4.x; tested on 4.0.1                         (x86)
  34   * CYGWIN 1.1.x and 1.3.x; tested on 1.1.8           (x86)
  35
  36 X3 should compile on other system types also.  If you have success
  37 on other platforms/archs or problems on any platforms/archs, please
  38 contact the authors to let us know.
  39
  40 gcc 2.96 tends to emit spurious warnings; before reporting any
  41 compiler warnings from it, make sure you are using the most recent
  42 version of it or try using an official release of gcc.
  43
  44 You may also have trouble unless your compiler's C preprocessor
  45 supports ISO C99 varadic macros.  gcc is the compiler we use for
  46 almost all our testing, and we recommend it for use with X3.
  47
  48 Quick Install:
  49 ==============
  50 $ ./configure --prefix=~/x3run
  51     # Will install to x3run directory in your home directory
  52 $ make
  53 $ cp x3.conf.example x3.conf
  54 $ nano -w x3.conf
  55     # use -w (no wrapping) option with nano, or use your favorite editor
  56 $ ./x3
  57     # launches x3.
  58     # Note: x3 runs in the background as a service by default. Give it arguments
  59     # -f -d  to have it run in the foreground and print debug information.
  60
  61 Detailed Install:
  62 =================
  63 It is generally a bad idea to run or install x3 as root. Choose an account x3
  64 will run under, and configure it to install and run from somewhere that user
  65 has permissions.
  66
  67 Compiling:
  68 ----------
  69   1) cd to the main directory of the X3 source tree.
  70
  71   2) Run the configure script with correct arguments. You need to tell configure
  72      at minimum a path to install to, and which modules to compile.
  73      Configure will verify that your system will have the resources needed for
  74      X3 to compile. You should also turn debugging on to assist with setup:
  75      $ ./configure --prefix=/path/to/install --enable-modules=memoserv,helpserv --enable-debug
  76
  77   3) You may optionally edit config.h in case the configure script made a
  78      mistake. Leave it default to begin with.
  79
  80   4) Run "make" to begin compiling.  If you encounter any
  81      uncorrectable errors/warnings, please scroll up to the introduction
  82      section and follow the instructions.
  83      $ make
  84
  85   5) You may now either type "make install" to install it to your
  86      installation path, or work from your build directory, either is fine.
  87      $ make install
  88
  89   6) Change to the install directory.
  90      $ cd /path/to/install
  91
  92   7) Copy x3.conf.example to x3.conf and edit to suit your
  93      needs. Errors in the configuration file will be logged to
  94      main.log (and if X3 is running in the foreground with -f, printed to
  95      stdout) when you start x3.
  96      The example config contains help to assist you with modifications.
  97      Remember to begin by only editing the bare minimum ammount you need to
  98      edit to make it run. Then, when it is working, gradually customize the
  99      config more. This way errors can be identified at their source.
 100      $ cp x3.conf.example x3.conf
 101      $ nano -w x3.conf
 102
 103   8) You can now run x3 for the first time. You can debug by
 104      running it with '-fd'. It will not background itself, and it
 105      will be fairly verbose if you gave the configure script the
 106      --enable-debug flag. If you would like to run in the foreground
 107      with no verbosity, use the '-f' flag. If you just want to run it,
 108      execute X3 without any flags.
 109      $ ./x3 -fd
 110
 111   9) Once you have X3 started, you'll need to register a AuthServ
 112      account:
 113        /msg AuthServ@services.irc.com register <account> <password>
 114      Make sure that you register the first account -- it is
 115      automatically granted owner privileges and gives you admin
 116      access to O3 once you are opered up.
 117
 118  10) New operators can be given access to O3 through AuthServ's
 119      (or whatever you've named the nick/authentication service) oset
 120      command:
 121        /msg AuthServ oset <nick>|*<account> level <level>
 122      Levels are generally beween 0 and 1000 by convention; higher
 123      numbers correspond to more access. You can also add helpers
 124      (users with extra privileges such as security override in
 125      traditional configurations) through AuthServ:
 126        /msg AuthServ oset <nick>|*<account> flags +H
 127
 128  11) X3 stores its information in a flat text file (x3.db by default). If
 129      you shut down x3 first, you can edit this file by hand (but be careful!)
 130      If you delete it, x3 will start up brand new at step 9 (above) which
 131      can be handy if you think you have made a mistake.
 132
 133
 134
 135 If you get into trouble, stop by channel #Evilnet on irc.afternet.org for help.
 136
 137 --------------
 138 Help guide originally created for srvx by: -Jedi (jedi@turboflux.net)
 139 Adapted by Rubin
 140