X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=INSTALL;h=ce43e35ac2e44c48fe1d387dfd7ae8cefc4ce84a;hp=0c5be755214abac93f035b480ae93cc994ae7ef5;hb=6d11fb149707194e986b0d64af3d44f21e158fcc;hpb=0e2f5a4f3dc0704940cf58bf90d5dd9b8caf9940 diff --git a/INSTALL b/INSTALL index 0c5be755..ce43e35a 100644 --- a/INSTALL +++ b/INSTALL @@ -1,19 +1,22 @@ ngIRCd - Next Generation IRC Server + http://ngircd.barton.de/ - (c)2001-2004 by Alexander Barton, - alex@barton.de, http://www.barton.de/ - + (c)2001-2011 Alexander Barton and Contributors. ngIRCd is free software and published under the terms of the GNU General Public License. -- INSTALL -- - I. Upgrade Information ~~~~~~~~~~~~~~~~~~~~~~ +Differences to version 16 + +- Changes to the "MotdFile" specified in ngircd.conf now require a ngircd + configuration reload to take effect (HUP signal, REHASH command). + Differences to version 0.9.x - The option of the configure script to enable support for Zeroconf/Bonjour/ @@ -51,9 +54,9 @@ 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 -files (using a distribution archive or CVS) is as following: +files (using a distribution archive or GIT) is as following: - 1) ./autogen.sh [only necessary when using CVS] + 1) ./autogen.sh [only necessary when using GIT] 2) ./configure 3) make 4) make install @@ -77,7 +80,7 @@ doc/ directory: sample-ngircd.conf. 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-archives, but when using CVS. +tar.gz-archives, but when using GIT. This step is therefore only interesting for developers. @@ -127,7 +130,83 @@ 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-select[=] / --without-select + --with-poll[=] / --without-poll + --with-devpoll[=] / --without-devpoll + --with-epoll[=] / --without-epoll + --with-kqueue[=] / --without-kqueue + + ngIRCd can use different IO "backends": the "old school" select() and poll() + API which should be supported by most UNIX-like operating systems, or the + more efficient and flexible epoll() (Linux >=2.6), kqueue() (BSD) and + /dev/poll APIs. + By default the IO backend is autodetected, but you can use "--without-xxx" + to disable a more enhanced API. + When using the epoll() API, support for select() is compiled in as well by + default to enable the binary to run on older Linux kernels (<2.6), too. + +* 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. + +* PAM: + --with-pam[=] + + Enable support for PAM, the Pluggable Authentication Modules library. + See doc/PAM.txt for details. + +* SSL: + --with-openssl[=] + --with-gnutls[=] + + Enable support for SSL/TLS using OpenSSL or gnutls libraries. + See doc/SSL.txt for details. + +* IPv6: + --enable-ipv6 + + Adds support for version 6 of the Internet Protocol. + + +IV. Useful make-targets ~~~~~~~~~~~~~~~~~~~~~~~ The Makefile produced by the configure-script contains always these useful @@ -143,8 +222,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. @@ -164,7 +243,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: @@ -186,7 +265,3 @@ These parameters could be passed to the ngIRCd: Use "--help" to see a short help text describing all available parameters the server understands, with "--version" the ngIRCd shows its version number. In both cases the server exits after the output. - - --- -$Id: INSTALL,v 1.22 2005/07/08 16:23:00 alex Exp $