conf.c: code cleanup

[ngircd-alex.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 06be42f4d5b7170ffaea4250c110fcdb6aa9481e..8547efc16463fa7ac062f2754f173e5becc93511 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,9 +1,8 @@
 
                      ngIRCd - Next Generation IRC Server
 
                      ngIRCd - Next Generation IRC Server

+                           http://ngircd.barton.de/

 
 

-                        (c)2001-2007 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.
 
                ngIRCd is free software and published under the
                    terms of the GNU General Public License.
 


@@ -13,10 +12,15 @@
 I. Upgrade Information
 ~~~~~~~~~~~~~~~~~~~~~~
 
 I. Upgrade Information
 ~~~~~~~~~~~~~~~~~~~~~~
 

+Differences to version 17
+
+- Support for ZeroConf/Bonjour/Rendezvous service registration has been
+  removed. The configuration option "NoZeroconf" is no longer available.
+

 Differences to version 16
 
 Differences to version 16
 

-- Changes to the "MotdFile" specified in ngircd.conf now require a ngircd configuration
-  reload to take effect.
+- 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
 
 
 Differences to version 0.9.x
 


@@ -69,7 +73,8 @@ 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
 
 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.
+and all possible options -- and don't forget to run "ngircd --configtest"
+to validate your configuration file!

 
 If no previous version of the configuration file exists (the standard name
 is /usr/local/etc/ngircd.conf), a sample configuration file containing all
 
 If no previous version of the configuration file exists (the standard name
 is /usr/local/etc/ngircd.conf), a sample configuration file containing all


@@ -124,11 +129,12 @@ the local system. Normally, root privileges are necessary to complete this
 step. If there is already an older configuration file present, it won't be
 overwritten.
 
 step. If there is already an older configuration file present, it won't be
 overwritten.
 

-This files will be installed by default:
+These files and folders 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
 
 - /usr/local/sbin/ngircd: executable server
 - /usr/local/etc/ngircd.conf: sample configuration (if not already present)
 - /usr/local/share/doc/ngircd/: documentation

+- /usr/local/share/man/: manual pages

 
 
 III. Additional features
 
 
 III. Additional features


@@ -174,13 +180,6 @@ standard locations.
   Include support for IDENT ("AUTH") lookups. The "ident" library is
   required for this option.
 
   Include support for IDENT ("AUTH") lookups. The "ident" library is
   required for this option.
 

-* ZeroConf Support:
-  --with-zeroconf[=<path>] 
-
-  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[=<path>] 
 
 * TCP-Wrappers:
   --with-tcp-wrappers[=<path>] 
 


@@ -194,6 +193,18 @@ standard locations.
   Enable support for PAM, the Pluggable Authentication Modules library.
   See doc/PAM.txt for details.
 
   Enable support for PAM, the Pluggable Authentication Modules library.
   See doc/PAM.txt for details.
 

+* SSL:
+  --with-openssl[=<path>]
+  --with-gnutls[=<path>]
+
+  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
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 IV. Useful make-targets
 ~~~~~~~~~~~~~~~~~~~~~~~


@@ -217,19 +228,20 @@ 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.
 
 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].
+The file is separated in five blocks: [Global], [Features], [Operator],
+[Server], and [Channel].

 
 In the [Global] section, there is the main configuration like the server
 
 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.
+name and the ports, on which the server should be listening. Options in
+the [Features] section enable or disable functionality in the daemon.
+IRC operators of this server are defined in [Operator] blocks, remote
+servers are configured in [Server] sections, 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)
 
 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)

-and in the "ngircd.conf" manual page.
+and in the ngircd.conf(5) manual page.

 
 
 VI. Command line options
 
 
 VI. Command line options


@@ -254,3 +266,5 @@ 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.
 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.

+
+Please see the ngircd(8) manual page for complete details!