From 754f1a19eb4cf2990905db004de26568e7d2c1c6 Mon Sep 17 00:00:00 2001 From: Kevin Easton Date: Mon, 31 Dec 2012 13:27:29 +0000 Subject: [PATCH] Update installation instructions, including changes from cpet. git-svn-id: svn://svn.code.sf.net/p/bitchx/code/trunk@218 13b04d17-f746-0410-82c6-800466cd88b0 --- INSTALL | 85 +++++++++++++++++++-------------------------------------- 1 file changed, 28 insertions(+), 57 deletions(-) diff --git a/INSTALL b/INSTALL index 15452ff..513be8f 100644 --- a/INSTALL +++ b/INSTALL @@ -1,9 +1,8 @@ - Installation Instructions for BitchX 1.1-Final + Installation Instructions for BitchX 1.2 BitchX is known to compile on the following systems (maybe others as well): - * BSDI 2.0, 2.1, 3.1, 4.0 - * FreeBSD 2.x, 3.x, 4.0 - * NetBSD 3.x, 4.x + * FreeBSD 2.x and above + * NetBSD 3 and above * SunOS 4.1.4, 5.x and above * Linux (All) * IRIX 5, 6 @@ -12,16 +11,15 @@ BitchX is known to compile on the following systems (maybe others as well): * Ultrix * AIX * OS/2 (with EMX) - * Windows 9x/2000/NT (with Cygwin) + * Windows 9x/2000/NT/XP (with Cygwin) * QNX Introduction: Problems may occur during the compilation process of BitchX. If you do have a problem, please gather as much information about the error -(*FULL* output of "make") and join #BitchX on EFNet, or use the forums website -at http://www.cyberpunkz.org. Bug reports can be submitted via the web at -http://bugs.bitchx.org/ +(*FULL* output of "make") and join #BitchX on EFNet, or use the Sourceforge +page at http://sourceforge.net/projects/bitchx/. Several script writers tend to hang in the #BitchX on EFNet to distribute their work to others. scripts.bitchx.org is a great place where @@ -32,14 +30,13 @@ previously mentioned forums site. /4OP for example. Therefore, servers such as UnderNet, DalNet, and NewNet, to name a few, will not respond to the user modes given. Scripts can cause problems as well, usually due to bugs within the script. If there is a -known bug in the client, please contact the appropriate people, panasync +known bug in the client, please contact the appropriate people, caf or any of the non-idling ops in #BitchX. If the bug can be reproduced faithfully, then we have enough to determine how it can be resolved. - - Please check out the FAQ at http://faq.bitchx.org if you should -have any troubles compiling. A number of common mistakes and problems -users run into are posted in the FAQ and sometimes on the Forums as well. + Please check out the FAQ at http://wiki.bitchx.org/faq:start if you +have any trouble compiling. A number of common mistakes and problems +users run into are posted in the FAQ. Compiling BitchX: @@ -59,11 +56,11 @@ are marked with an asterisk, "*") options that can be given to "configure". "configure --help" will detail all of them. Using at least "configure --with-plugins" is recommended if you plan on using one or more of the many plugins that are - distributed with BitchX. Add "--with-gtk" if you have gtk and gnome-libs - and would like a graphical client. Add "--with-tcl" if you want Tcl script - support on i386 systems (Note: most users do not need this). tcl.o for - other architecures may be available on BitchX FTP sites. The source code - for tcl.o is not publically available. + distributed with BitchX. Add "--with-tcl" if you want Tcl script + support (Note: most users do not need this). + + If you are not root, pass the --prefix=$HOME option to have BitchX + install to your home directory. * 3) "include/config.h" may need tweaking if you intend to change the default server list. To change, locate "DEFAULT_SERVER" and remove the @@ -72,52 +69,26 @@ are marked with an asterisk, "*") list). Alternatively, you can run "make bxconf" and use the graphical configuration utility to change many of BitchX's options. - 4) Execute "make" inside the BitchX directory. If any error messages are - shown (Error, *not* Warning messages!!!) that you are unable to resolve - on your own, seek help. "README" has more information on where you can go - for help. + 4) Execute "make" inside the BitchX directory (on BSD-based platforms, use + "gmake" instead). If any error messages are shown (Error, *not* Warning + messages!!!) that you are unable to resolve on your own, seek help. + "README" has more information on where you can go for help. -* 5) Edit "include/defs.h". On some systems, configure may not properly - determine one or two definitions ("#define foo"). Search for - offending defines which cause make not to proceed compiling. - Usually, there should be a "#define" or "#undef" located on the line - make has shown. A reversal of the definition (change "#define" to - "#undef", or vice versa). Go on to step 6 once you have completed - this step. If problems still persist, see "README" for information on - where you can go for help. Note: DOING THIS STEP IS NOT RECOMMENDED. - If "configure" fails to properly define something for whatever reason, - PLEASE REPORT THIS AS A BUG to the current configure script maintainer - (see "README" for details), rather than trying to edit "include/defs.h" - by hand. + 5) Execute "make install" (on BSD-based platforms, use "gmake install" + instead). This should install the BitchX binary to /usr/local/bin, or + to $HOME/bin if you supplied the "--prefix=$HOME" option in step 2. -* 6) Debugging information may be left into the compiled binary, so a - "strip source/BitchX" solves the rather large size seen previously. - However, "make install" (Step 7) should strip the binaries for you. - - 7) Execute "make install". This should install the BitchX binary to - "/usr/local/bin". Commonly, users may not have superuser access, thus a - refusal ("permission denied" message) will occur. If you still insist on - using "make install" to install BitchX, it is required that you change - the installation path defined in step 4 by using - "configure --prefix=/home/johndoe", for example, or use - "make install_local" to install the binary to your home directory. - However, it is recommened that you use the "--prefix=" method if you wish - to have a full BitchX installation with all of the help files installed. - -* 8) It is not a requirement to use function-filled scripts with BitchX, - because the aim of BitchX is to create a scriptless client, or more - appropriately, a client less dependant upon scripts. With the development - of BitchX, scripts will become quickly outdated due to the - incompatibility caused by new commands, hooks, or hardcoded replacements - for a function in the script. This is merely a warning. + Users without superuser access will typically see a "permission denied" + error here if they try to install to the default prefix. -- Last Updated: -Rob Andrews -sin@bitchx.org -Match 26th, 2004 +caf +caf@guarana.org +December 31st, 2012 Previous authors: +Rob Andrews David Walluck BarK0de BlackJac