New "chroot" feature (from Benjamin Pineau), introducing new configuration

[ngircd-alex.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 26807fb421c8b2a1d4d0498c807c3badd802bfaf..6df155fdd784e6bc6754d6bbeaf37848a81bcdbf 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,7 +1,7 @@
 
                      ngIRCd - Next Generation IRC Server
 
-                      (c)2001-2003 by Alexander Barton,
+                      (c)2001-2004 by Alexander Barton,
                     alex@barton.de, http://www.barton.de/
 
                ngIRCd is free software and published under the
@@ -34,8 +34,8 @@ Differences to version 0.5.x
 II. Standard Installation
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-ngIRCd is developed for UNIX-like systems, which means that the installation
-on modern UNIX-like systems witch are supported by GNU autoconf and GNU
+ngIRCd is developed for UNIX-based systems, which means that the installation
+on modern UNIX-like systems that are supported by GNU autoconf and GNU
 automake ("configure") should be no problem.
 
 The normal installation procedure after getting (and expanding) the source
@@ -75,6 +75,11 @@ In addition, you can pass some command line options to "configure" to enable
 and/or disable some features of ngIRCd. All these options are shown using
 "./configure --help", too.
 
+Compiling a static binary will avoid you the hassle of feeding a chroot dir
+(if you want use the chroot feature). Just do something like:
+  CFLAGS=-static ./configure [--your-options ...]
+Then you can use a void directory as ChrootDir (like OpenSSH's /var/empty).
+
 
 3): "make"
 
@@ -93,6 +98,7 @@ This files will be installed by default:
 
 - /usr/local/sbin/ngircd: executable server
 - /usr/local/etc/ngircd.conf: sample configuration (if not already present)
+- /usr/local/share/doc/ngircd/: documentation
 
 
 II. Useful make-targets
@@ -147,7 +153,7 @@ These parameters could be passed to the ngIRCd:
 -p, --passive
        Server-links won't be automatically established.
 
---configtest
+-t, --configtest
        Reads, validates and dumps the configuration file as interpreted
        by the server. Then exits.
 
@@ -157,4 +163,4 @@ number. In both cases the server exits after the output.
 
 
 -- 
-$Id: INSTALL,v 1.14 2003/03/10 00:23:34 alex Exp $
+$Id: INSTALL,v 1.19 2004/05/07 11:19:20 alex Exp $