]> jfr.im git - solanum.git/blobdiff - INSTALL
extensions/helpops: implement DEHELPER command
[solanum.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 2fe2dc9c419efec89382cac5d9f6f7bc66592bcc..e5abd5fc8b7e47caaccacbdb42875ef3b1962767 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,24 +1,10 @@
-                            Hybrid INSTALL Document
+                           Charybdis INSTALL Document
 
    $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
-
-     ----------------------------------------------------------------------
-
-   +------------------------------------------------------------------------+
-   | 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
 
      ----------------------------------------------------------------------
 
 
    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 BUGS, doc/ircd.conf.example, and
+       README.FIRST.
 
    2. 
 
 
           * 
 
-            --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
-            should be used on all production servers for maximum speed and to
-            prevent cores from things that shouldn't normally happen.
+            --enable-assert[=OPTION] - Enable some debugging code. OPTION is
+            either 'soft' or 'hard' (default: hard). 'hard' should never be
+            used on production servers as it may generate unnecessary cores.
+            'soft' prevents cores from being generated but still imposes some
+            additional load.
 
           * 
 
 
           * 
 
-            --with-nicklen - Sets the maximum NICK length. Note that this
-            must be consistant across your entire network.
-
+            --with-nicklen=LENGTH - Sets the maximum NICK length. Note that
+            this must be consistent across your entire network.
    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. 
 
-       make should build ircd.
+       make install will install the server, modules, and tools in the
+       the prefix specified when configure was run.
 
    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)
 
          Note: If you use different names in ircd.conf, you must 'touch' the
          specific names.
 
-   7. 
-
-       If you are upgrading from Hybrid 5 or Hybrid 6, the config file has
-       changed drastically...
-
-       There is a utility to convert your old config file to the new format.
-       In prefix/bin there is something called "convertconf". Its usage is:
-       ./convertconf (old config file to convert) (converted file name)
-
-       Convertconf will NOT convert I: lines.  You must use "convertilines"
-       for this which contains a much superior method of conversion and
-       will group I: together under one auth {};.
-
-       Once this is done, move your new config to prefix/etc/ircd.conf and
-       EDIT IT! There are still things that need changing in the config,
-       including the fact that classes MUST be above auth/connect blocks!
-
-   8. 
-
-       If you are upgrading from Hybrid 5 or Hybrid 6, the kline file has
-       also changed...
-
-       There is a utility to convert the old kline configuration file to the
-       new format. In prefix/bin there is a program called "convertklines".
-       Its usage is: ./convertklines (old kline.conf filename) (new
-       kline.conf filename) (dline.conf filename).
-
-       Once this is done, move the new files into the prefix/etc/ directory
-       under their proper names. By default, the kline file is named
-       kline.conf and the dline file is named dline.conf.
-
      ----------------------------------------------------------------------
 
                                 HOW TO GET HELP