- INSTALL file by Run <carlo@runaway.xs4all.nl>
+ircu - INSTALL
+ Original by Run <carlo@runaway.xs4all.nl>,
+ Isomer <isomer@coders.net>, and Kev <klmitch@mit.edu>
+ Rewritten by Sengaia <sengaia@undernet.org>
+ Updated by Entrope <entrope@undernet.org>
-This is the UnderNet IRC daemon.
+Compiling and installing ircu should be a fairly straightforward process,
+if you have obtained this software as a (.tar.gz) package, please consider
+using CVS (described below). Using CVS will make updating your installation
+much easier.
-The installation of the IRC daemon (ircd) exists of the following steps:
+After obtaining the latest version of the ircu source code, change into the
+source directory (ircu2.10.xx.yy), and run "./configure". To see the various
+ways in which you can customize your installation, run "./configure --help".
-1) Untar the package.
-2) cd into the base directory.
-3 )`./configure'
-4) `make config'
-5) `make'
-6) `make install'
+The configure process will check your environment and prepare itself for
+compiling the source code. If one or more of the prerequisites cannot be
+found, configure will terminate with an error. You will need to resolve
+this and run configure again.
-1) Untar the package
-====================
+If configure runs without error(s), you are ready to compile. To compile ircu,
+run "make". Please use GNU make and gcc. If the source code does not compile,
+make sure your environment is setup correctly. If you are convinced the source
+of the failure is ircu, gather all relevant information about your system such
+as the Architecture, OS version, the configure statement you used, etc. and
+contact coder-com@undernet.org.
-The name of the package is something like `ircu2.x.y.z.tgz', where
-"x.y.z" is the current release (at the time of writing we have
-ircu2.10.00.beta3.tgz).
+Once ircu is compiled, install it by running "make install".
-You need `gzip', the GNU unzip command, to uncompress this package.
-You can download this from every GNU ftp site for almost any Operating system.
+Next, you will have to configure your IRC server by setting up your ircd.conf
+file. Use the included doc/example.conf as a starting point; it is installed
+in $HOME/lib/example.conf by default.
+Setting up ircd.conf can be a bit tricky, so if this is your first time doing
+it, begin with a bare-bones configuration and extend it as you go.
-If you have GNU tar, type:
+If you are upgrading from ircu2.10.11, use the ircd/convert-conf
+program to convert your existing configuration file(s). It is
+compiled during "make" and installed to $PREFIX/bin/convert-conf.
-tar xzf ircu2.x.y.z.tgz
+Good Luck!
-where "ircu2.x.y.z.tgz" is the name of the package.
+RETRIEVING IRCU VIA CVS
-If your tar doesn't support the 'z' flag, you can type alternatively:
+The recommended way to get the ircu package now is to use CVS. CVS makes
+upgrades a lot less painful and lets you get the latest package.
-gzip -dc ircu2.x.y.z.tgz | tar xf -
+The first thing you need to do is login to the cvs server:
+# cvs -d :pserver:anonymous@cvs.undernet.org:/cvsroot/undernet-ircu login
-Both methods result in a directory "ircu2.x.y.z" in your current directory.
+(we recommend that you cut and paste the above line to use it :)
+When it prompts you for a password hit enter since there isn't one.
-2) cd into the base directory
-=============================
+To check out the the last development version of ircu, use:
+# cvs -d :pserver:anonymous@cvs.undernet.org:/cvsroot/undernet-ircu co -P ircu2.10
+The latest stable version has a tag name that depends on the version
+number; see doc/readme.cvs for details.
-Make this directory your current directory by typing:
+To update your source tree to the latest version, run "cvs update -dP" from within the
+ircu2.10 directory. For more information, see http://coder-com.undernet.org.
-cd ircu2.x.y.z
-
-where "ircu2.x.y.z" is the name of the unpacked directory.
-
-3) `./configure'
-==============
-
-This will generate 'config/setup.h', your Operating System dependend
-configuration.
-
-4) `make config'
-================
-
-This will (re)generate the include/config.h file. You can run this
-as often as you like and it will use your last values as defaults.
-At every question you can type a '?' (followed by a return) to get
-extensive help, or a 'c' to continue using your old values by default
-(quickly finishing the script).
-
-5) `make'
-=========
-
-Type:
-
-make
-
-in the base directory. It should compile without errors or warnings.
-Please mail any problem to the maintainer, but only AFTER you made sure
-you did everything the right way. If you want your Operating System
-to be supported in future releases, you best make a patch that
-actually fixes the problem.
-
-6) `make install'
-=================
-
-This should install the ircd and the man page. Please recheck the
-permissions of the binary.
-You need to create some of the logfiles that you have chosen by hand
-(for instance with 'touch') before the ircd starts writing to them.
-Of course, you need a syntactically correct ircd.conf in DPATH. See the
-docs for some info on this. Also create an ircd.motd with the text of
-your MOTD. And finally create a remote.motd with three lines of text
-as the remote MOTD. Again, all of these files should be readable by the
-ircd, and the logfiles should be writeable.
-
-
-In case of problems
-===================
-
-If you have problems configuring the server you might consider installing
-GNU make in your PATH. In some cases a brain-dead /bin/sh is causing the
-problem, in which case I suggest to install 'bash' and use that (as sh -> bash).
-Finally, any other compile problem should be solved when you install gcc.
-
-If you have problems with starting the ircd, run 'make config' again
-and define DEBUGMODE. Recompile the ircd, and run it by hand as:
-
-ircd -t -x9
-
-This will write debug output to your screen, probably showing why it
-doesn't start.
-
-Don't use a server with DEBUGMODE defined on a production net.
projects / ircu2.10.12-pk.git / blobdiff