- INSTALL file by Run <carlo@runaway.xs4all.nl>
-
+INSTALL file by Run <carlo@runaway.xs4all.nl>
+ Updated by Isomer <isomer@coders.net>
+ Updated for u2.10.11 by Kev <klmitch@mit.edu>
This is the UnderNet IRC daemon.
The installation of the IRC daemon (ircd) exists of the following steps:
-1) Untar the package.
+1) Retrieve the package.
2) cd into the base directory.
-3 )`./configure'
-4) `make config'
-5) `make'
-6) `make install'
+3) "./configure"
+4) "make"
+5) "make install"
+
+1) Retrieve the package.
+========================
+
+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.
+
+1.1) The first thing you need to do is "authenticate" yourself against the
+server.
+
+This is done with:
+
+cvs -d :pserver:anoncvs@coder.com.undernet.org:/home/coder-com/cvs login
+
+(we recommend that you cut and paste the above line to use it :)
+When it prompts you for a password enter "anoncvs".
+
+1.2) The module you will check out is ircu2.10. There are three branches
+you can check out.
-1) Untar the package
-====================
+stable - This branch is always the recommended version for use on the
+ Undernet. To check out the stable tree, add "-r u2_10_11" to
+ the CVS command line.
-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).
+beta - This branch is undergoing testing before being promoted to the
+ stable branch. It may be buggy. Use on the Undernet's production
+ network is prohibited, except for certain authorized servers. The
+ "-r" flag you need to check this branch out is documented on the
+ Coder Committee's web site, http://coder-com.undernet.org.
-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.
+alpha - This is the development branch. It is not guaranteed to even
+ compile, and should be considered HIGHLY unstable. It is NOT
+ intended for production use. If you wish to play with the server,
+ you may wish to investigate the test network. To check this branch
+ out, use no "-r" flags.
-If you have GNU tar, type:
-tar xzf ircu2.x.y.z.tgz
+to check out the tree, type:
-where "ircu2.x.y.z.tgz" is the name of the package.
+cvs -d :pserver:anoncvs@coder-com.undernet.org:/home/coder-com/cvs checkout
+ -P ircu2.10
-If your tar doesn't support the 'z' flag, you can type alternatively:
+The above two lines shouldn't have an enter between them. If you want to
+use another branch, place the appropriate "-r" flag after the "checkout"
+command. This will create a directory ircu2.10, and put all the files in
+there.
-gzip -dc ircu2.x.y.z.tgz | tar xf -
+To get the latest version, from within the tree type "cvs update -dP".
-Both methods result in a directory "ircu2.x.y.z" in your current directory.
+For more information see the coder-com website at
+http://coder-com.undernet.org/
+The old (tried and true) method that works even when the website isn't being
+DoS'd (sigh) is included below. Using the method below means you can't
+just type 'cvs update -dP' to get the latest version.
+
+ 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).
+
+ 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.
+
+ If you have GNU tar, type:
+
+ tar xzf ircu2.x.y.z.tgz
+
+ where "ircu2.x.y.z.tgz" is the name of the package.
+
+ If your tar doesn't support the 'z' flag, you can type alternatively:
+
+ gzip -dc ircu2.x.y.z.tgz | tar xf -
+
+ Both methods result in a directory "ircu2.x.y.z" in your current directory.
+
2) cd into the base directory
=============================
cd ircu2.x.y.z
+or ircu2.10 if you used cvs.
+
where "ircu2.x.y.z" is the name of the unpacked directory.
-3) `./configure'
-==============
+3) "./configure"
+================
-This will generate 'config/setup.h', your Operating System dependend
+This will generate "config.h", your operating system-dependent
configuration.
-4) `make config'
-================
+If this produces a "Permission Denied" error message, then try typing
+"chmod a+x ./configure" first to give yourself permission to run the file.
-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).
+For information on configure command line options, type "./configure --help".
-5) `make'
+4) "make"
=========
Type:
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
+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'
+5) "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
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.
+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:
+If you have problems with starting the ircd, run "./configure" again
+and give it the "--enable-debug" command line option. 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.
+DO NOT USE A SERVER WITH DEBUGGING ENABLED ON A PRODUCTION NETWORK. Doing
+so is a severe privacy risk.
+
+If things still don't work, try emailing coder-com@undernet.org