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:
- AIX (3.2.5 [IBM XL C Compiler])
- A/UX (3.x [Apple C Compiler, GNU C])
- FreeBSD (4.5 and newer on i386, x86_64 [GNU C])
- Haiku (on x86_64 [GNU C])
- HP-UX (9.10, 10.20, 11.11 on hppa, m68k [HP-UX cc, GNU C])
- IRIX (6.5 [SGI MIPSpro C 7.30])
- Linux (2.x and newer; on aarch64, armhf, hppa, i386, mipsel, powerpc, x86_64, ... [GNU C, Clang, PCC & TCC])
- macOS (Darwin) (10.0 and newer on i386, powerpc, x86_64 & aarch64 [GNU C 2.95.x, 3.x, 4.x & Apple Clang])
- NetBSD (1.5.2 and newer on alpha, i386, m68k, sparc, x86_64, ... [GNU C])
- OpenBSD (3.4 and newer on hppa, i386, powerpc, x86_64 [GNU C])
- Solaris (2.5.1 and newer on i386, sparc [GNU C])
- Windows: Cygwin or WSL (GNU C)
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:
- AUTHORS
- Bopm.txt
- Capabilities.txt
- Commands.txt
- Contributing.txt
- COPYING
- HowToRelease.txt
- Modes.txt
- PAM.txt
- Platforms.txt
- Protocol.txt
- RFC.txt
- Services.txt
- SSL.md
- README-AUX.txt
- README-BeOS.txt (deutsch)
- README-Interix.txt
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:
- Daemon: ngircd(8)
- Configuration file: ngircd.conf(5)