X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=INSTALL;h=f4a6ae4d74e66bd7435342c1b8c65a849c3763be;hp=e19ea044efe467c018d495b2c5e67636715c90d6;hb=2d9a3ec484a5b4ad46cf1f12473505532f56bba3;hpb=17fffea873b92885c7620b649581ba9a7444e21e diff --git a/INSTALL b/INSTALL index e19ea044..f4a6ae4d 100644 --- a/INSTALL +++ b/INSTALL @@ -1,7 +1,7 @@ ngIRCd - Next Generation IRC Server - (c)2001-2004 by Alexander Barton, + (c)2001-2006 by Alexander Barton, alex@barton.de, http://www.barton.de/ ngIRCd is free software and published under the @@ -14,6 +14,18 @@ I. Upgrade Information ~~~~~~~~~~~~~~~~~~~~~~ +Differences to version 0.9.x + +- The option of the configure script to enable support for Zeroconf/Bonjour/ + Rendezvous/WhateverItIsNamedToday has been renamed: + --with-rendezvous -> --with-zeroconf + +Differences to version 0.8.x + +- The maximum length of passwords has been raised to 20 characters (instead + of 8 characters). If your passwords are longer than 8 characters then they + are cut at an other position now. + Differences to version 0.6.x - Some options of the configure script have been renamed: @@ -46,6 +58,20 @@ files (using a distribution archive or CVS) is as following: 3) make 4) make install +(Please see details below!) + +Now the newly compiled executable "ngircd" is installed in its standard +location, /usr/local/sbin/. + +The next step is to configure and afterwards starting the daemon. Please +have a look at the ngircd(8) and ngircd.conf(5) manual pages for details +and all possible options. + +If no previous version of the configuration file exists (the standard name +is /usr/local/etc/ngircd.conf), a sample configuration file containing all +possible options will be installed there. You'll find its template in the +doc/ directory: sample-ngircd.conf. + 1): "autogen.sh" @@ -75,6 +101,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" @@ -96,7 +127,59 @@ This files will be installed by default: - /usr/local/share/doc/ngircd/: documentation -II. Useful make-targets +III. Additional features +~~~~~~~~~~~~~~~~~~~~~~~~ + +The following optional features can be compiled into the daemon by passing +options to the "configure" script. Most options can handle a argument +which will be used to search for the required libraries and header files in +the given paths ("/lib/...", "/include/...") in addition to the +standard locations. + +* Syslog Logging (autodetected by default): + --with-syslog[=] / --without-syslog + + Enable (disable) support for logging to "syslog", which should be + available on most modern UNIX-like operating systems by default. + +* ZLib Compression (autodetected by default): + --with-zlib[=] / --without-zlib + + Enable (disable) support for compressed server-server links. + The Z compression library ("libz") is required for this option. + +* IO Backend (autodetected by default): + --with-epoll[=] / --without-epoll + --with-kqueue[=] / --without-kqueue + + ngIRCd can use three different IO "backends": the "old school" select() + API which should be supported by most UNIX-like operating systems, or the + more efficient and flexible epoll() (Linux 2.6) or kqueue() (BSD) APIs. + By default the IO backend is autodetected, but you can use "--without-xxx" + to disable a more enhanced API and force the daemon to use select(). + +* IDENT-Support: + --with-ident[=] + + Include support for IDENT ("AUTH") lookups. The "ident" library is + required for this option. + +* ZeroConf Support: + --with-zeroconf[=] + + Compile ngIRCd with support for ZeroConf multicast DNS service registration. + Either the Apple ZeroConf implementation (e. g. Mac OS X) or the Howl + library is required. Which one is available is autodetected. + +* TCP-Wrappers: + --with-tcp-wrappers[=] + + Include support for Wietse Venemas "TCP Wrappers" to limit client access + to the daemon, for example by using "/etc/hosts.{allow|deny}". + The "libwrap" is required for this option. + + +IV. Useful make-targets ~~~~~~~~~~~~~~~~~~~~~~~ The Makefile produced by the configure-script contains always these useful @@ -112,8 +195,8 @@ targets: next step: -> ./autogen.sh -III. Sample configuration file ngircd.conf -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +V. 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. @@ -133,7 +216,7 @@ The meaning of the variables in the configuration file is explained in the and in the "ngircd.conf" manual page. -IV. Command line options +VI. Command line options ~~~~~~~~~~~~~~~~~~~~~~~~ These parameters could be passed to the ngIRCd: @@ -158,4 +241,4 @@ number. In both cases the server exits after the output. -- -$Id: INSTALL,v 1.18 2004/02/22 22:12:44 alex Exp $ +$Id: INSTALL,v 1.24 2006/08/03 14:37:29 alex Exp $