2 include('includes/common.php');
3 begin_page('en', 'Documentation');
12 ngIRCd is mainly being developed and tested on current versions of
13 Linux, macOS, FreeBSD and OpenBSD.
16 In addition ngIRCd has been successfully compiled and run on the
20 include('common/platforms.inc');
23 As the ngIRCd complies to common UNIX standards and uses GNU automake
24 and GNU autoconf, chances are that it can be ported to or adapted for
25 further UNIXoid systems.
31 ngIRCd is designed for UNIXoid systems and the installation on a
32 modern UNIX-like system, which is supported by GNU automake and GNU
33 autoconf, shouldn't cause any problems.
36 Typically it looks like this:
39 tar xzf ngircd-<version>.tar.gz<br>
40 cd ngircd-<version><br>
43 </code></p></blockquote>
45 Now, the executing server (normally <code>ngircd</code>) should be in
46 <code>src/ngircd</code>.
50 </code></p></blockquote>
52 The executing server has now been installed in
53 <code>/usr/local/sbin</code>.
56 The configuration file <code>ngircd.conf</code> is now expected in
57 the server directory <code>/usr/local/etc</code>; an exemplary
58 configuration file can be found in the directory <code>doc</code>.
61 Further comments on the installation and configuration can be found
62 in the file <a href="doc/INSTALL">INSTALL</a>.
68 Documentation is compiled in the source package, some in the main
69 directory (such as INSTALL, README, NEWS und COPYING), and some in
70 the sub directory <samp>doc</samp> (such as SSL.txt, FAQ.txt and the
71 exemplary configurations sample-ngircd.conf).
74 The documents of tha actual version can be found online here:
77 include('common/documentation-links.inc');