INSTALL

   1                            INSTALL file        by Run <carlo@runaway.xs4all.nl>
   2
   3
   4 This is the UnderNet IRC daemon.
   5
   6 The installation of the IRC daemon (ircd) exists of the following steps:
   7
   8 1) Untar the package.
   9 2) cd into the base directory.
  10 3 )`./configure'
  11 4) `make config'
  12 5) `make'
  13 6) `make install'
  14
  15 1) Untar the package
  16 ====================
  17
  18 The name of the package is something like `ircu2.x.y.z.tgz', where
  19 "x.y.z" is the current release (at the time of writing we have
  20 ircu2.10.00.beta3.tgz).
  21
  22 You need `gzip', the GNU unzip command, to uncompress this package.
  23 You can download this from every GNU ftp site for almost any Operating system.
  24
  25 If you have GNU tar, type:
  26
  27 tar xzf ircu2.x.y.z.tgz
  28
  29 where "ircu2.x.y.z.tgz" is the name of the package.
  30
  31 If your tar doesn't support the 'z' flag, you can type alternatively:
  32
  33 gzip -dc ircu2.x.y.z.tgz | tar xf -
  34
  35 Both methods result in a directory "ircu2.x.y.z" in your current directory.
  36
  37 2) cd into the base directory
  38 =============================
  39
  40 Make this directory your current directory by typing:
  41
  42 cd ircu2.x.y.z
  43
  44 where "ircu2.x.y.z" is the name of the unpacked directory.
  45
  46 3) `./configure'
  47 ==============
  48
  49 This will generate 'config/setup.h', your Operating System dependend
  50 configuration.
  51
  52 4) `make config'
  53 ================
  54
  55 This will (re)generate the include/config.h file.  You can run this
  56 as often as you like and it will use your last values as defaults.
  57 At every question you can type a '?' (followed by a return) to get
  58 extensive help, or a 'c' to continue using your old values by default
  59 (quickly finishing the script).
  60
  61 5) `make'
  62 =========
  63
  64 Type:
  65
  66 make
  67
  68 in the base directory.  It should compile without errors or warnings.
  69 Please mail any problem to the maintainer, but only AFTER you made sure
  70 you did everything the right way.  If you want your Operating System
  71 to be supported in future releases, you best make a patch that
  72 actually fixes the problem.
  73
  74 6) `make install'
  75 =================
  76
  77 This should install the ircd and the man page. Please recheck the
  78 permissions of the binary.
  79 You need to create some of the logfiles that you have chosen by hand
  80 (for instance with 'touch') before the ircd starts writing to them.
  81 Of course, you need a syntactically correct ircd.conf in DPATH.  See the
  82 docs for some info on this.  Also create an ircd.motd with the text of
  83 your MOTD.  And finally create a remote.motd with three lines of text
  84 as the remote MOTD.  Again, all of these files should be readable by the
  85 ircd, and the logfiles should be writeable.
  86
  87
  88 In case of problems
  89 ===================
  90
  91 If you have problems configuring the server you might consider installing
  92 GNU make in your PATH.  In some cases a brain-dead /bin/sh is causing the
  93 problem, in which case I suggest to install 'bash' and use that (as sh -> bash).
  94 Finally, any other compile problem should be solved when you install gcc.
  95
  96 If you have problems with starting the ircd, run 'make config' again
  97 and define DEBUGMODE.  Recompile the ircd, and run it by hand as:
  98
  99 ircd -t -x9
 100
 101 This will write debug output to your screen, probably showing why it
 102 doesn't start.
 103
 104 Don't use a server with DEBUGMODE defined on a production net.