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

[ngircd-alex.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index e04b27063ee5c79fbdac1793b855fc263cded55b..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
@@ -23,7 +23,7 @@ Differences to version 0.6.x
 
 Differences to version 0.5.x
 
-- Starting with version 0.6.0, other servers are identified using asyncronous
+- Starting with version 0.6.0, other servers are identified using asynchronous
   passwords: therefore the variable "Password" in [Server]-sections has been
   replaced by "MyPassword" and "PeerPassword".
 
@@ -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
@@ -51,9 +51,9 @@ files (using a distribution archive or CVS) is as following:
 
 The first step, autogen.sh, is only necessary if the configure-script isn't
 already generated. This never happens in official ("stable") releases in
-tar.gz-archieves, but when using CVS.
+tar.gz-archives, but when using CVS.
 
-This step is therefore only interesting for developpers.
+This step is therefore only interesting for developers.
 
 autogen.sh produces the Makefile.in's, which are necessary for the configure
 script itself, and some more files for make. To run autogen.sh you'll need
@@ -65,9 +65,9 @@ Again: "end users" do not need this step!
 
 2): "./configure"
 
-The configure-script is used to detect local system dependancies.
+The configure-script is used to detect local system dependencies.
 
-In the perfect case, configure should recognize all needed libraries, header
+In the perfect case, configure should recognise all needed libraries, header
 files and so on. If this shouldn't work, "./configure --help" shows all
 possible options.
 
@@ -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"
 
@@ -91,8 +96,9 @@ overwritten.
 
 This files will be installed by default:
 
-- /usr/local/sbin/ngircd: exectable server
+- /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
@@ -107,7 +113,7 @@ targets:
  - distclean: the above plus erase all generated Makefiles
    next step: -> ./configure
 
- - maintainer-clean: erease all automatic generated files
+ - maintainer-clean: erase all automatic generated files
    next step: -> ./autogen.sh
 
 
@@ -117,16 +123,19 @@ III. Sample configuration file ngircd.conf
 In the sample configuration file, there are comments beginning with "#" OR
 ";" -- this is only for the better understanding of the file.
 
-The file is seperated in four blocks: [Global], [Operator], [Server], and
-[Channel]. In the [Gobal] part, there is the main configuration, like the
-server-name and the ports, on which the server should be listening. In the
-[Operator] section, the server-operators are defined and [Server] is the
-section, where the server-links are configured. Use [Channel] blocks to
+The file is separated in four blocks: [Global], [Operator], [Server], and
+[Channel].
+
+In the [Global] section, there is the main configuration like the server
+name and the ports, on which the server should be listening. IRC operators
+of this server are defined in [Operator] blocks. [Server] is the section
+where server links are configured. And [Channel] blocks are used to
 configure pre-defined ("persistent") IRC channels.
 
 The meaning of the variables in the configuration file is explained in the 
 "doc/sample-ngircd.conf", which is used as sample configuration file in
-/usr/local/etc after running "make install" (if you don't already have one).
+/usr/local/etc after running "make install" (if you don't already have one)
+and in the "ngircd.conf" manual page.
 
 
 IV. Command line options
@@ -144,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.
 
@@ -154,4 +163,4 @@ number. In both cases the server exits after the output.
 
 
 -- 
-$Id: INSTALL,v 1.12 2003/03/08 12:34:55 alex Exp $
+$Id: INSTALL,v 1.19 2004/05/07 11:19:20 alex Exp $