INSTALL

   1
   2 ircu - INSTALL
   3   Original by Run <carlo@runaway.xs4all.nl>,
   4   Isomer <isomer@coders.net>, and Kev <klmitch@mit.edu>
   5   Rewritten by Sengaia <sengaia@undernet.org>
   6   Updated by Entrope <entrope@undernet.org>
   7
   8 Compiling and installing ircu should be a fairly straightforward process,
   9 if you have obtained this software as a (.tar.gz) package, please consider
  10 using CVS (described below). Using CVS will make updating your installation
  11 much easier.
  12
  13 After obtaining the latest version of the ircu source code, change into the
  14 source directory (ircu2.10.xx.yy), and run "./configure". To see the various
  15 ways in which you can customize your installation, run "./configure --help".
  16
  17 The configure process will check your environment and prepare itself for
  18 compiling the source code. If one or more of the prerequisites cannot be
  19 found, configure will terminate with an error. You will need to resolve
  20 this and run configure again.
  21
  22 If configure runs without error(s), you are ready to compile. To compile ircu,
  23 run "make". Please use GNU make and gcc. If the source code does not compile,
  24 make sure your environment is setup correctly. If you are convinced the source
  25 of the failure is ircu, gather all relevant information about your system such
  26 as the Architecture, OS version, the configure statement you used, etc. and
  27 contact coder-com@undernet.org.
  28
  29 Once ircu is compiled, install it by running "make install".
  30
  31 Next, you will have to configure your IRC server by setting up your ircd.conf
  32 file. Use the included doc/example.conf as a starting point; it is installed
  33 in $HOME/lib/example.conf by default.
  34 Setting up ircd.conf can be a bit tricky, so if this is your first time doing
  35 it, begin with a bare-bones configuration and extend it as you go.
  36
  37 If you are upgrading from ircu2.10.11, use the ircd/convert-conf
  38 program to convert your existing configuration file(s).  It is
  39 compiled during "make" and installed to $PREFIX/bin/convert-conf.
  40
  41 Good Luck!
  42
  43 RETRIEVING IRCU VIA CVS
  44
  45 The recommended way to get the ircu package now is to use CVS.  CVS makes
  46 upgrades a lot less painful and lets you get the latest package.
  47
  48 The first thing you need to do is login to the cvs server:
  49 # cvs -d :pserver:anonymous@cvs.undernet.org:/cvsroot/undernet-ircu login
  50
  51 (we recommend that you cut and paste the above line to use it :)
  52 When it prompts you for a password hit enter since there isn't one.
  53
  54 To check out the the last development version of ircu, use:
  55 # cvs -d :pserver:anonymous@cvs.undernet.org:/cvsroot/undernet-ircu co -P ircu2.10
  56 The latest stable version has a tag name that depends on the version
  57 number; see doc/readme.cvs for details.
  58
  59 To update your source tree to the latest version, run "cvs update -dP" from within the
  60 ircu2.10 directory. For more information, see http://coder-com.undernet.org.
  61