Documentation

Supported platforms

ngIRCd is mainly being developed and tested on current versions of Linux, macOS, FreeBSD and OpenBSD.

In addition ngIRCd has been successfully compiled and run on the following platforms:

As the ngIRCd complies to common UNIX standards and uses GNU automake and GNU autoconf, chances are that it can be ported to or adapted for further UNIXoid systems.

Installation

ngIRCd is designed for UNIXoid systems and the installation on a modern UNIX-like system, which is supported by GNU automake and GNU autoconf, shouldn't cause any problems.

Typically it looks like this:

tar xzf ngircd-<version>.tar.gz
cd ngircd-<version>
./configure
make

Now, the executing server (normally ngircd) should be in src/ngircd.

make install

The executing server has now been installed in /usr/local/sbin.

The configuration file ngircd.conf is now expected in the server directory /usr/local/etc; an exemplary configuration file can be found in the directory doc.

Further comments on the installation and configuration can be found in the file INSTALL.

Documentation

Documentation is compiled in the source package, some in the main directory (such as INSTALL, README, NEWS und COPYING), and some in the sub directory doc (such as SSL.txt, FAQ.txt and the exemplary configurations sample-ngircd.conf).

The documents of the current version can be found online here:

Manual Pages

In addition, ngIRCd comes with two manual pages: ngircd(8) (for the daemon) and ngircd.conf(5) (for its configuration file). They have even more details and list all possible command line parameters and configuration options. You can read them with the man command (when they are installed locally on your system, e.g. man 8 ngircd and man 5 ngircd.conf) or online here: