ShadowIRCd 6.2.0-beta1

[irc/rqf/shadowircd.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index fe8f958af1c58a696a6699458578adb36f82227b..e6baaf1f084e344326b96aa37f48cc8c66ddb5ad 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,24 +1,11 @@
-                            Hybrid INSTALL Document
+                           ShadowIRCd INSTALL Document

 
 

-   $Id: INSTALL 1837 2006-08-22 14:05:58Z nenolod $
+   $Id: INSTALL 3384 2007-04-03 22:45:04Z jilles $

 
    Copyright (c) 2001 by ircd-hybrid team
    Copyright (c) 2002-2004 ircd-ratbox development team
 
    Copyright (c) 2001 by ircd-hybrid team
    Copyright (c) 2002-2004 ircd-ratbox development team

-
-     ----------------------------------------------------------------------
-
-   +------------------------------------------------------------------------+
-   | Note for those who dont bother reading docs                            |
-   |                                                                        |
-   | Reading INSTALL is now a must, as the old DPATH is now specified when  |
-   | configure is run.                                                      |
-   |                                                                        |
-   | - You now need to ./configure --prefix="/path/to/install/it"           |
-   |                                                                        |
-   |   Important: The old config format WILL NOT WORK. Please see point 6!  |
-   |                                                                        |
-   |   The old kline format WILL NOT WORK. Please see point 7!              |
-   +------------------------------------------------------------------------+
+   Copyright (c) 2005-2008 charybdis development team
+   Copyright (c) 2010 by ShadowIRCd development team

 
      ----------------------------------------------------------------------
 
 
      ----------------------------------------------------------------------
 


@@ -30,19 +17,16 @@
 
    1. 
 
 
    1. 
 

-       Read the ChangeLog file to find out about the exciting new features in
-       this version. Other good reads are doc/whats-new.txt, BUGS,
-       doc/example.conf, and README.FIRST.
-
-       An example.conf for EFnet is in doc/ with the values "approved" on 12
-       December 2001.
+       Read the NEWS file to find out about the exciting new features in
+       this version. Other good reads are doc/example.conf, and
+       README.FIRST.

 
    2. 
 
        Run the configure script. It will create include/setup.h and the
        Makefiles to match your system. In ircd-ratbox, the paths are now handled
        with the --prefix option to configure, not in config.h.
 
    2. 
 
        Run the configure script. It will create include/setup.h and the
        Makefiles to match your system. In ircd-ratbox, the paths are now handled
        with the --prefix option to configure, not in config.h.

-       /usr/local/ircd is the default if no prefix is specified.
+       $HOME/ircd is the default if no prefix is specified.

 
        ./configure --prefix="/usr/local/ircd"
 
 
        ./configure --prefix="/usr/local/ircd"
 


@@ -80,13 +64,6 @@
 
             --enable-ipv6 - Enable IPv6 support.
 
 
             --enable-ipv6 - Enable IPv6 support.
 

-          * 
-
-            --disable-shared-modules - Disable module support. This option is
-            more secure, but reduces a lot of the flexibility in Hybrid 7.
-            This may need to be used on some systems without a working dl
-            library.
-

           * 
 
             --disable-assert - Disable some of the debugging code. This
           * 
 
             --disable-assert - Disable some of the debugging code. This


@@ -102,46 +79,19 @@
 
           * 
 
 
           * 
 

-            --with-nicklen - Sets the maximum NICK length. Note that this
-            must be consistant across your entire network.
-
-          * 
-
-            --with-maxclients - Sets the maximum number of clients support by
-            the server. Note that this also twiddles the HARD_FDLIMIT_ define
-            so it is no longer necessary to modify include/config.h for this.
-            If HARD_FDLIMIT_ ends up being larger that FD_SETSIZE when using
-            select() for your I/O loop, s_bsd_select.c will refuse to compile
-            (and tell you to use poll instead). Take this error's advice and
-            use --enable-poll or something a bit more efficient. You'll be
-            happier at the end of the day for it.
-
+            --with-nicklen=LENGTH - Sets the maximum NICK length. Note that
+            this must be consistent across your entire network.

    3. 
 
    3. 
 

-       Look over the "include/config.h" file. This allows you to change the
-       few remaining hard coded options of how the ircd will operate. Most
-       admins will only have to change a few settings. USE_SYSLOG is the only
-       one that most admins will need to edit.
-
-         Note: Note that you must have permission by the sysadmin to send
-         messages to the system log files.
-
-         All other settings in config.h are not necessary to edit.
+       make should build ircd.

 
    4. 
 
 
    4. 
 

-       make should build ircd.
+       make install will install the server, modules, and tools in the
+       the prefix specified when configure was run.

 
    5. 
 
 
    5. 
 

-       make install will install the server, modules(1), and tools in the
-       path defined in config.h and the prefix specified when configure was
-       run.
-
-       (1) Unless the server was compiled without module support.
-
-   6. 
-

        If you wish to enable the user log, oper log, and failed oper log,
        issue these commands at the shell prompt (in the prefix directory)
 
        If you wish to enable the user log, oper log, and failed oper log,
        issue these commands at the shell prompt (in the prefix directory)
 


@@ -152,7 +102,7 @@
          Note: If you use different names in ircd.conf, you must 'touch' the
          specific names.
 
          Note: If you use different names in ircd.conf, you must 'touch' the
          specific names.
 

-   7. 
+   6. 

 
        If you are upgrading from Hybrid 5 or Hybrid 6, the config file has
        changed drastically...
 
        If you are upgrading from Hybrid 5 or Hybrid 6, the config file has
        changed drastically...


@@ -169,7 +119,7 @@
        EDIT IT! There are still things that need changing in the config,
        including the fact that classes MUST be above auth/connect blocks!
 
        EDIT IT! There are still things that need changing in the config,
        including the fact that classes MUST be above auth/connect blocks!
 

-   8. 
+   7. 

 
        If you are upgrading from Hybrid 5 or Hybrid 6, the kline file has
        also changed...
 
        If you are upgrading from Hybrid 5 or Hybrid 6, the kline file has
        also changed...


@@ -187,16 +137,12 @@
 
                                 HOW TO GET HELP
 
 
                                 HOW TO GET HELP
 

-   Send Check or Money Order to... just kidding! You're on your own for
-   support. Try asking other ircd-ratbox admins on EFnet if you can't fix it
-   yourself. If you do fix anything, however, please send context or unified
-   diffs to ircd-ratbox@lists.ratbox.org so the fixes can be incorporated into
-   the next release of ircd-hybrid. If ratbox crashes on you, PLEASE contact
-   ircd-ratbox@lists.ratbox.org ASAP with a backtrace of the core.
+       The best way to get help regarding bugs and such is by asking on our
+       IRC channel which is at irc.thinstack.net #shadowircd . Bugs can also
+       be filed on our bugtracker at: 
+       
+       http://bitbucket.org/uranium/shadowircd/issues/?status=new&status=open

 
 

-   DISCUSSION: There is a mailing list for discussion of ratbox issues,
-    To subscribe, visit:
-       http://lists.ratbox.org/cgi-bin/mailman/listinfo/ircd-ratbox

        
      ----------------------------------------------------------------------
 
        
      ----------------------------------------------------------------------