Forward port missing fixes from Kev, beware and someone else.
[ircu2.10.12-pk.git] / 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
7 Compiling and installing ircu should be a fairly straightforward process,
8 if you have obtained this software as a (.tar.gz) package, please consider
9 using CVS (described below). Using CVS will make updating your installation
10 much easier. 
11
12 After obtaining the latest version of the ircu source code, change into the
13 source directory (ircu2.10), and run "./configure". To see the various ways
14 in which you can customize your installation, run "./configure --help".
15
16 The configure process will check your environment and prepare itself for
17 compiling the source code. If one or more of the prerequisites cannot be
18 found, configure will terminate with an error. You will need to resolve
19 this and run configure again.
20
21 If configure runs without error(s), you are ready to compile. To compile ircu,
22 run "make". Please use GNU make and gcc. If the source code does not compile,
23 make sure your environment is setup correctly. If you are convinced the source
24 of the failure is ircu, gather all relevant information about your system such
25 as the Architecture, OS version, the configure statement you used, etc. and
26 contact coder-com@undernet.org.
27
28 Once ircu is compiled, install it by running "make install".
29
30 Next, you will have to configure your IRC server by setting up your ircd.conf
31 file. Use the included doc/ircd.conf.sample as a starting point. 
32 Setting up ircd.conf can be a bit tricky, so if this is your first time doing
33 it, begin with a bare-bones configuration and extend it as you go.
34
35 If you are upgrading from ircu2.10.10, use the tools/transition script to
36 convert your existing configuration file(s).
37
38 Good Luck!
39
40 RETRIEVING IRCU VIA CVS
41
42 The recommended way to get the ircu package now is to use CVS.  CVS makes
43 upgrades a lot less painful and lets you get the latest package.
44
45 The first thing you need to do is login to the cvs server:
46 # cvs -d :pserver:anonymous@cvs.undernet.org:/cvsroot/undernet-ircu login
47
48 (we recommend that you cut and paste the above line to use it :)
49 When it prompts you for a password hit enter since there isn't one.
50
51 To check out the the last stable version of ircu, use:
52 # cvs -d :pserver:anonymous@cvs.undernet.org:/cvsroot/undernet-ircu co -P ircu2.10
53
54 To update your source tree to the latest version, run "cvs update -dP" from within the
55 ircu2.10 directory. For more information, see http://coder-com.undernet.org.
56