X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=INSTALL;h=6df155fdd784e6bc6754d6bbeaf37848a81bcdbf;hp=032857268a7ce077eb49c547582d48dbb9331906;hb=7281b8dd4d917f8b7f7c36460b78b686427ce973;hpb=a84b9d99a1587c0c9d1fe6f8fda77adb6a6bab47 diff --git a/INSTALL b/INSTALL index 03285726..6df155fd 100644 --- 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 @@ -118,15 +124,18 @@ In the sample configuration file, there are comments beginning with "#" OR ";" -- this is only for the better understanding of the file. The file is separated in four blocks: [Global], [Operator], [Server], and -[Channel]. In the [Global] 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 +[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.13 2003/03/09 22:03:58 alex Exp $ +$Id: INSTALL,v 1.19 2004/05/07 11:19:20 alex Exp $